Removes one connection from a route. 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 connection exists, so an unknown one also returns 202. The route's other connections keep their indexes.Send synchronous=yes, in the body or the query string, to wait up to 2 seconds for the connection 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 ********************
or
Path Params
Body Params application/json
Examples
Responses
🟢200OK
application/json
Returned for synchronous=yes once the connection is gone.