NGINX · Schema

HTTP limit_reqs

Status data for all HTTP limit_req zones.

API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server
View JSON Schema on GitHub

JSON Schema

plus-http-api-nginx-http-limit-req-zones-map-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-schema/plus-http-api-nginx-http-limit-req-zones-map-schema.json",
  "title": "HTTP limit_reqs",
  "description": "Status data for all HTTP\n<a href=\"https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone\">limit_req zones</a>.\n",
  "type": "object",
  "additionalProperties": {
    "title": "HTTP Requests Rate Limiting",
    "type": "object",
    "properties": {
      "passed": {
        "type": "integer",
        "description": "The total number of requests that were neither limited nor accounted as limited.",
        "example": 0
      },
      "delayed": {
        "type": "integer",
        "description": "The total number of requests that were delayed.",
        "example": 0
      },
      "rejected": {
        "type": "integer",
        "description": "The total number of requests that were rejected.",
        "example": 0
      },
      "delayed_dry_run": {
        "type": "integer",
        "description": "The total number of requests accounted as delayed in the <a href=\"https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run\">dry run</a> mode.",
        "example": 0
      },
      "rejected_dry_run": {
        "type": "integer",
        "description": "The total number of requests accounted as rejected in the <a href=\"https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run\">dry run</a> mode.",
        "example": 0
      }
    },
    "example": {
      "passed": 15,
      "delayed": 4,
      "rejected": 0,
      "delayed_dry_run": 1,
      "rejected_dry_run": 2
    }
  }
}