Sign in
HTTP Limit Reqs
Method GET

Return status of an HTTP limit_req zone

Returns status of a particular HTTP limit_req zone.

get/http/limit_reqs/{httpLimitReqZoneName}

Query parameters

fieldsstring

Limits which fields of the limit_req zone will be output.

Response

Success

passedinteger

The total number of requests that were neither limited nor accounted as limited.

delayedinteger

The total number of requests that were delayed.

rejectedinteger

The total number of requests that were rejected.

delayed_dry_runinteger

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.

rejected_dry_runinteger

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 response

{
  "passed": 15,
  "delayed": 4,
  "rejected": 0,
  "delayed_dry_run": 1,
  "rejected_dry_run": 2
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.