Delete Passthrough Route
DELETE /environments/{env_id}/passthrough_routes/{passthrough_route_id}
DELETE /environments/{env_id}/passthrough_routes/{passthrough_route_id}Interactive request editor loads with JavaScript.
Authorization
BearerAdminToken Organization-scoped admin token. Read operations require a valid token, and write operations require a token with write permission.
In: header
Path Parameters
Environment ID that scopes the request.
uuidPassthrough route ID within the environment.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "$AISIX_CP/environments/$ENV_ID/passthrough_routes/$PASSTHROUGH_ROUTE_ID" \ -H "Authorization: Bearer $AISIX_TOKEN"OK
{
"deleted": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Request body or parameters failed validation.
{
"error": {
"code": "string",
"message": "string"
}
}Missing or invalid bearer.
{
"error": {
"code": "UNAUTHENTICATED",
"message": "no org context"
}
}Authenticated request is not permitted.
{
"error": {
"code": "CUSTOM_KEY_DISABLED",
"message": "custom API key values are disabled for this organization"
}
}Resource not found.
{
"error": {
"code": "NOT_FOUND",
"message": "provider key not found"
}
}Complete operation details and schema variants
DELETE /environments/{env_id}/passthrough_routes/{passthrough_route_id}
Delete Passthrough Route
Deletes the passthrough route. Traffic it served answers 404 (or
the tunnel-namespace 410) as soon as the gateway picks up the
change. Guardrail attachments scoped to the route are deleted
with it; API keys keep any now-dangling allowed_routes
patterns, which simply grant nothing until a route with a
matching name exists again.
Parameters
env_id(path, string, required): Environment ID that scopes the request.passthrough_route_id(path, string, required): Passthrough route ID within the environment.
Responses
-
200: OK -
deleted(boolean, required): Whether the passthrough route was deleted. -
id(string, required): Deleted passthrough route ID. -
400: Request body or parameters failed validation. -
error(object, required): Error details. -
error.code(string, required): Machine-readable identifier. Examples:UNAUTHENTICATED,INVALID_REQUEST,MASTER_KEY_UNSET,INTERNAL. -
error.message(string, required): Human-readable explanation; safe to surface to operators. -
401: Missing or invalid bearer. Response fields (application/json): identical toDELETE /environments/{env_id}/passthrough_routes/{passthrough_route_id}, response 400 above. -
403: Authenticated request is not permitted. Response fields (application/json): identical toDELETE /environments/{env_id}/passthrough_routes/{passthrough_route_id}, response 400 above. -
404: Resource not found. Response fields (application/json): identical toDELETE /environments/{env_id}/passthrough_routes/{passthrough_route_id}, response 400 above.
cURL
curl -X DELETE '$AISIX_CP/environments/{env_id}/passthrough_routes/{passthrough_route_id}' -H 'Authorization: Bearer $AISIX_TOKEN'