eventStreamsRouteStart

Starts a route

Description: Deploys and starts a route. The route transitions to STARTING status immediately, then to RUNNING once fully started. This operation is idempotent -- starting an already-running route returns success.

Input Parameters:

• environmentId: ID! — Environment where the route exists.
• name: ID! — Name of the route.

Error Codes:

• ROUTE_NOT_FOUND — No route with the given name exists in the environment.

Example:

mutation {
eventStreamsRouteStart(
environmentId: "e0900205-7996-4795-9092-b9d2a21b77e9"
name: "order-routing"
) {
name
status
}
}

eventStreamsRouteStart(
  environmentId: ID!
  name: ID!
): EventStreamsRoute!

Arguments

eventStreamsRouteStart.environmentId ● ID! non-null scalar miscellaneous

eventStreamsRouteStart.name ● ID! non-null scalar miscellaneous

Type

EventStreamsRoute object event-streams-admin

A message routing rule that filters and routes messages based on metadata properties