eventStreamsRouteDelete

Deletes a route

Description: Permanently removes a route from the specified environment.

Input Parameters:

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

Error Codes:

• ROUTE_NOT_FOUND — No route with the given name exists in the environment.
• ROUTE_DELETE_INVALID_STATE — Route is not in a deletable state. Only routes in STOPPED or ERROR state can be deleted.

Example:

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

eventStreamsRouteDelete(
  environmentId: ID!
  name: ID!
): Boolean!

Arguments

eventStreamsRouteDelete.environmentId ● ID! non-null scalar miscellaneous

eventStreamsRouteDelete.name ● ID! non-null scalar miscellaneous

Type

Boolean scalar miscellaneous

The Boolean scalar type represents true or false.