NGINX · Schema

Stream Connections Limiting

NginxStreamLimitConnZone schema from NGINX Plus REST API

API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server

Properties

Name Type Description
passed integer The total number of connections that were neither limited nor accounted as limited.
rejected integer The total number of connections that were rejected.
rejected_dry_run integer The total number of connections accounted as rejected in the dry run mode.
View JSON Schema on GitHub

JSON Schema

plus-http-api-nginx-stream-limit-conn-zone-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-stream-limit-conn-zone-schema.json",
  "title": "Stream Connections Limiting",
  "description": "NginxStreamLimitConnZone schema from NGINX Plus REST API",
  "type": "object",
  "properties": {
    "passed": {
      "type": "integer",
      "description": "The total number of connections that were neither limited nor accounted as limited.",
      "example": 0
    },
    "rejected": {
      "type": "integer",
      "description": "The total number of connections that were rejected.",
      "example": 0
    },
    "rejected_dry_run": {
      "type": "integer",
      "description": "The total number of connections accounted as rejected in the <a href=\"https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_dry_run\">dry run</a> mode.",
      "example": 0
    }
  },
  "example": {
    "passed": 15,
    "rejected": 0,
    "rejected_dry_run": 2
  }
}