eventStreamsRouteStop

Stops a route

Description: Stops a running route. The route transitions to STOPPING status immediately, then to STOPPED once fully stopped. This operation is idempotent -- stopping an already-stopped 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 {
eventStreamsRouteStop(
environmentId: "e0900205-7996-4795-9092-b9d2a21b77e9"
name: "order-routing"
) {
name
status
}
}

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

Arguments

eventStreamsRouteStop.environmentId ● ID! non-null scalar miscellaneous

eventStreamsRouteStop.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