API7 Docs

Get a Global Rule

GET /apisix/admin/global_rules/{id}

GET /apisix/admin/global_rules/{id}

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

Admin API key configured in config.yaml under deployment.admin.admin_key. You can also pass the key as a query parameter api_key or cookie x_api_key.

In: header

Path Parameters

id*string

Unique identifier of the resource. Can be a string (alphanumeric, -, _, .) or a positive integer.

Response Body

application/json

application/json

application/json

curl -X GET "http://127.0.0.1:9180/apisix/admin/global_rules/my-resource-1"

Successful response.

{
  "value": {
    "plugins": {
      "limit-count": {
        "rejected_code": 503,
        "time_window": 60,
        "key": "remote_addr",
        "key_type": "var",
        "count": 2,
        "allow_degradation": false,
        "show_limit_quota_header": true,
        "policy": "local"
      }
    },
    "update_time": 1684375502,
    "create_time": 1684375502,
    "id": "1"
  },
  "key": "/apisix/global_rules/1",
  "modifiedIndex": 137,
  "createdIndex": 137
}
Complete operation details and schema variants

GET /apisix/admin/global_rules/{id}

Get a Global Rule

Retrieve a single global rule by its ID.

Parameters

  • id (path, string, required): Unique identifier of the resource. Can be a string (alphanumeric, -, _, .) or a positive integer.

Responses

  • 200: Successful response.
  • key (string, required):
  • value (object, required): Global Rule configuration. Global plugins apply independently of locally bound plugins. For HTTP requests, execution is interleaved by phase: global rewrite, local rewrite, global access, then local access. Priorities order plugins within each phase and scope, and an early response skips handlers scheduled later.
  • value.id (object, optional): Unique identifier for the resource. Can be a string (1–64 characters, alphanumeric with -, _, .) or a positive integer.
  • anyOf variant 1: String ID
  • anyOf variant 2: Integer ID
  • value.create_time (integer, optional): Unix timestamp of creation. Read-only.
  • value.update_time (integer, optional): Unix timestamp of last update. Read-only.
  • value.plugins (object, required): Plugin configurations as a JSON object. Each key is a plugin name, and the value is that plugin's configuration object.

Example:

{
  "limit-count": {
    "count": 100,
    "time_window": 60
  },
  "key-auth": {}
}

See the Plugin Hub for available plugins and their schemas.

  • createdIndex (integer, optional):
  • modifiedIndex (integer, optional):
  • 401: Unauthorized — The API key is missing, invalid, or lacks permission.
  • error_msg (string, required): Authentication error message.
  • description (string, optional): Detailed reason for the authentication failure.
  • 404: Not Found — The specified resource does not exist.
  • error_msg (string, required): Error message indicating the resource was not found.

cURL

curl -X GET 'http://127.0.0.1:9180/apisix/admin/global_rules/{id}'

Create or Replace a Global Rule

Previous Page

Update a Global Rule (Partial)

Next Page