API7 Docs

Delete a global rule on a gateway group

DELETE /apisix/admin/global_rules/{global_rule_id}

DELETE /apisix/admin/global_rules/{global_rule_id}

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Path Parameters

global_rule_id*string

The unique identifier of the global rule.

Match^[a-zA-Z0-9-_.]+$
Length1 <= length <= 256

Query Parameters

gateway_group_id*string

Gateway group ID. Optional when using the gateway group admin key to authenticate.

Length1 <= length

Response Body

application/json

application/json

curl -X DELETE "$API_BASE_URL/apisix/admin/global_rules/bd58fce2-b6cc-4d2d-a53c-6ce11b19c101?gateway_group_id=86fb9981-d9d2-4555-9df8-91ae92129335"

Operation completed successfully with no response body.

""
Complete operation details and schema variants

DELETE /apisix/admin/global_rules/{global_rule_id}

Delete a global rule on a gateway group

Delete a global rule from the gateway group, removing its plugin behavior from all requests. Review related route or service plugin configuration if equivalent controls are still required. Required IAM Permission: Action gateway:DeleteGlobalPluginRule, Resource arn:api7:gateway:gatewaygroup/%s

Parameters

  • gateway_group_id (query, string, required): Gateway group ID. Optional when using the gateway group admin key to authenticate.
  • global_rule_id (path, string, required): The unique identifier of the global rule.

Responses

  • 200: Operation completed successfully with no response body.
  • 400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
  • value (object, optional): The specific resource.
  • error_msg (string, optional): The error message.

cURL

curl -X DELETE '$API_BASE_URL/apisix/admin/global_rules/{global_rule_id}'