Delete route

DELETE

/routes/{route-id}

Last modified:2026-09-26 18:05:14

OperationId:DeleteRoute

Removes the route that route-id names. Requires Super User scope. Other scopes, Reseller included, get 403. The API publishes the change on the service bus (SBUS) NmsRoute channel, and core applies it when the event arrives, so 202 means published, not applied.

The API does not check that the route exists, so an unknown route-id also returns 202. This request does not delete the route's connections. Remove them with DELETE /routes/{route-id}/routecon/{index}.

Send synchronous=yes, in the body or the query string, to wait up to 2 seconds for the route to be gone. You then get 200. If it is not gone in time, you get the usual 202.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned for synchronous=yes once the route is gone.

Bodyapplication/json

🟢202Accepted

🟠404

🟠400

🟠401

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://awqacore01.crexendocloud.com/ns-api/v2/routes/c2lwOjE4MDAqQCo' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "synchronous": "yes"
}'

Response Example

200 - Wait for the delete

The route is gone.

{
    "code": 200,
    "message": "Success"
}

Modified at 2026-09-26 18:05:14

Update route connection

Delete route connection