Delete Guardrail

DELETE /environments/{env_id}/guardrails/{guardrail_id}

Interactive request editor loads with JavaScript.

Authorization

BearerAdminToken

AuthorizationBearer <token>

Organization-scoped admin token. Read operations require a valid token, and write operations require a token with write permission.

In: header

env_id*string

Environment ID that scopes the request.

Formatuuid

guardrail_id*string

Guardrail ID within the environment.

Formatuuid

curl -X DELETE "$AISIX_CP/environments/$ENV_ID/guardrails/$GUARDRAIL_ID" \  -H "Authorization: Bearer $AISIX_TOKEN"

{
  "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 Guardrail

Delete a guardrail definition from the environment and remove it from the configuration distributed to connected gateways.

200: OK
deleted (boolean, required): Whether the guardrail was deleted.
id (string, required): Deleted guardrail 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 to DELETE /environments/{env_id}/guardrails/{guardrail_id}, response 400 above.
403: Authenticated request is not permitted. Response fields (application/json): identical to DELETE /environments/{env_id}/guardrails/{guardrail_id}, response 400 above.
404: Resource not found. Response fields (application/json): identical to DELETE /environments/{env_id}/guardrails/{guardrail_id}, response 400 above.

curl -X DELETE '$AISIX_CP/environments/{env_id}/guardrails/{guardrail_id}' -H 'Authorization: Bearer $AISIX_TOKEN'