NGINX · Schema
HTTP Location Zones
Status data for all HTTP location zones.
API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server
JSON Schema
{
"$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-location-zones-map-schema.json",
"title": "HTTP Location Zones",
"description": "Status data for all HTTP\n<a href=\"https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone\">location zones</a>.\n",
"type": "object",
"additionalProperties": {
"title": "HTTP Location Zone",
"type": "object",
"properties": {
"requests": {
"type": "integer",
"description": "The total number of client requests received from clients.",
"example": 31070465
},
"responses": {
"description": "The total number of responses sent to clients, the number of responses with status codes \u201c<code>1xx</code>\u201d, \u201c<code>2xx</code>\u201d, \u201c<code>3xx</code>\u201d, \u201c<code>4xx</code>\u201d, and \u201c<code>5xx</code>\u201d, and the number of responses per each status code.",
"type": "object",
"readOnly": true,
"properties": {
"1xx": {
"type": "integer",
"description": "The number of responses with \u201c<code>1xx</code>\u201d status codes.",
"readOnly": true,
"example": 0
},
"2xx": {
"type": "integer",
"description": "The number of responses with \u201c<code>2xx</code>\u201d status codes.",
"readOnly": true,
"example": 0
},
"3xx": {
"type": "integer",
"description": "The number of responses with \u201c<code>3xx</code>\u201d status codes.",
"readOnly": true,
"example": 0
},
"4xx": {
"type": "integer",
"description": "The number of responses with \u201c<code>4xx</code>\u201d status codes.",
"readOnly": true,
"example": 0
},
"5xx": {
"type": "integer",
"description": "The number of responses with \u201c<code>5xx</code>\u201d status codes.",
"readOnly": true,
"example": 0
},
"codes": {
"type": "object",
"description": "The number of responses per each status code.",
"readOnly": true,
"properties": {
"codeNumber": {
"type": "integer",
"description": "The number of responses with this particular status code.",
"readOnly": true,
"example": 0
}
},
"example": {}
},
"total": {
"type": "integer",
"description": "The total number of responses sent to clients.",
"readOnly": true,
"example": 98765
}
},
"example": 1234567
},
"discarded": {
"type": "integer",
"description": "The total number of requests completed without sending a response.",
"example": 0
},
"received": {
"type": "integer",
"description": "The total number of bytes received from clients.",
"example": 180157219
},
"sent": {
"type": "integer",
"description": "The total number of bytes sent to clients.",
"example": 20183175459
}
},
"example": {
"requests": 706690,
"responses": {
"1xx": 0,
"2xx": 699482,
"3xx": 4522,
"4xx": 907,
"5xx": 266,
"codes": {
"200": 112674,
"301": 4522,
"404": 2504,
"503": 266
},
"total": 705177
},
"discarded": 1513,
"received": 172711587,
"sent": 19415530115
}
},
"example": {
"site1": {
"requests": 736395,
"responses": {
"1xx": 0,
"2xx": 727290,
"3xx": 4614,
"4xx": 934,
"5xx": 1535,
"codes": {
"200": 727290,
"301": 4614,
"404": 934,
"503": 1535
},
"total": 734373
},
"discarded": 2020,
"received": 180157219,
"sent": 20183175459
},
"site2": {
"requests": 185307,
"responses": {
"1xx": 0,
"2xx": 112674,
"3xx": 45383,
"4xx": 2504,
"5xx": 4419,
"codes": {
"200": 112674,
"301": 45383,
"404": 2504,
"503": 4419
},
"total": 164980
},
"discarded": 20326,
"received": 51575327,
"sent": 2983241510
}
}
}