nginx-site: yaml/nginx_api.yaml annotate

annotate yaml/nginx_api.yaml @ 2494:78d4e25adf49

Documented "BodyReadError" in the API.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Wed, 29 Jan 2020 19:21:26 +0000
parents	407147d8020f
children	20dbb29cbe05

rev	line source
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 swagger: '2.0'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2 info:
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3 version: '6.0'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4 title: NGINX Plus REST API
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	5 description: NGINX Plus REST
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	6 [API](https://nginx.org/en/docs/http/ngx_http_api_module.html)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7 provides access to NGINX Plus status information,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8 on-the-fly configuration of upstream servers and
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	9 key-value pairs management for
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	10 [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	11 [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html).
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	12 basePath: /api/6
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14 - name: General Info
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 - name: Processes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16 - name: Connections
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	17 - name: Slabs
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	18 - name: Resolvers
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 - name: SSL
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20 - name: HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 - name: HTTP Requests
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	22 - name: HTTP Server Zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	23 - name: HTTP Location Zones
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 - name: HTTP Caches
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	25 - name: HTTP Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	26 - name: HTTP Limit Reqs
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	27 - name: HTTP Keyvals
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 - name: HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 - name: Stream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 - name: Stream Server Zones
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	31 - name: Stream Limit Conns
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	32 - name: Stream Keyvals
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 - name: Stream Upstreams
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	34 - name: Stream Zone Sync
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 - name: Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 - name: Method POST
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 - name: Method PATCH
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 - name: Method DELETE
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 schemes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 - http
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 paths:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 /:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 - General Info
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	47 summary: Return list of root endpoints
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	48 description: Returns a list of root endpoints.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 operationId: getAPIEndpoints
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 $ref: '#/definitions/ArrayOfStrings'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 /nginx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60 - General Info
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	62 summary: Return status of nginx running instance
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	63 description: Returns nginx version, build name, address,
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 number of configuration reloads, IDs of master and worker processes.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 operationId: getNginx
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	72 description: Limits which fields of nginx running instance will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 $ref: '#/definitions/NginxObject'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 /processes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 - Processes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	83 summary: Return nginx processes status
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	84 description: Returns the number of abnormally terminated
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 and respawned child processes.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 operationId: getProcesses
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 $ref: '#/definitions/NginxProcesses'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 - Processes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	97 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	98 summary: Reset nginx processes statistics
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	99 description: Resets counters of abnormally terminated and respawned
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100 child processes.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 operationId: deleteProcesses
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 /connections:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 - Connections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	110 summary: Return client connections statistics
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	111 description: Returns statistics of client connections.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 operationId: getConnections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 $ref: '#/definitions/NginxConnections'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	124 description: Limits which fields of the connections statistics will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	125 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	127 - Connections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	129 summary: Reset client connections statistics
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	130 description: Resets statistics of accepted and dropped
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131 client connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	132 operationId: deleteConnections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 /slabs/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139 - Slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	141 summary: Return status of all slabs
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	142 description: Returns status of slabs
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143 for each shared memory zone with slab allocator.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 operationId: getSlabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	151 description: Limits which fields of slab zones will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 If the “<literal>fields</literal>” value is empty,
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	153 then only zone names will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158 $ref: '#/definitions/NginxSlabZoneMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 '/slabs/{slabZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161 - name: slabZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	163 description: The name of the shared memory zone with slab allocator.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	168 - Slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	170 summary: Return status of a slab
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	171 description: Returns status of slabs for a particular shared memory zone
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 with slab allocator.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 operationId: getSlabZone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	180 description: Limits which fields of the slab zone will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 $ref: '#/definitions/NginxSlabZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	187 description: Slab not found (SlabNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	188 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	189 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	192 - Slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	193 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	194 summary: Reset slab statistics
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	195 description: Resets the “<literal>reqs</literal>” and “<literal>fails</literal>”
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	196 metrics for each memory slot.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197 operationId: deleteSlabZoneStats
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	198 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	200 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	202 description: Slab not found (SlabNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	205 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	206 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	207 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	208 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209 /http/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212 - HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	214 summary: Return list of HTTP-related endpoints
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	215 description: Returns a list of first level HTTP endpoints.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216 operationId: getHttp
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	221 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	223 $ref: '#/definitions/ArrayOfStrings'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224 /http/requests:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 - HTTP Requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	228 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	229 summary: Return HTTP requests statistics
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	230 description: Returns status of client HTTP requests.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	231 operationId: getHttpRequests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	232 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	233 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	238 description: Limits which fields of client HTTP requests statistics
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239 will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	240 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 $ref: '#/definitions/NginxHTTPRequests'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 - HTTP Requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	249 summary: Reset HTTP requests statistics
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	250 description: Resets the number of total client HTTP requests.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 operationId: deleteHttpRequests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	252 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254 description: Success
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	255 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	256 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	257 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	258 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259 /http/server_zones/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262 - HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	264 summary: Return status of all HTTP server zones
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	265 description: Returns status information for each HTTP
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	266 [server zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone).
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 operationId: getHttpServerZones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	274 description: Limits which fields of server zones will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 If the “<literal>fields</literal>” value is empty,
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	276 then only server zone names will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 $ref: '#/definitions/NginxHTTPServerZonesMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 '/http/server_zones/{httpServerZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 - name: httpServerZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 in: path
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286 description: The name of an HTTP server zone.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291 - HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	293 summary: Return status of an HTTP server zone
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	294 description: Returns status of a particular HTTP server zone.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 operationId: getHttpServerZone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	302 description: Limits which fields of the server zone will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 $ref: '#/definitions/NginxHTTPServerZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 description: Server zone not found (ServerZoneNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314 - HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	316 summary: Reset statistics for an HTTP server zone
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	317 description: Resets statistics of accepted and discarded requests, responses,
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 received and sent bytes in a particular HTTP server zone.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319 operationId: deleteHttpServerZoneStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324 description: Server zone not found (ServerZoneNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	325 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	326 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	327 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	328 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	329 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	330 $ref: '#/definitions/NginxError'
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	331 /http/location_zones/:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	332 get:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	333 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	334 - HTTP Location Zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	335 - Method GET
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	336 summary: Return status of all HTTP location zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	337 description: Returns status information for each HTTP
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	338 [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	339 operationId: getHttpLocationZones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	340 produces:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	341 - application/json
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	342 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	343 - in: query
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	344 name: fields
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	345 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	346 description: Limits which fields of location zones will be output.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	347 If the “<literal>fields</literal>” value is empty,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	348 then only zone names will be output.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	349 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	350 '200':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	351 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	352 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	353 $ref: '#/definitions/NginxHTTPLocationZonesMap'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	354 '/http/location_zones/{httpLocationZoneName}':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	355 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	356 - name: httpLocationZoneName
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	357 in: path
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	358 description: The name of an HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	359 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	360 required: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	361 get:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	362 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	363 - HTTP Location Zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	364 - Method GET
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	365 summary: Return status of an HTTP location zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	366 description: Returns status of a particular
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	367 HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	368 operationId: getHttpLocationZone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	369 produces:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	370 - application/json
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	371 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	372 - name: fields
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	373 in: query
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	374 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	375 description: Limits which fields of the location zone will be output.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	376 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	377 '200':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	378 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	379 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	380 $ref: '#/definitions/NginxHTTPLocationZone'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	381 '404':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	382 description: Location zone not found (LocationZoneNotFound)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	383 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	384 $ref: '#/definitions/NginxError'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	385 delete:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	386 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	387 - HTTP Location Zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	388 - Method DELETE
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	389 summary: Reset statistics for a location zone.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	390 description: Resets statistics of accepted and discarded requests, responses,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	391 received and sent bytes in a particular location zone.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	392 operationId: deleteHttpLocationZoneStat
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	393 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	394 '204':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	395 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	396 '404':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	397 description: Location zone not found (LocationZoneNotFound)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	398 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	399 $ref: '#/definitions/NginxError'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	400 '405':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	401 description: Method disabled (MethodDisabled)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	402 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	403 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	404 /http/caches/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	407 - HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	408 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	409 summary: Return status of all caches
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	410 description: Returns status of each cache configured by
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411 [proxy_cache_path](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412 and other “<literal>*_cache_path</literal>” directives.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413 operationId: getHttpCaches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	415 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	416 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	417 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	418 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	420 description: Limits which fields of cache zones will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	421 If the “<literal>fields</literal>” value is empty,
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	422 then only names of cache zones will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	427 $ref: '#/definitions/NginxHTTPCachesMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	428 '/http/caches/{httpCacheZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	429 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430 - name: httpCacheZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	432 description: The name of the cache zone.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	433 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	434 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	435 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	436 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	437 - HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	438 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	439 summary: Return status of a cache
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	440 description: Returns status of a particular cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441 operationId: getHttpCacheZone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	442 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	443 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	444 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	446 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	447 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	448 description: Limits which fields of the cache zone will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	449 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	453 $ref: '#/definitions/NginxHTTPCache'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	454 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	455 description: Cache not found (CacheNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	456 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 - HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	461 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	462 summary: Reset cache statistics
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	463 description: Resets statistics of cache hits/misses in a particular cache zone.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464 operationId: deleteHttpCacheZoneStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	465 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	467 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	468 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	469 description: Cache not found (CacheNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	470 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	471 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	472 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	473 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	474 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	475 $ref: '#/definitions/NginxError'
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	476 /http/limit_conns/:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	477 get:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	478 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	479 - HTTP Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	480 - Method GET
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	481 summary: Return status of all HTTP limit_conn zones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	482 description: Returns status information for each HTTP
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	483 [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	484 operationId: getHttpLimitConnZones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	485 produces:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	486 - application/json
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	487 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	488 - in: query
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	489 name: fields
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	490 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	491 description: Limits which fields of limit_conn zones will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	492 If the “<literal>fields</literal>” value is empty,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	493 then only zone names will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	494 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	495 '200':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	496 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	497 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	498 $ref: '#/definitions/NginxHTTPLimitConnZonesMap'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	499 '/http/limit_conns/{httpLimitConnZoneName}':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	500 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	501 - name: httpLimitConnZoneName
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	502 in: path
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	503 description: The name of a
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	504 [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	505 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	506 required: true
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	507 get:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	508 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	509 - HTTP Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	510 - Method GET
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	511 summary: Return status of an HTTP limit_conn zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	512 description: Returns status of a particular HTTP
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	513 [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	514 operationId: getHttpLimitConnZone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	515 produces:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	516 - application/json
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	517 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	518 - name: fields
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	519 in: query
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	520 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	521 description: Limits which fields of the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	522 [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	523 will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	524 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	525 '200':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	526 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	527 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	528 $ref: '#/definitions/NginxHTTPLimitConnZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	529 '404':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	530 description: limit_conn not found (LimitConnNotFound)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	531 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	532 $ref: '#/definitions/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	533 delete:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	534 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	535 - HTTP Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	536 - Method DELETE
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	537 summary: Reset statistics for an HTTP limit_conn zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	538 description: Resets the connection limiting statistics.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	539 operationId: deleteHttpLimitConnZoneStat
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	540 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	541 '204':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	542 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	543 '404':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	544 description: limit_conn not found (LimitConnNotFound)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	545 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	546 $ref: '#/definitions/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	547 '405':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	548 description: Method disabled (MethodDisabled)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	549 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	550 $ref: '#/definitions/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	551 /http/limit_reqs/:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	552 get:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	553 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	554 - HTTP Limit Reqs
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	555 - Method GET
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	556 summary: Return status of all HTTP limit_req zones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	557 description: Returns status information for each HTTP
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	558 [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	559 operationId: getHttpLimitReqZones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	560 produces:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	561 - application/json
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	562 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	563 - in: query
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	564 name: fields
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	565 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	566 description: Limits which fields of limit_req zones will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	567 If the “<literal>fields</literal>” value is empty,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	568 then only zone names will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	569 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	570 '200':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	571 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	572 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	573 $ref: '#/definitions/NginxHTTPLimitReqZonesMap'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	574 '/http/limit_reqs/{httpLimitReqZoneName}':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	575 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	576 - name: httpLimitReqZoneName
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	577 in: path
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	578 description: The name of a
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	579 [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	580 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	581 required: true
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	582 get:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	583 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	584 - HTTP Limit Reqs
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	585 - Method GET
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	586 summary: Return status of an HTTP limit_req zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	587 description: Returns status of a particular HTTP
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	588 [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	589 operationId: getHttpLimitReqZone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	590 produces:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	591 - application/json
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	592 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	593 - name: fields
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	594 in: query
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	595 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	596 description: Limits which fields of the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	597 [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	598 will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	599 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	600 '200':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	601 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	602 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	603 $ref: '#/definitions/NginxHTTPLimitReqZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	604 '404':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	605 description: limit_req not found (LimitReqNotFound)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	606 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	607 $ref: '#/definitions/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	608 delete:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	609 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	610 - HTTP Limit Reqs
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	611 - Method DELETE
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	612 summary: Reset statistics for an HTTP limit_req zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	613 description: Resets the requests limiting statistics.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	614 operationId: deleteHttpLimitReqZoneStat
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	615 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	616 '204':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	617 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	618 '404':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	619 description: limit_req not found (LimitReqNotFound)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	620 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	621 $ref: '#/definitions/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	622 '405':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	623 description: Method disabled (MethodDisabled)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	624 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	625 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	626 /http/upstreams/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	627 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	628 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	629 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	630 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	631 summary: Return status of all HTTP upstream server groups
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	632 description: Returns status of each HTTP upstream server group
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	633 and its servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	634 operationId: getHttpUpstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	635 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	636 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	637 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	638 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	639 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	640 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	641 description: Limits which fields of upstream server groups will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	642 If the “<literal>fields</literal>” value is empty,
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	643 only names of upstreams will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	644 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	645 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	646 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	647 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	648 $ref: '#/definitions/NginxHTTPUpstreamMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	649 '/http/upstreams/{httpUpstreamName}/':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	650 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	651 - name: httpUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	652 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	653 description: The name of an HTTP upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	654 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	655 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	656 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	657 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	658 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	659 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	660 summary: Return status of an HTTP upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	661 description: Returns status of a particular HTTP upstream server group
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	662 and its servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	663 operationId: getHttpUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	664 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	665 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	666 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	667 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	668 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	669 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	670 description: Limits which fields of the upstream server group will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	671 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	672 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	673 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	674 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	675 $ref: '#/definitions/NginxHTTPUpstream'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	676 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	677 description: Upstream is static (UpstreamStatic)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	678 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	679 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	680 '404':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	681 description: Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	682 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	683 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	684 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	685 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	686 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	687 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	688 summary: Reset statistics of an HTTP upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	689 description: Resets the statistics for each upstream server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	690 in an upstream server group and queue statistics.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	691 operationId: deleteHttpUpstreamStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	692 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	693 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	694 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	695 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	696 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	697 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	698 description: Upstream is static (UpstreamStatic)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	699 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	700 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	701 '404':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	702 description: Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	703 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	704 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	705 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	706 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	707 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	708 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	709 '/http/upstreams/{httpUpstreamName}/servers/':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	710 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	711 - name: httpUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	712 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	713 description: The name of an upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	714 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	715 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	716 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	717 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	718 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	719 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	720 summary: Return configuration of all servers in an HTTP upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	721 description: Returns configuration of each server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	722 in a particular HTTP upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	723 operationId: getHttpUpstreamServers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	724 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	725 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	726 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	727 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	728 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	729 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	730 $ref: '#/definitions/NginxHTTPUpstreamConfServerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	731 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	732 description: Upstream is static (UpstreamStatic)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	733 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	734 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	735 '404':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	736 description: Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	737 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	738 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	739 post:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	740 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	741 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	742 - Method POST
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	743 summary: Add a server to an HTTP upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	744 description: Adds a new server to an HTTP upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	745 Server parameters are specified in the JSON format.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	746 operationId: postHttpUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	747 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	748 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	749 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	750 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	751 name: postHttpUpstreamServer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	752 description: Address of a new server and other optional parameters
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	753 in the JSON format.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	754 The “ID”, “backup”, and “service” parameters
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	755 cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	756 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	757 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	758 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	759 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	760 '201':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	761 description: Created
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	762 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	763 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	764 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	765 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	766 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	767 invalid “parameter” value (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	768 missing “server” argument (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	769 unknown parameter “name” (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	770 nested object or list (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	771 “error” while parsing (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	772 service upstream “host” may not have port (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	773 service upstream “host” requires domain name (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	774 invalid “weight” (UpstreamBadWeight),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	775 invalid “max_conns” (UpstreamBadMaxConns),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	776 invalid “max_fails” (UpstreamBadMaxFails),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	777 invalid “fail_timeout” (UpstreamBadFailTimeout),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	778 invalid “slow_start” (UpstreamBadSlowStart),
2494 78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	779 reading request body failed BodyReadError),
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	780 route is too long (UpstreamBadRoute),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	781 “service” is empty (UpstreamBadService),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	782 no resolver defined to resolve (UpstreamConfNoResolver),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	783 upstream “name” has no backup (UpstreamNoBackup),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	784 upstream “name” memory exhausted (UpstreamOutOfMemory)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	785 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	786 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	787 '404':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	788 description: Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	790 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	791 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	792 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	793 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	794 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	795 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	796 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	797 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	798 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	799 '/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	800 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	801 - name: httpUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	802 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	803 description: The name of the upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	804 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	805 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	806 - name: httpUpstreamServerId
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	807 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	808 description: The ID of the server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	809 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	810 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	811 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	812 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	813 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	814 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	815 summary: Return configuration of a server in an HTTP upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	816 description: Returns configuration of a particular server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	817 in the HTTP upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	818 operationId: getHttpUpstreamPeer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	819 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	820 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	821 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	822 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	823 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	824 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	825 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	826 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	827 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	828 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	829 invalid server ID (UpstreamBadServerId)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	830 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	831 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	832 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	833 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	834 Upstream not found (UpstreamNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	835 server with ID “id” does not exist (UpstreamServerNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	836 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	837 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	838 patch:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	839 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	840 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	841 - Method PATCH
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	842 summary: Modify a server in an HTTP upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	843 description: Modifies settings of a particular server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	844 in an HTTP upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	845 Server parameters are specified in the JSON format.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	846 operationId: patchHttpUpstreamPeer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	847 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	848 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	849 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	850 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	851 name: patchHttpUpstreamServer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	852 description: Server parameters, specified in the JSON format.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	853 The “ID”, “backup”, and “service” parameters
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	854 cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	855 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	856 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	857 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	858 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	859 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	860 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	861 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	862 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	863 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	864 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	865 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	866 invalid “parameter” value (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	867 unknown parameter “name” (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	868 nested object or list (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	869 “error” while parsing (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	870 invalid “server” argument (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	871 invalid server ID (UpstreamBadServerId),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	872 invalid “weight” (UpstreamBadWeight),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	873 invalid “max_conns” (UpstreamBadMaxConns),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	874 invalid “max_fails” (UpstreamBadMaxFails),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	875 invalid “fail_timeout” (UpstreamBadFailTimeout),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	876 invalid “slow_start” (UpstreamBadSlowStart),
2494 78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	877 reading request body failed BodyReadError),
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	878 route is too long (UpstreamBadRoute),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	879 “service” is empty (UpstreamBadService),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	880 server “ID” address is immutable (UpstreamServerImmutable),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	881 server “ID” weight is immutable (UpstreamServerWeightImmutable),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	882 upstream “name” memory exhausted (UpstreamOutOfMemory)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	883 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	884 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	885 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	886 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	887 Upstream not found (UpstreamNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	888 server with ID “id” does not exist (UpstreamServerNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	889 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	890 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	891 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	892 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	893 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	894 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	895 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	896 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	897 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	898 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	899 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	900 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	901 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	902 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	903 summary: Remove a server from an HTTP upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	904 description: Removes a server from an HTTP upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	905 operationId: deleteHttpUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	906 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	907 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	908 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	909 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	910 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	911 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	912 $ref: '#/definitions/NginxHTTPUpstreamConfServerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	913 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	914 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	915 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	916 invalid server ID (UpstreamBadServerId),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	917 server “id” not removable (UpstreamServerImmutable)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	918 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	919 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	920 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	921 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	922 Upstream not found (UpstreamNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	923 server with ID “id” does not exist (UpstreamServerNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	924 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	925 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	926 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	927 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	928 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	929 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	930 /http/keyvals/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	931 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	932 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	933 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	934 - Method GET
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	935 summary: Return key-value pairs from all HTTP keyval zones
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	936 description: Returns key-value pairs for each HTTP keyval shared memory
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	937 [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	938 operationId: getHttpKeyvalZones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	939 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	940 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	941 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	942 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	943 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	944 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	945 description: If the “<literal>fields</literal>” value is empty,
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	946 then only HTTP keyval zone names will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	947 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	948 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	949 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	950 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	951 $ref: '#/definitions/NginxHTTPKeyvalZonesMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	952 '/http/keyvals/{httpKeyvalZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	953 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	954 - name: httpKeyvalZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	955 in: path
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	956 description: The name of an HTTP keyval shared memory zone.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	957 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	958 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	959 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	960 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	961 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	962 - Method GET
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	963 summary: Return key-value pairs from an HTTP keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	964 description: Returns key-value pairs stored in a particular HTTP keyval shared memory
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	965 [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	966 operationId: getHttpKeyvalZoneKeysValues
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	967 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	968 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	969 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	970 - name: key
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	971 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	972 type: string
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	973 description: Get a particular key-value pair from the HTTP keyval zone.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	974 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	975 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	976 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	977 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	978 $ref: '#/definitions/NginxHTTPKeyvalZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	980 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	981 Keyval not found (KeyvalNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	982 keyval key not found (KeyvalKeyNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	983 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	985 post:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	986 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	987 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	988 - Method POST
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	989 summary: Add a key-value pair to the HTTP keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	990 description: Adds a new key-value pair to the HTTP keyval shared memory
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	991 [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	992 Several key-value pairs can be entered
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	993 if the HTTP keyval shared memory zone is empty.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	994 operationId: postHttpKeyvalZoneData
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	995 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	996 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	997 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	998 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	999 name: Key-value
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1000 description: A key-value pair is specified in the JSON format.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1001 Several key-value pairs can be entered
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1002 if the HTTP keyval shared memory zone is empty.
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1003 Expiration time in milliseconds can be specified for a key-value pair
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1004 with the expire parameter
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1005 which overrides the [timeout](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1006 parameter of the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1007 <a href="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</a>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1008 directive.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1009 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1010 schema:
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1011 $ref: '#/definitions/NginxHTTPKeyvalZonePostPatch'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1012 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1013 '201':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1014 description: Created
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1015 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1016 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1017 Invalid JSON (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1018 invalid key format (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1019 key required (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1020 keyval timeout is not enabled (KeyvalFormatError),
2494 78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1021 only one key can be added (KeyvalFormatError),
78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1022 reading request body failed BodyReadError)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1023 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1024 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1025 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1026 description: Keyval not found (KeyvalNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1027 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1028 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1029 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1030 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1031 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1032 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1033 '409':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1034 description: Key already exists (KeyvalKeyExists)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1035 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1036 $ref: '#/definitions/NginxError'
2493 407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1037 '413':
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1038 description: Request Entity Too Large
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1039 schema:
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1040 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1041 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1042 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1043 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1044 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1045 patch:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1046 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1047 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1048 - Method PATCH
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1049 summary: Modify a key-value or delete a key
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1050 description: Changes the value of the selected key in the key-value pair,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1051 deletes a key by setting the key value to <literal>null</literal>,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1052 changes expiration time of a key-value pair.
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1053 If
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1054 <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1055 of keyval zones in a cluster is enabled,
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1056 deletes a key only on a target cluster node.
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1057 Expiration time in milliseconds can be specified for a key-value pair
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1058 with the expire parameter
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1059 which overrides the [timeout](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1060 parameter of the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1061 <a href="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</a>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1062 directive.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1063 operationId: patchHttpKeyvalZoneKeyValue
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1064 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1065 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1066 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1067 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1068 name: httpKeyvalZoneKeyValue
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1069 description: A new value for the key is specified in the JSON format.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1070 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1071 schema:
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1072 $ref: '#/definitions/NginxHTTPKeyvalZonePostPatch'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1073 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1074 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1075 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1076 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1077 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1078 Invalid JSON (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1079 key required (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1080 keyval timeout is not enabled (KeyvalFormatError),
2494 78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1081 only one key can be updated (KeyvalFormatError),
78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1082 reading request body failed BodyReadError)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1083 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1084 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1085 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1086 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1087 Keyval not found (KeyvalNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1088 keyval key not found (KeyvalKeyNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1089 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1090 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1091 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1092 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1093 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1094 $ref: '#/definitions/NginxError'
2493 407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1095 '413':
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1096 description: Request Entity Too Large
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1097 schema:
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1098 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1099 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1100 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1101 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1102 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1103 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1104 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1105 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1106 - Method DELETE
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1107 summary: Empty the HTTP keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1108 description: Deletes all key-value pairs from the HTTP keyval shared memory
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1109 [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1110 If
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1111 <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1112 of keyval zones in a cluster is enabled,
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1113 empties the keyval zone only on a target cluster node.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1114 operationId: deleteHttpKeyvalZoneData
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1115 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1117 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1118 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1119 description: Keyval not found (KeyvalNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1120 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1121 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1122 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1123 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1124 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1125 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1126 /stream/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1127 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1128 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1129 - Stream
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1130 summary: Return list of stream-related endpoints
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1131 description: Returns a list of first level stream endpoints.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1132 operationId: getStream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1133 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1134 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1135 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1136 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1137 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1138 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1139 $ref: '#/definitions/ArrayOfStrings'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1140 /stream/server_zones/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1141 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1142 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1143 - Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1144 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1145 summary: Return status of all stream server zones
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1146 description: Returns status information for each stream
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1147 [server zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone).
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1148 operationId: getStreamServerZones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1149 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1150 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1151 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1152 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1153 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1154 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1155 description: Limits which fields of server zones will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1156 If the “<literal>fields</literal>” value is empty,
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1157 then only server zone names will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1158 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1159 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1160 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1161 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1162 $ref: '#/definitions/NginxStreamServerZonesMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1163 '/stream/server_zones/{streamServerZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1164 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1165 - name: streamServerZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1166 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1167 description: The name of a stream server zone.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1168 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1169 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1170 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1171 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1172 - Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1173 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1174 summary: Return status of a stream server zone
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1175 description: Returns status of a particular stream server zone.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1176 operationId: getStreamServerZone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1177 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1178 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1179 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1180 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1181 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1182 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1183 description: Limits which fields of the server zone will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1184 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1185 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1186 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1187 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1188 $ref: '#/definitions/NginxStreamServerZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1189 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1190 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1191 Server zone not found (ServerZoneNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1192 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1193 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1194 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1195 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1196 - Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1197 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1198 summary: Reset statistics for a stream server zone
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1199 description: Resets statistics of accepted and discarded connections, sessions,
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1200 received and sent bytes in a particular stream server zone.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1201 operationId: deleteStreamServerZoneStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1202 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1203 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1204 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1205 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1206 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1207 Server zone not found (ServerZoneNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1208 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1209 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1210 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1211 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1212 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1213 $ref: '#/definitions/NginxError'
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1214 /stream/limit_conns/:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1215 get:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1216 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1217 - Stream Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1218 - Method GET
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1219 summary: Return status of all stream limit_conn zones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1220 description: Returns status information for each stream
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1221 [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1222 operationId: getStreamLimitConnZones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1223 produces:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1224 - application/json
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1225 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1226 - in: query
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1227 name: fields
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1228 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1229 description: Limits which fields of limit_conn zones will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1230 If the “<literal>fields</literal>” value is empty,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1231 then only zone names will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1232 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1233 '200':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1234 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1235 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1236 $ref: '#/definitions/NginxStreamLimitConnZonesMap'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1237 '/stream/limit_conns/{streamLimitConnZoneName}':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1238 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1239 - name: streamLimitConnZoneName
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1240 in: path
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1241 description: The name of a
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1242 [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1243 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1244 required: true
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1245 get:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1246 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1247 - Stream Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1248 - Method GET
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1249 summary: Return status of an stream limit_conn zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1250 description: Returns status of a particular stream
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1251 [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1252 operationId: getStreamLimitConnZone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1253 produces:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1254 - application/json
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1255 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1256 - name: fields
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1257 in: query
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1258 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1259 description: Limits which fields of the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1260 [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1261 will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1262 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1263 '200':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1264 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1265 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1266 $ref: '#/definitions/NginxStreamLimitConnZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1267 '404':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1268 description: limit_conn not found (LimitConnNotFound)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1269 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1270 $ref: '#/definitions/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1271 delete:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1272 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1273 - Stream Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1274 - Method DELETE
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1275 summary: Reset statistics for a stream limit_conn zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1276 description: Resets the connection limiting statistics.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1277 operationId: deleteStreamLimitConnZoneStat
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1278 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1279 '204':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1280 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1281 '404':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1282 description: limit_conn not found (LimitConnNotFound)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1283 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1284 $ref: '#/definitions/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1285 '405':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1286 description: Method disabled (MethodDisabled)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1287 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1288 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1289 /stream/upstreams/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1290 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1291 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1292 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1293 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1294 summary: Return status of all stream upstream server groups
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1295 description: Returns status of each stream upstream server group
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1296 and its servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1297 operationId: getStreamUpstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1298 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1299 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1300 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1301 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1302 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1303 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1304 description: Limits which fields of upstream server groups will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1305 If the “<literal>fields</literal>” value is empty,
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1306 only names of upstreams will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1307 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1308 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1309 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1310 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1311 $ref: '#/definitions/NginxStreamUpstreamMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1312 '/stream/upstreams/{streamUpstreamName}/':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1313 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1314 - name: streamUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1315 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1316 description: The name of a stream upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1317 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1318 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1319 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1320 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1321 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1322 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1323 summary: Return status of a stream upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1324 description: Returns status of a particular stream upstream server group
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1325 and its servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1326 operationId: getStreamUpstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1327 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1328 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1329 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1330 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1331 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1332 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1333 description: Limits which fields of the upstream server group will be output.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1334 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1335 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1336 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1337 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1338 $ref: '#/definitions/NginxStreamUpstream'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1339 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1340 description: Upstream is static (UpstreamStatic)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1341 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1342 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1343 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1344 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1345 Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1346 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1347 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1348 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1349 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1350 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1351 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1352 summary: Reset statistics of a stream upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1353 description: Resets the statistics for each upstream server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1354 in an upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1355 operationId: deleteStreamUpstreamStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1356 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1357 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1358 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1359 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1360 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1361 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1362 description: Upstream is static (UpstreamStatic)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1363 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1364 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1365 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1366 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1367 Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1368 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1369 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1370 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1371 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1372 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1373 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1374 '/stream/upstreams/{streamUpstreamName}/servers/':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1375 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1376 - name: streamUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1377 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1378 description: The name of an upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1379 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1380 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1381 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1382 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1383 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1384 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1385 summary: Return configuration of all servers in a stream upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1386 description: Returns configuration of each server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1387 in a particular stream upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1388 operationId: getStreamUpstreamServers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1389 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1390 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1391 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1392 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1393 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1394 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1395 $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1396 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1397 description: Upstream is static (UpstreamStatic)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1398 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1399 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1400 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1401 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1402 Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1403 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1404 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1405 post:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1406 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1407 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1408 - Method POST
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1409 summary: Add a server to a stream upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1410 description: Adds a new server to a stream upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1411 Server parameters are specified in the JSON format.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1412 operationId: postStreamUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1413 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1414 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1415 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1416 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1417 name: postStreamUpstreamServer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1418 description: Address of a new server and other optional parameters
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1419 in the JSON format.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1420 The “ID”, “backup”, and “service” parameters
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1421 cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1422 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1423 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1424 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1425 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1426 '201':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1427 description: Created
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1428 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1429 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1430 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1431 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1432 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1433 invalid “parameter” value (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1434 missing “server” argument (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1435 unknown parameter “name” (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1436 nested object or list (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1437 “error” while parsing (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1438 no port in server “host” (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1439 service upstream “host” may not have port (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1440 service upstream “host” requires domain name (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1441 invalid “weight” (UpstreamBadWeight),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1442 invalid “max_conns” (UpstreamBadMaxConns),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1443 invalid “max_fails” (UpstreamBadMaxFails),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1444 invalid “fail_timeout” (UpstreamBadFailTimeout),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1445 invalid “slow_start” (UpstreamBadSlowStart),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1446 “service” is empty (UpstreamBadService),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1447 no resolver defined to resolve (UpstreamConfNoResolver),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1448 upstream “name” has no backup (UpstreamNoBackup),
2494 78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1449 upstream “name” memory exhausted (UpstreamOutOfMemory),
78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1450 reading request body failed BodyReadError)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1451 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1452 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1453 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1454 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1455 Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1456 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1457 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1458 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1459 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1460 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1461 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1462 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1463 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1464 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1465 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1466 '/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1467 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1468 - name: streamUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1469 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1470 description: The name of the upstream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1471 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1472 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1473 - name: streamUpstreamServerId
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1474 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1475 description: The ID of the server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1476 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1477 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1478 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1479 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1480 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1481 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1482 summary: Return configuration of a server in a stream upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1483 description: Returns configuration of a particular server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1484 in the stream upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1485 operationId: getStreamUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1486 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1487 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1488 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1489 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1490 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1491 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1492 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1493 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1494 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1495 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1496 invalid server ID (UpstreamBadServerId)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1497 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1498 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1499 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1500 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1501 Upstream not found (UpstreamNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1502 server with ID “id” does not exist (UpstreamServerNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1503 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1504 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1505 patch:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1506 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1507 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1508 - Method PATCH
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1509 summary: Modify a server in a stream upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1510 description: Modifies settings of a particular server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1511 in a stream upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1512 Server parameters are specified in the JSON format.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1513 operationId: patchStreamUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1514 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1515 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1516 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1517 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1518 name: patchStreamUpstreamServer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1519 description: Server parameters, specified in the JSON format.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1520 The “ID”, “backup”, and “service” parameters
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1521 cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1522 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1523 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1524 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1525 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1526 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1527 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1528 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1529 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1530 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1531 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1532 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1533 invalid “parameter” value (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1534 unknown parameter “name” (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1535 nested object or list (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1536 “error” while parsing (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1537 invalid “server” argument (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1538 no port in server “host” (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1539 invalid server ID (UpstreamBadServerId),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1540 invalid “weight” (UpstreamBadWeight),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1541 invalid “max_conns” (UpstreamBadMaxConns),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1542 invalid “max_fails” (UpstreamBadMaxFails),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1543 invalid “fail_timeout” (UpstreamBadFailTimeout),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1544 invalid “slow_start” (UpstreamBadSlowStart),
2494 78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1545 reading request body failed BodyReadError),
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1546 “service” is empty (UpstreamBadService),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1547 server “ID” address is immutable (UpstreamServerImmutable),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1548 server “ID” weight is immutable (UpstreamServerWeightImmutable),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1549 upstream “name” memory exhausted (UpstreamOutOfMemory)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1550 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1551 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1552 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1553 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1554 Upstream not found (UpstreamNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1555 server with ID “id” does not exist (UpstreamServerNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1556 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1557 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1558 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1559 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1560 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1561 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1562 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1563 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1564 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1565 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1566 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1567 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1568 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1569 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1570 summary: Remove a server from a stream upstream server group
a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1571 description: Removes a server from a stream server group.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1572 operationId: deleteStreamUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1573 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1574 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1575 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1576 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1577 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1578 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1579 $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1580 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1581 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1582 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1583 invalid server ID (UpstreamBadServerId),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1584 server “id” not removable (UpstreamServerImmutable)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1585 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1586 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1587 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1588 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1589 Upstream not found (UpstreamNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1590 server with ID “id” does not exist (UpstreamServerNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1591 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1592 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1593 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1594 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1595 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1596 $ref: '#/definitions/NginxError'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1597 /stream/keyvals/:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1598 get:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1599 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1600 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1601 - Method GET
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1602 summary: Return key-value pairs from all stream keyval zones
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1603 description: Returns key-value pairs for each stream keyval shared memory
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1604 [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone).
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1605 operationId: getStreamKeyvalZones
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1606 produces:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1607 - application/json
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1608 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1609 - name: fields
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1610 in: query
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1611 type: string
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1612 description: If the “<literal>fields</literal>” value is empty,
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1613 then only stream keyval zone names will be output.
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1614 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1615 '200':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1616 description: Success
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1617 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1618 $ref: '#/definitions/NginxStreamKeyvalZonesMap'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1619 '/stream/keyvals/{streamKeyvalZoneName}':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1620 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1621 - name: streamKeyvalZoneName
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1622 in: path
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1623 description: The name of a stream keyval shared memory zone.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1624 required: true
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1625 type: string
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1626 get:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1627 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1628 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1629 - Method GET
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1630 summary: Return key-value pairs from a stream keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1631 description: Returns key-value pairs stored in a particular stream keyval shared memory
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1632 [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone).
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1633 operationId: getStreamKeyvalZoneKeysValues
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1634 produces:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1635 - application/json
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1636 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1637 - name: key
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1638 in: query
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1639 type: string
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1640 description: Get a particular key-value pair from the stream keyval zone.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1641 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1642 '200':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1643 description: Success
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1644 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1645 $ref: '#/definitions/NginxStreamKeyvalZone'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1646 '404':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1647 description: \|
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1648 Keyval not found (KeyvalNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1649 keyval key not found (KeyvalKeyNotFound)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1650 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1651 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1652 post:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1653 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1654 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1655 - Method POST
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1656 summary: Add a key-value pair to the stream keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1657 description: Adds a new key-value pair to the stream keyval shared memory
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1658 [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone).
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1659 Several key-value pairs can be entered
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1660 if the stream keyval shared memory zone is empty.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1661 operationId: postStreamKeyvalZoneData
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1662 produces:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1663 - application/json
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1664 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1665 - in: body
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1666 name: Key-value
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1667 description: A key-value pair is specified in the JSON format.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1668 Several key-value pairs can be entered
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1669 if the stream keyval shared memory zone is empty.
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1670 Expiration time in milliseconds can be specified for a key-value pair
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1671 with the expire parameter
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1672 which overrides the [timeout](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1673 parameter of the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1674 <a href="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</a>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1675 directive.
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1676 required: true
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1677 schema:
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1678 $ref: '#/definitions/NginxStreamKeyvalZonePostPatch'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1679 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1680 '201':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1681 description: Created
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1682 '400':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1683 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1684 Invalid JSON (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1685 invalid key format (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1686 key required (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1687 keyval timeout is not enabled (KeyvalFormatError),
2494 78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1688 only one key can be added (KeyvalFormatError),
78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1689 reading request body failed BodyReadError)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1690 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1691 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1692 '404':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1693 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1694 Keyval not found (KeyvalNotFound)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1695 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1696 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1697 '405':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1698 description: Method disabled (MethodDisabled)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1699 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1700 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1701 '409':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1702 description: Key already exists (KeyvalKeyExists)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1703 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1704 $ref: '#/definitions/NginxError'
2493 407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1705 '413':
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1706 description: Request Entity Too Large
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1707 schema:
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1708 $ref: '#/definitions/NginxError'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1709 '415':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1710 description: JSON error (JsonError)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1711 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1712 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1713 patch:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1714 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1715 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1716 - Method PATCH
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1717 summary: Modify a key-value or delete a key
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1718 description: Changes the value of the selected key in the key-value pair,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1719 deletes a key by setting the key value to <literal>null</literal>,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1720 changes expiration time of a key-value pair.
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1721 If
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1722 <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1723 of keyval zones in a cluster is enabled,
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1724 deletes a key only on a target cluster node.
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1725 Expiration time is specified in milliseconds
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1726 with the expire parameter
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1727 which overrides the [timeout](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1728 parameter of the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1729 <a href="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</a>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1730 directive.
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1731 operationId: patchStreamKeyvalZoneKeyValue
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1732 produces:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1733 - application/json
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1734 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1735 - in: body
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1736 name: streamKeyvalZoneKeyValue
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1737 description: A new value for the key is specified in the JSON format.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1738 required: true
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1739 schema:
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1740 $ref: '#/definitions/NginxStreamKeyvalZonePostPatch'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1741 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1742 '204':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1743 description: Success
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1744 '400':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1745 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1746 Invalid JSON (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1747 key required (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1748 keyval timeout is not enabled (KeyvalFormatError),
2494 78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1749 only one key can be updated (KeyvalFormatError),
78d4e25adf49 Documented "BodyReadError" in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	1750 reading request body failed BodyReadError)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1751 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1752 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1753 '404':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1754 description: \|
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1755 Keyval not found (KeyvalNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1756 keyval key not found (KeyvalKeyNotFound)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1757 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1758 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1759 '405':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1760 description: Method disabled (MethodDisabled)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1761 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1762 $ref: '#/definitions/NginxError'
2493 407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1763 '413':
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1764 description: Request Entity Too Large
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1765 schema:
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1766 $ref: '#/definitions/NginxError'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1767 '415':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1768 description: JSON error (JsonError)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1769 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1770 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1771 delete:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1772 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1773 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1774 - Method DELETE
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1775 summary: Empty the stream keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1776 description: Deletes all key-value pairs from the stream keyval shared memory
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1777 [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone).
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1778 If
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1779 <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1780 of keyval zones in a cluster is enabled,
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1781 empties the keyval zone only on a target cluster node.
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1782 operationId: deleteStreamKeyvalZoneData
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1783 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1784 '204':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1785 description: Success
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1786 '404':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1787 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1788 Keyval not found (KeyvalNotFound)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1789 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1790 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1791 '405':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1792 description: Method disabled (MethodDisabled)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1793 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1794 $ref: '#/definitions/NginxError'
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1795 /stream/zone_sync/:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1796 get:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1797 tags:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1798 - Stream Zone Sync
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1799 - Method GET
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1800 summary: Return sync status of a node
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1801 description: Returns synchronization status of a cluster node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1802 operationId: getStreamZoneSync
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1803 produces:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1804 - application/json
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1805 responses:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1806 '200':
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1807 description: Success
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1808 schema:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1809 $ref: '#/definitions/NginxStreamZoneSync'
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1810 /resolvers/:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1811 get:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1812 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1813 - Resolvers
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1814 - Method GET
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1815 summary: Return status for all resolver zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1816 description: Returns status information for each
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1817 [resolver zone](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone).
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1818 operationId: getResolverZones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1819 produces:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1820 - application/json
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1821 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1822 '200':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1823 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1824 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1825 $ref: '#/definitions/NginxResolverZonesMap'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1826 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1827 - in: query
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1828 name: fields
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1829 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1830 description: Limits which fields of resolvers statistics will be output.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1831 '/resolvers/{resolverZoneName}':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1832 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1833 - name: resolverZoneName
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1834 in: path
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1835 description: The name of a resolver zone.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1836 required: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1837 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1838 get:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1839 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1840 - Resolvers
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1841 - Method GET
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1842 summary: Return statistics of a resolver zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1843 description: Returns statistics stored in a particular resolver
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1844 [zone](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone).
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1845 operationId: getResolverZone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1846 produces:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1847 - application/json
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1848 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1849 - name: fields
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1850 in: query
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1851 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1852 description: Limits which fields of the resolver zone will be output
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1853 (requests, responses, or both).
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1854 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1855 '200':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1856 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1857 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1858 $ref: '#/definitions/NginxResolverZone'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1859 '404':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1860 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1861 Resolver zone not found (ResolverZoneNotFound)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1862 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1863 $ref: '#/definitions/NginxError'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1864 delete:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1865 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1866 - Resolvers
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1867 - Method DELETE
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1868 summary: Reset statistics for a resolver zone.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1869 description: Resets statistics in a particular resolver zone.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1870 operationId: deleteResolverZoneStat
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1871 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1872 '204':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1873 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1874 '404':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1875 description: Resolver zone not found (ResolverZoneNotFound)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1876 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1877 $ref: '#/definitions/NginxError'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1878 '405':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1879 description: Method disabled (MethodDisabled)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1880 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1881 $ref: '#/definitions/NginxError'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1882 /ssl:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1883 get:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1884 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1885 - SSL
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1886 - Method GET
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1887 summary: Return SSL statistics
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1888 description: Returns SSL statistics.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1889 operationId: getSsl
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1890 produces:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1891 - application/json
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1892 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1893 '200':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1894 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1895 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1896 $ref: '#/definitions/NginxSSLObject'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1897 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1898 - in: query
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1899 name: fields
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1900 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1901 description: Limits which fields of SSL statistics will be output.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1902 delete:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1903 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1904 - SSL
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1905 - Method DELETE
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1906 summary: Reset SSL statistics
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1907 description: Resets counters of SSL handshakes and session reuses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1908 operationId: deleteSslStat
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1909 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1910 '204':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1911 description: Success
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1912 ###
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1913 ###DEFINITIONS
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1914 ###
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1915 definitions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1916 ArrayOfStrings:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1917 title: Array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1918 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1919 An array of strings.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1920 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1921 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1922 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1923 NginxObject:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1924 title: nginx
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1925 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1926 General information about nginx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1927 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1928 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1929 version:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1930 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1931 description: Version of nginx.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1932 build:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1933 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1934 description: Name of nginx build.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1935 address:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1936 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1937 description: The address of the server that accepted status request.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1938 generation:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1939 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1940 description: The total number of configuration
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1941 <a href="https://nginx.org/en/docs/control.html#reconfiguration">reloads</a>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1942 load_timestamp:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1943 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1944 format: date-time
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1945 description: Time of the last reload of configuration,
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1946 in the ISO 8601 format with millisecond resolution.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1947 timestamp:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1948 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1949 format: date-time
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1950 description: Current time
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1951 in the ISO 8601 format with millisecond resolution.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1952 pid:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1953 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1954 description: The ID of the worker process that handled status request.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1955 ppid:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1956 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1957 description: The ID of the master process that started the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1958 <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1959 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1960 nginx:
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1961 version: 1.17.3
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1962 build: nginx-plus-r19
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1963 address: 206.251.255.64
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1964 generation: 6
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1965 load_timestamp: 2019-10-01T11:15:44.467Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1966 timestamp: 2019-10-01T09:26:07.305Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1967 pid: 32212
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1968 ppid: 32210
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1969 NginxProcesses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1970 title: Processes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1971 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1972 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1973 respawned:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1974 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1975 description: The total number of abnormally terminated
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1976 and respawned child processes.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1977 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1978 respawned: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1979 NginxConnections:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1980 title: Connections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1981 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1982 The number of accepted, dropped, active, and idle connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1983 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1984 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1985 accepted:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1986 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1987 description: The total number of accepted client connections.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1988 dropped:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1989 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1990 description: The total number of dropped client connections.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1991 active:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1992 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1993 description: The current number of active client connections.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1994 idle:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1995 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1996 description: The current number of idle client connections.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1997 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1998 accepted: 4968119
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1999 dropped: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2000 active: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2001 idle: 117
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2002 NginxSSLObject:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2003 title: SSL
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2004 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2005 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2006 handshakes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2007 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2008 description: The total number of successful SSL handshakes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2009 handshakes_failed:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2010 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2011 description: The total number of failed SSL handshakes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2012 session_reuses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2013 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2014 description: The total number of session reuses during SSL handshake.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2015 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2016 handshakes: 79572
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2017 handshakes_failed: 21025
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2018 session_reuses: 15762
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2019 NginxSlabZoneMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2020 title: Slab Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2021 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2022 Status zones that use slab allocator.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2023 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2024 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2025 $ref: '#/definitions/NginxSlabZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2026 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2027 http_cache:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2028 pages:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2029 used: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2030 free: 2452
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2031 slots:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2032 8:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2033 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2034 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2035 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2036 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2037 16:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2038 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2039 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2040 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2041 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2042 32:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2043 used: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2044 free: 126
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2045 reqs: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2046 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2047 64:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2048 used: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2049 free: 62
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2050 reqs: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2051 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2052 128:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2053 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2054 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2055 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2056 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2057 dns-backends:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2058 pages:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2059 used: 1143
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2060 free: 2928
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2061 slots:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2062 8:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2063 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2064 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2065 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2066 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2067 16:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2068 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2069 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2070 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2071 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2072 32:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2073 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2074 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2075 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2076 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2077 64:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2078 used: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2079 free: 63
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2080 reqs: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2081 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2082 128:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2083 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2084 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2085 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2086 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2087 256:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2088 used: 18078
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2089 free: 178
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2090 reqs: 1635736
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2091 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2092 NginxSlabZone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2093 title: Shared memory zone with slab allocator
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2094 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2095 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2096 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2097 pages:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2098 type: object
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2099 description: The number of free and used memory pages.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2100 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2101 used:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2102 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2103 description: The current number of used memory pages.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2104 free:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2105 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2106 description: The current number of free memory pages.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2107 slots:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2108 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2109 title: Memory Slots
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2110 description: Status data for memory slots (8, 16, 32, 64, 128, etc.)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2111 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2112 $ref: '#/definitions/NginxSlabZoneSlot'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2113 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2114 pages:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2115 used: 1143
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2116 free: 2928
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2117 slots:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2118 8:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2119 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2120 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2121 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2122 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2123 16:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2124 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2125 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2126 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2127 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2128 32:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2129 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2130 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2131 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2132 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2133 64:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2134 used: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2135 free: 63
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2136 reqs: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2137 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2138 128:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2139 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2140 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2141 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2142 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2143 256:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2144 used: 18078
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2145 free: 178
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2146 reqs: 1635736
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2147 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2148 NginxSlabZoneSlot:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2149 title: Memory Slot
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2150 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2151 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2152 used:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2153 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2154 description: The current number of used memory slots.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2155 free:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2156 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2157 description: The current number of free memory slots.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2158 reqs:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2159 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2160 description: The total number of attempts
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2161 to allocate memory of specified size.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2162 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2163 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2164 description: The number of unsuccessful attempts
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2165 to allocate memory of specified size.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2166 NginxHTTPRequests:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2167 title: HTTP Requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2168 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2169 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2170 total:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2171 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2172 description: The total number of client requests.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2173 current:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2174 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2175 description: The current number of client requests.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2176 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2177 total: 10624511
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2178 current: 4
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2179 NginxHTTPServerZonesMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2180 title: HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2181 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2182 Status data for all HTTP
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	2183 <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">status zones</a>.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2184 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2185 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2186 $ref: '#/definitions/NginxHTTPServerZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2187 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2188 site1:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2189 processing: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2190 requests: 736395
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2191 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2192 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2193 2xx: 727290
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2194 3xx: 4614
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2195 4xx: 934
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2196 5xx: 1535
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2197 total: 734373
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2198 discarded: 2020
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2199 received: 180157219
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2200 sent: 20183175459
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2201 site2:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2202 processing: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2203 requests: 185307
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2204 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2205 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2206 2xx: 112674
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2207 3xx: 45383
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2208 4xx: 2504
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2209 5xx: 4419
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2210 total: 164980
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2211 discarded: 20326
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2212 received: 51575327
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2213 sent: 2983241510
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2214 NginxHTTPServerZone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2215 title: HTTP Server Zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2216 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2217 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2218 processing:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2219 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2220 description: The number of client requests
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2221 that are currently being processed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2222 requests:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2223 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2224 description: The total number of client requests received from clients.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2225 responses:
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2226 description: The total number of responses sent to clients and the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2227 number of responses with status codes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2228 “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2229 “<code>4xx</code>”, and “<code>5xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2230 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2231 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2232 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2233 1xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2234 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2235 description: The number of responses with “<code>1xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2236 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2237 2xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2238 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2239 description: The number of responses with “<code>2xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2240 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2241 3xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2242 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2243 description: The number of responses with “<code>3xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2244 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2245 4xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2246 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2247 description: The number of responses with “<code>4xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2248 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2249 5xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2250 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2251 description: The number of responses with “<code>5xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2252 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2253 total:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2254 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2255 description: The total number of responses sent to clients.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2256 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2257 discarded:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2258 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2259 description: The total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2260 requests completed without sending a response.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2261 received:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2262 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2263 description: The total number of bytes received from clients.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2264 sent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2265 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2266 description: The total number of bytes sent to clients.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2267 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2268 processing: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2269 requests: 706690
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2270 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2271 1xx: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2272 2xx: 699482
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2273 3xx: 4522
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2274 4xx: 907
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2275 5xx: 266
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2276 total: 705177
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2277 discarded: 1513
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2278 received: 172711587
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2279 sent: 19415530115
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2280 NginxHTTPLocationZonesMap:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2281 title: HTTP Location Zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2282 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2283 Status data for all HTTP
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2284 <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">location zones</a>.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2285 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2286 additionalProperties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2287 $ref: '#/definitions/NginxHTTPLocationZone'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2288 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2289 site1:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2290 requests: 736395
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2291 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2292 1xx: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2293 2xx: 727290
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2294 3xx: 4614
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2295 4xx: 934
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2296 5xx: 1535
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2297 total: 734373
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2298 discarded: 2020
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2299 received: 180157219
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2300 sent: 20183175459
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2301 site2:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2302 requests: 185307
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2303 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2304 1xx: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2305 2xx: 112674
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2306 3xx: 45383
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2307 4xx: 2504
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2308 5xx: 4419
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2309 total: 164980
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2310 discarded: 20326
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2311 received: 51575327
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2312 sent: 2983241510
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2313 NginxHTTPLocationZone:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2314 title: HTTP Location Zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2315 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2316 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2317 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2318 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2319 description: The total number of client requests received from clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2320 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2321 description: The total number of responses sent to clients and the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2322 number of responses with status codes
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2323 “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2324 “<code>4xx</code>”, and “<code>5xx</code>”.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2325 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2326 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2327 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2328 1xx:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2329 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2330 description: The number of responses with “<code>1xx</code>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2331 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2332 2xx:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2333 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2334 description: The number of responses with “<code>2xx</code>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2335 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2336 3xx:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2337 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2338 description: The number of responses with “<code>3xx</code>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2339 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2340 4xx:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2341 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2342 description: The number of responses with “<code>4xx</code>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2343 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2344 5xx:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2345 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2346 description: The number of responses with “<code>5xx</code>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2347 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2348 total:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2349 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2350 description: The total number of responses sent to clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2351 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2352 discarded:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2353 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2354 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2355 requests completed without sending a response.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2356 received:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2357 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2358 description: The total number of bytes received from clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2359 sent:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2360 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2361 description: The total number of bytes sent to clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2362 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2363 requests: 706690
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2364 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2365 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2366 2xx: 699482
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2367 3xx: 4522
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2368 4xx: 907
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2369 5xx: 266
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2370 total: 705177
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2371 discarded: 1513
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2372 received: 172711587
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2373 sent: 19415530115
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2374 NginxHTTPCachesMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2375 title: HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2376 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2377 Status information of all HTTP caches configured by
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2378 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path">proxy_cache_path</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2379 and other “<code>*_cache_path</code>” directives.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2380 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2381 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2382 $ref: '#/definitions/NginxHTTPCache'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2383 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2384 http-cache:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2385 size: 530915328
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2386 max_size: 536870912
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2387 cold: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2388 hit:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2389 responses: 254032
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2390 bytes: 6685627875
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2391 stale:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2392 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2393 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2394 updating:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2395 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2396 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2397 revalidated:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2398 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2399 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2400 miss:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2401 responses: 1619201
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2402 bytes: 53841943822
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2403 expired:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2404 responses: 45859
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2405 bytes: 1656847080
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2406 responses_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2407 bytes_written: 1641825173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2408 bypass:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2409 responses: 200187
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2410 bytes: 5510647548
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2411 responses_written: 200173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2412 bytes_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2413 frontend-cache:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2414 size: 530915328
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2415 max_size: 536870912
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2416 cold: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2417 hit:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2418 responses: 254032
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2419 bytes: 6685627875
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2420 stale:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2421 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2422 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2423 updating:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2424 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2425 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2426 revalidated:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2427 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2428 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2429 miss:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2430 responses: 1619201
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2431 bytes: 53841943822
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2432 expired:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2433 responses: 45859
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2434 bytes: 1656847080
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2435 responses_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2436 bytes_written: 1641825173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2437 bypass:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2438 responses: 200187
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2439 bytes: 5510647548
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2440 responses_written: 200173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2441 bytes_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2442 NginxHTTPCache:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2443 title: HTTP Cache
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2444 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2445 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2446 size:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2447 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2448 description: The current size of the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2449 max_size:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2450 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2451 description: The limit on the maximum size of the cache
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2452 specified in the configuration.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2453 cold:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2454 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2455 description: A boolean value indicating whether the “cache loader” process
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2456 is still loading data from disk into the cache.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2457 hit:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2458 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2459 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2460 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2461 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2462 description: The total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2463 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid">valid</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2464 responses read from the cache.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2465 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2466 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2467 description: The total number of bytes read from the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2468 stale:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2469 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2470 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2471 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2472 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2473 description: The total number of expired responses read from the cache (see
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2474 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale">proxy_cache_use_stale</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2475 and other “<code>*_cache_use_stale</code>” directives).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2476 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2477 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2478 description: The total number of bytes read from the cache.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2479 updating:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2480 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2481 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2482 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2483 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2484 description: The total number of expired responses read from the cache
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2485 while responses were being updated (see
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2486 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale_updating">proxy_cache_use_stale</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2487 and other “<code>*_cache_use_stale</code>” directives).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2488 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2489 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2490 description: The total number of bytes read from the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2491 revalidated:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2492 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2493 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2494 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2495 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2496 description: The total number of expired and revalidated responses
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2497 read from the cache (see
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2498 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_revalidate">proxy_cache_revalidate</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2499 and other “<code>*_cache_revalidate</code>” directives.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2500 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2501 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2502 description: The total number of bytes read from the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2503 miss:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2504 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2505 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2506 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2507 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2508 description: The total number of responses not found in the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2509 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2510 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2511 description: The total number of bytes read from the proxied server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2512 responses_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2513 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2514 description: The total number of responses written to the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2515 bytes_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2516 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2517 description: The total number of bytes written to the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2518 expired:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2519 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2520 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2521 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2522 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2523 description: The total number of expired responses not taken from the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2524 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2525 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2526 description: The total number of bytes read from the proxied server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2527 responses_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2528 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2529 description: The total number of responses written to the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2530 bytes_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2531 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2532 description: The total number of bytes written to the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2533 bypass:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2534 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2535 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2536 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2537 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2538 description: The total number of responses not looked up in the cache due to the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2539 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_bypass">proxy_cache_bypass</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2540 and other “<code>*_cache_bypass</code>” directives.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2541 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2542 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2543 description: The total number of bytes read from the proxied server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2544 responses_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2545 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2546 description: The total number of responses written to the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2547 bytes_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2548 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2549 description: The total number of bytes written to the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2550 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2551 size: 530915328
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2552 max_size: 536870912
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2553 cold: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2554 hit:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2555 responses: 254032
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2556 bytes: 6685627875
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2557 stale:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2558 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2559 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2560 updating:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2561 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2562 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2563 revalidated:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2564 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2565 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2566 miss:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2567 responses: 1619201
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2568 bytes: 53841943822
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2569 expired:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2570 responses: 45859
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2571 bytes: 1656847080
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2572 responses_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2573 bytes_written: 1641825173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2574 bypass:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2575 responses: 200187
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2576 bytes: 5510647548
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2577 responses_written: 200173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2578 bytes_written: 44992
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2579 NginxHTTPLimitConnZonesMap:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2580 title: HTTP limit_conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2581 description: \|
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2582 Status data for all HTTP
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2583 <a href="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zones</a>.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2584 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2585 additionalProperties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2586 $ref: '#/definitions/NginxHTTPLimitConnZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2587 NginxHTTPLimitConnZone:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2588 title: HTTP Connections Limiting
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2589 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2590 properties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2591 passed:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2592 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2593 description: The total number of connections that were neither limited
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2594 nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2595 rejected:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2596 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2597 description: The total number of connections that were rejected.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2598 rejected_dry_run:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2599 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2600 description: The total number of connections accounted as rejected in the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2601 <a href="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_dry_run">dry run</a>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2602 mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2603 example:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2604 passed: 15
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2605 rejected: 0
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2606 rejected_dry_run: 2
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2607 NginxHTTPLimitReqZonesMap:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2608 title: HTTP limit_reqs
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2609 description: \|
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2610 Status data for all HTTP
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2611 <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zones</a>.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2612 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2613 additionalProperties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2614 $ref: '#/definitions/NginxHTTPLimitReqZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2615 NginxHTTPLimitReqZone:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2616 title: HTTP Requests Rate Limiting
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2617 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2618 properties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2619 passed:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2620 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2621 description: The total number of requests that were neither limited
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2622 nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2623 delayed:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2624 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2625 description: The total number of requests that were delayed.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2626 rejected:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2627 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2628 description: The total number of requests that were rejected.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2629 delayed_dry_run:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2630 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2631 description: The total number of requests accounted as delayed in the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2632 <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</a>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2633 mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2634 rejected_dry_run:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2635 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2636 description: The total number of requests accounted as rejected in the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2637 <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</a>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2638 mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2639 example:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2640 passed: 15
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2641 delayed: 4
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2642 rejected: 0
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2643 delayed_dry_run: 1
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2644 rejected_dry_run: 2
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2645 NginxHTTPUpstreamMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2646 title: HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2647 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2648 Status information of all HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2649 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">dynamically configurable</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2650 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream">groups</a>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2651 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2652 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2653 $ref: '#/definitions/NginxHTTPUpstream'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2654 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2655 trac-backend:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2656 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2657 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2658 server: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2659 name: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2660 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2661 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2662 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2663 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2664 requests: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2665 header_time: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2666 response_time: 36
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2667 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2668 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2669 2xx: 666310
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2670 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2671 4xx: 915
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2672 5xx: 6
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2673 total: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2674 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2675 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2676 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2677 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2678 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2679 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2680 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2681 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2682 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2683 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2684 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2685 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2686 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2687 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2688 name: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2689 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2690 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2691 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2692 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2693 requests: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2694 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2695 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2696 2xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2697 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2698 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2699 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2700 total: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2701 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2702 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2703 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2704 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2705 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2706 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2707 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2708 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2709 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2710 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2711 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2712 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2713 keepalive: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2714 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2715 zone: trac-backend
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2716 hg-backend:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2717 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2718 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2719 server: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2720 name: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2721 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2722 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2723 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2724 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2725 requests: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2726 header_time: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2727 response_time: 36
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2728 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2729 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2730 2xx: 666310
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2731 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2732 4xx: 915
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2733 5xx: 6
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2734 total: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2735 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2736 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2737 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2738 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2739 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2740 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2741 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2742 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2743 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2744 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2745 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2746 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2747 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2748 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2749 name: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2750 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2751 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2752 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2753 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2754 requests: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2755 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2756 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2757 2xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2758 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2759 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2760 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2761 total: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2762 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2763 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2764 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2765 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2766 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2767 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2768 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2769 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2770 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2771 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2772 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2773 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2774 keepalive: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2775 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2776 zone: hg-backend
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2777 NginxHTTPUpstream:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2778 title: HTTP Upstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2779 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2780 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2781 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2782 $ref: '#/definitions/NginxHTTPUpstreamPeerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2783 keepalive:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2784 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2785 description: The current number of idle
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2786 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive">keepalive</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2787 connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2788 zombies:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2789 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2790 description: The current number of servers removed
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2791 from the group but still processing active client requests.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2792 zone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2793 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2794 description: The name of the shared memory
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2795 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">zone</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2796 that keeps the group’s configuration and run-time state.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2797 queue:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2798 type: object
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2799 description: >
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2800 For the requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2801 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue">queue</a>,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2802 the following data are provided:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2803 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2804 size:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2805 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2806 description: The current number of requests in the queue.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2807 max_size:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2808 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2809 description: The maximum number of requests that can be in the queue
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2810 at the same time.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2811 overflows:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2812 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2813 description: The total number of requests rejected due to the queue overflow.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2814 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2815 upstream_backend:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2816 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2817 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2818 server: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2819 name: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2820 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2821 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2822 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2823 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2824 max_conns: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2825 requests: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2826 header_time: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2827 response_time: 36
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2828 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2829 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2830 2xx: 666310
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2831 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2832 4xx: 915
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2833 5xx: 6
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2834 total: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2835 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2836 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2837 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2838 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2839 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2840 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2841 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2842 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2843 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2844 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2845 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2846 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2847 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2848 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2849 name: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2850 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2851 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2852 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2853 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2854 max_conns: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2855 requests: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2856 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2857 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2858 2xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2859 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2860 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2861 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2862 total: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2863 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2864 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2865 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2866 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2867 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2868 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2869 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2870 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2871 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2872 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2873 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2874 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2875 keepalive: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2876 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2877 zone: upstream_backend
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2878 NginxHTTPUpstreamPeerMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2879 title: HTTP Upstream Servers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2880 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2881 An array of HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2882 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream">upstream servers</a>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2883 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2884 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2885 $ref: '#/definitions/NginxHTTPUpstreamPeer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2886 NginxHTTPUpstreamPeer:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2887 title: HTTP Upstream Server
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2888 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2889 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2890 id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2891 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2892 description: The ID of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2893 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2894 server:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2895 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2896 description: An <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">address</a>
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2897 of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2898 service:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2899 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2900 description: The
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2901 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2902 parameter value of the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2903 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2904 directive.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2905 name:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2906 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2907 description: The name of the server specified in the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2908 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2909 directive.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2910 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2911 backup:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2912 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2913 description: A boolean value indicating whether the server is a
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2914 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2915 server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2916 weight:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2917 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2918 description: <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">Weight</a>
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2919 of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2920 state:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2921 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2922 enum:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2923 - up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2924 - draining
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2925 - down
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2926 - unavail
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2927 - checking
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2928 - unhealthy
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2929 description: Current state, which may be one of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2930 “<code>up</code>”, “<code>draining</code>”, “<code>down</code>”,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2931 “<code>unavail</code>”, “<code>checking</code>”,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2932 and “<code>unhealthy</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2933 active:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2934 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2935 description: The current number of active connections.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2936 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2937 max_conns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2938 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2939 description: The
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2940 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2941 limit for the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2942 requests:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2943 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2944 description: The total number of client requests forwarded to this server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2945 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2946 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2947 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2948 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2949 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2950 1xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2951 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2952 description: The number of responses with “<code>1xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2953 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2954 2xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2955 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2956 description: The number of responses with “<code>2xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2957 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2958 3xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2959 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2960 description: The number of responses with “<code>3xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2961 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2962 4xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2963 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2964 description: The number of responses with “<code>4xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2965 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2966 5xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2967 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2968 description: The number of responses with “<code>5xx</code>” status codes.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2969 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2970 total:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2971 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2972 description: The total number of responses obtained from this server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2973 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2974 sent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2975 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2976 description: The total number of bytes sent to this server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2977 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2978 received:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2979 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2980 description: The total number of bytes received from this server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2981 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2982 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2983 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2984 description: The total number of unsuccessful attempts
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2985 to communicate with the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2986 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2987 unavail:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2988 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2989 description: How many times the server became unavailable for client requests
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2990 (state “<code>unavail</code>”) due to the number of unsuccessful
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2991 attempts reaching the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2992 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2993 threshold.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2994 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2995 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2996 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2997 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2998 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2999 checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3000 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3001 description: The total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3002 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#health_check">health check</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3003 requests made.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3004 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3005 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3006 description: The number of failed health checks.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3007 unhealthy:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3008 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3009 description: How many times the server became unhealthy
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3010 (state “<code>unhealthy</code>”).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3011 last_passed:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3012 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3013 description: Boolean indicating if the last health check request was successful
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3014 and passed
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3015 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#match">tests</a>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3016 downtime:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3017 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3018 readOnly: true
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3019 description: Total time the server was in the “<code>unavail</code>”,
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3020 “<code>checking</code>”, and “<code>unhealthy</code>” states.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3021 downstart:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3022 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3023 format: date-time
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3024 readOnly: true
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3025 description: The time when the server became
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3026 “<code>unavail</code>”, “<code>checking</code>”,
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3027 or “<code>unhealthy</code>”,
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3028 in the ISO 8601 format with millisecond resolution.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3029 selected:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3030 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3031 format: date-time
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3032 readOnly: true
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3033 description: The time when the server was last selected to process a request,
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3034 in the ISO 8601 format with millisecond resolution.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3035 header_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3036 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3037 readOnly: true
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3038 description: The average time to get the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3039 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_header_time">response header</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3040 from the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3041 response_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3042 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3043 readOnly: true
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3044 description: The average time to get the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3045 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_response_time">full response</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3046 from the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3047 NginxHTTPUpstreamConfServerMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3048 title: HTTP Upstream Servers
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3049 description: An array of HTTP upstream servers for dynamic configuration.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3050 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3051 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3052 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3053 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3054 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3055 server: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3056 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3057 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3058 max_fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3059 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3060 slow_start: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3061 route: ''
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3062 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3063 down: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3064 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3065 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3066 weight: 4
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3067 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3068 max_fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3069 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3070 slow_start: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3071 route: ''
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3072 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3073 down: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3074 NginxHTTPUpstreamConfServer:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3075 title: HTTP Upstream Server
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3076 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3077 Dynamically configurable parameters of an HTTP upstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3078 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3079 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3080 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3081 id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3082 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3083 description: The ID of the HTTP upstream server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3084 The ID is assigned automatically and cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3085 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3086 server:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3087 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3088 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3089 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#address">address</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3090 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3091 When adding a server, it is possible to specify it as a domain name.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3092 In this case, changes of the IP addresses
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3093 that correspond to a domain name will be monitored and automatically
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3094 applied to the upstream configuration
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3095 without the need of restarting nginx.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3096 This requires the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3097 <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver">resolver</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3098 directive in the “<code>http</code>” block.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3099 See also the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3100 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#resolve">resolve</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3101 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3102 service:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3103 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3104 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3105 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3106 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3107 This parameter cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3108 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3109 weight:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3110 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3111 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3112 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">weight</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3113 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3114 max_conns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3115 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3116 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3117 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3118 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3119 max_fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3120 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3121 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3122 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3123 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3124 fail_timeout:
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3125 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3126 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3127 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#fail_timeout">fail_timeout</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3128 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3129 slow_start:
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3130 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3131 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3132 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#slow_start">slow_start</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3133 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3134 route:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3135 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3136 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3137 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#route">route</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3138 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3139 backup:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3140 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3141 description: When <code>true</code>, adds a
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3142 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3143 server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3144 This parameter cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3145 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3146 down:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3147 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3148 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3149 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#down">down</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3150 parameter of the HTTP upstream server.
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3151 drain:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3152 type: boolean
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3153 description: Same as the
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3154 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#drain">drain</a>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3155 parameter of the HTTP upstream server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3156 parent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3157 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3158 description: Parent server ID of the resolved server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3159 The ID is assigned automatically and cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3160 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3161 host:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3162 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3163 description: Hostname of the resolved server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3164 The hostname is assigned automatically and cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3165 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3166 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3167 id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3168 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3169 weight: 4
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3170 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3171 max_fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3172 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3173 slow_start: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3174 route: ''
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3175 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3176 down: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3177 NginxHTTPKeyvalZonesMap:
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3178 title: HTTP Keyval Shared Memory Zones
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3179 description: \|
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3180 Contents of all HTTP keyval shared memory zones.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3181 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3182 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3183 $ref: '#/definitions/NginxHTTPKeyvalZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3184 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3185 keyval_zone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3186 key1: value1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3187 key2: value2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3188 key3: value3
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3189 one:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3190 arg1: value1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3191 arg2: value2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3192 arg3: value3
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3193 NginxHTTPKeyvalZone:
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3194 title: HTTP Keyval Shared Memory Zone
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3195 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3196 Contents of an HTTP keyval shared memory zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3197 when using the GET method.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3198 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3199 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3200 key1: value1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3201 key2: value2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3202 key3: value3
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3203 NginxHTTPKeyvalZonePostPatch:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3204 title: HTTP Keyval Shared Memory Zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3205 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3206 Contents of an HTTP keyval shared memory zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3207 when using the POST or PATCH methods.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3208 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3209 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3210 key1: value1
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3211 key2: value2
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3212 key3:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3213 value: value3
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3214 expire: 30000
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3215 NginxStreamServerZonesMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3216 title: Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3217 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3218 Status information for all stream
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	3219 <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">status zones</a>.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3220 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3221 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3222 $ref: '#/definitions/NginxStreamServerZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3223 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3224 mysql-frontend:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3225 processing: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3226 connections: 270925
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3227 sessions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3228 2xx: 155564
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3229 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3230 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3231 total: 270925
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3232 discarded: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3233 received: 28988975
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3234 sent: 3879346317
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3235 dns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3236 processing: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3237 connections: 155569
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3238 sessions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3239 2xx: 155564
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3240 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3241 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3242 total: 155569
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3243 discarded: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3244 received: 4200363
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3245 sent: 20489184
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3246 NginxStreamServerZone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3247 title: Stream Server Zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3248 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3249 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3250 processing:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3251 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3252 description: The number of client connections
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3253 that are currently being processed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3254 connections:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3255 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3256 description: The total number of connections accepted from clients.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3257 sessions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3258 type: object
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3259 description: The total number of completed sessions,
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3260 and the number of sessions completed with status codes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3261 “<code>2xx</code>”, “<code>4xx</code>”, or “<code>5xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3262 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3263 2xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3264 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3265 description: The total number of sessions completed with
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3266 <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3267 “<code>2xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3268 4xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3269 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3270 description: The total number of sessions completed with
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3271 <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3272 “<code>4xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3273 5xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3274 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3275 description: The total number of sessions completed with
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3276 <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3277 “<code>5xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3278 total:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3279 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3280 description: The total number of completed client sessions.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3281 discarded:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3282 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3283 description: The total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3284 connections completed without creating a session.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3285 received:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3286 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3287 description: The total number of bytes received from clients.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3288 sent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3289 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3290 description: The total number of bytes sent to clients.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3291 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3292 dns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3293 processing: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3294 connections: 155569
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3295 sessions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3296 2xx: 155564
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3297 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3298 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3299 total: 155569
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3300 discarded: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3301 received: 4200363
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3302 sent: 20489184
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3303 NginxStreamLimitConnZonesMap:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3304 title: Stream limit_conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3305 description: \|
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3306 Status data for all stream
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3307 <a href="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zones</a>.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3308 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3309 additionalProperties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3310 $ref: '#/definitions/NginxStreamLimitConnZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3311 NginxStreamLimitConnZone:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3312 title: Stream Connections Limiting
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3313 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3314 properties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3315 passed:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3316 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3317 description: The total number of connections that were neither limited
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3318 nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3319 rejected:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3320 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3321 description: The total number of connections that were rejected.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3322 rejected_dry_run:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3323 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3324 description: The total number of connections accounted as rejected in the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3325 <a href="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_dry_run">dry run</a>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3326 mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3327 example:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3328 passed: 15
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3329 rejected: 0
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3330 rejected_dry_run: 2
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3331 NginxStreamUpstreamMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3332 title: Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3333 description: Status information of stream upstream server groups.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3334 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3335 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3336 $ref: '#/definitions/NginxStreamUpstream'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3337 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3338 mysql_backends:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3339 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3340 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3341 server: 10.0.0.1:12345
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3342 name: 10.0.0.1:12345
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3343 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3344 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3345 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3346 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3347 max_conns: 30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3348 connecions: 1231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3349 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3350 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3351 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3352 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3353 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3354 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3355 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3356 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3357 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3358 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3359 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3360 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3361 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3362 server: 10.0.0.1:12346
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3363 name: 10.0.0.1:12346
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3364 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3365 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3366 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3367 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3368 max_conns: 30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3369 connections: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3370 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3371 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3372 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3373 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3374 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3375 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3376 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3377 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3378 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3379 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3380 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3381 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3382 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3383 zone: mysql_backends
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3384 dns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3385 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3386 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3387 server: 10.0.0.1:12347
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3388 name: 10.0.0.1:12347
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3389 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3390 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3391 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3392 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3393 max_conns: 30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3394 connections: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3395 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3396 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3397 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3398 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3399 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3400 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3401 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3402 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3403 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3404 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3405 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3406 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3407 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3408 server: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3409 name: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3410 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3411 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3412 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3413 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3414 connections: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3415 max_conns: 30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3416 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3417 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3418 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3419 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3420 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3421 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3422 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3423 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3424 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3425 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3426 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3427 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3428 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3429 zone: dns
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3430 NginxStreamUpstream:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3431 title: Stream Upstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3432 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3433 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3434 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3435 $ref: '#/definitions/NginxStreamUpstreamPeerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3436 zombies:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3437 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3438 description: The current number of servers removed from the group
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3439 but still processing active client connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3440 zone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3441 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3442 description: The name of the shared memory
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3443 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#zone">zone</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3444 that keeps the group’s configuration and run-time state.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3445 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3446 dns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3447 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3448 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3449 server: 10.0.0.1:12347
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3450 name: 10.0.0.1:12347
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3451 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3452 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3453 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3454 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3455 max_conns: 50
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3456 connections: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3457 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3458 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3459 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3460 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3461 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3462 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3463 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3464 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3465 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3466 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3467 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3468 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3469 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3470 server: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3471 name: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3472 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3473 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3474 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3475 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3476 max_conns: 50
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3477 connections: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3478 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3479 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3480 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3481 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3482 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3483 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3484 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3485 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3486 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3487 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3488 downstart: 2019-10-01T11:09:21.602Z
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3489 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3490 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3491 zone: dns
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3492 NginxStreamUpstreamPeerMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3493 title: Stream Upstream Servers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3494 description: Array of stream upstream servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3495 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3496 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3497 $ref: '#/definitions/NginxStreamUpstreamPeer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3498 NginxStreamUpstreamPeer:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3499 title: Stream Upstream Server
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3500 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3501 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3502 id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3503 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3504 description: The ID of the server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3505 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3506 server:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3507 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3508 description: An
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3509 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3510 of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3511 service:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3512 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3513 description: The
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3514 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3515 parameter value of the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3516 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3517 directive.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3518 name:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3519 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3520 format: hostname
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3521 description: The name of the server specified in the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3522 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3523 directive.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3524 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3525 backup:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3526 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3527 description: A boolean value indicating whether the server is a
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3528 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3529 server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3530 weight:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3531 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3532 description: <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">Weight</a>
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3533 of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3534 state:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3535 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3536 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3537 enum:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3538 - up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3539 - down
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3540 - unavail
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3541 - checking
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3542 - unhealthy
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3543 description: Current state, which may be one of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3544 “<code>up</code>”, “<code>down</code>”, “<code>unavail</code>”,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3545 “<code>checking</code>”, or “<code>unhealthy</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3546 active:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3547 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3548 description: The current number of connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3549 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3550 max_conns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3551 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3552 description: The
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3553 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3554 limit for the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3555 connections:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3556 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3557 description: The total number of client connections forwarded to this server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3558 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3559 connect_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3560 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3561 description: The average time to connect to the upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3562 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3563 first_byte_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3564 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3565 description: The average time to receive the first byte of data.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3566 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3567 response_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3568 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3569 description: The average time to receive the last byte of data.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3570 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3571 sent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3572 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3573 description: The total number of bytes sent to this server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3574 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3575 received:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3576 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3577 description: The total number of bytes received from this server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3578 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3579 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3580 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3581 description: The total number of unsuccessful attempts
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3582 to communicate with the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3583 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3584 unavail:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3585 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3586 description: How many times the server became unavailable for client connections
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3587 (state “<code>unavail</code>”) due to the number of unsuccessful
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3588 attempts reaching the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3589 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3590 threshold.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3591 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3592 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3593 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3594 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3595 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3596 checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3597 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3598 description: The total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3599 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#health_check">health check</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3600 requests made.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3601 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3602 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3603 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3604 description: The number of failed health checks.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3605 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3606 unhealthy:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3607 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3608 description: How many times the server became unhealthy
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3609 (state “<code>unhealthy</code>”).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3610 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3611 last_passed:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3612 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3613 description: Boolean indicating whether the last health check request
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3614 was successful and passed
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3615 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#match">tests</a>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3616 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3617 downtime:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3618 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3619 description: Total time the server was in the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3620 “<code>unavail</code>”, “<code>checking</code>”,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3621 and “<code>unhealthy</code>” states.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3622 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3623 downstart:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3624 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3625 format: date-time
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3626 description: The time when the server became
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3627 “<code>unavail</code>”, “<code>checking</code>”,
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3628 or “<code>unhealthy</code>”,
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3629 in the ISO 8601 format with millisecond resolution.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3630 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3631 selected:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3632 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3633 format: date-time
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3634 description: The time when the server was last selected
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3635 to process a connection,
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3636 in the ISO 8601 format with millisecond resolution.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3637 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3638 NginxStreamUpstreamConfServerMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3639 title: Stream Upstream Servers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3640 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3641 An array of stream upstream servers for dynamic configuration.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3642 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3643 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3644 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3645 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3646 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3647 server: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3648 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3649 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3650 max_fails: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3651 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3652 slow_start: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3653 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3654 down: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3655 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3656 server: 10.0.0.1:12349
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3657 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3658 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3659 max_fails: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3660 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3661 slow_start: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3662 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3663 down: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3664 NginxStreamUpstreamConfServer:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3665 title: Stream Upstream Server
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3666 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3667 Dynamically configurable parameters of a stream upstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3668 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3669 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3670 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3671 id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3672 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3673 description: The ID of the stream upstream server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3674 The ID is assigned automatically and cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3675 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3676 server:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3677 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3678 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3679 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3680 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3681 When adding a server, it is possible to specify it as a domain name.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3682 In this case, changes of the IP addresses
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3683 that correspond to a domain name will be monitored and automatically
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3684 applied to the upstream configuration
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3685 without the need of restarting nginx.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3686 This requires the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3687 <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#resolver">resolver</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3688 directive in the “<code>stream</code>” block.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3689 See also the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3690 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#resolve">resolve</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3691 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3692 service:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3693 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3694 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3695 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3696 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3697 This parameter cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3698 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3699 weight:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3700 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3701 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3702 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">weight</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3703 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3704 max_conns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3705 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3706 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3707 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3708 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3709 max_fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3710 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3711 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3712 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3713 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3714 fail_timeout:
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3715 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3716 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3717 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#fail_timeout">fail_timeout</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3718 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3719 slow_start:
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3720 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3721 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3722 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#slow_start">slow_start</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3723 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3724 backup:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3725 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3726 description: When <code>true</code>, adds a
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3727 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3728 server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3729 This parameter cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3730 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3731 down:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3732 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3733 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3734 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#down">down</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3735 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3736 parent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3737 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3738 description: Parent server ID of the resolved server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3739 The ID is assigned automatically and cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3740 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3741 host:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3742 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3743 description: Hostname of the resolved server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3744 The hostname is assigned automatically and cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3745 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3746 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3747 id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3748 server: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3749 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3750 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3751 max_fails: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3752 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3753 slow_start: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3754 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3755 down: false
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3756 NginxStreamKeyvalZonesMap:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3757 title: Stream Keyval Shared Memory Zones
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3758 description: \|
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3759 Contents of all stream keyval shared memory zones.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3760 type: object
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3761 additionalProperties:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3762 $ref: '#/definitions/NginxStreamKeyvalZone'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3763 example:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3764 keyval_zone:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3765 key1: value1
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3766 key2: value2
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3767 key3: value3
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3768 one:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3769 arg1: value1
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3770 arg2: value2
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3771 arg3: value3
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3772 NginxStreamKeyvalZone:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3773 title: Stream Keyval Shared Memory Zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3774 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3775 Contents of a stream keyval shared memory zone when using the GET method.
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3776 type: object
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3777 example:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3778 key1: value1
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3779 key2: value2
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3780 key3: value3
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3781 NginxStreamKeyvalZonePostPatch:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3782 title: Stream Keyval Shared Memory Zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3783 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3784 Contents of a stream keyval shared memory zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3785 when using the POST or PATCH methods.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3786 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3787 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3788 key1: value1
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3789 key2: value2
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3790 key3:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3791 value: value3
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3792 expire: 30000
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3793 NginxStreamZoneSync:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3794 title: Stream Zone Sync Node
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3795 type: object
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3796 properties:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3797 zones:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3798 type: object
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3799 title: Zone Sync Zones
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3800 description: Synchronization information per each shared memory zone.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3801 additionalProperties:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3802 $ref: '#/definitions/NginxStreamZoneSyncZone'
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3803 status:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3804 type: object
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3805 description: Synchronization information per node in a cluster.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3806 properties:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3807 bytes_in:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3808 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3809 description: The number of bytes received by this node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3810 msgs_in:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3811 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3812 description: The number of messages received by this node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3813 msgs_out:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3814 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3815 description: The number of messages sent by this node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3816 bytes_out:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3817 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3818 description: The number of bytes sent by this node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3819 nodes_online:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3820 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3821 description: The number of peers this node is connected to.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3822 example:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3823 zones:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3824 zone1:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3825 records_pending: 2061
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3826 records_total: 260575
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3827 zone2:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3828 records_pending: 0
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3829 records_total: 14749
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3830 status:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3831 bytes_in: 1364923761
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3832 msgs_in: 337236
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3833 msgs_out: 346717
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3834 bytes_out: 1402765472
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3835 nodes_online: 15
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3836 NginxStreamZoneSyncZone:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3837 title: Sync Zone
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3838 description: Synchronization status of a shared memory zone.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3839 type: object
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3840 properties:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3841 records_pending:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3842 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3843 description: The number of records that need to be sent to the cluster.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3844 records_total:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3845 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3846 description: The total number of records stored in the shared memory zone.
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3847 NginxResolverZonesMap:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3848 title: Resolver Zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3849 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3850 Status data for all
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3851 <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zones</a>.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3852 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3853 additionalProperties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3854 $ref: '#/definitions/NginxResolverZone'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3855 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3856 resolver_zone1:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3857 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3858 name: 25460
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3859 srv: 130
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3860 addr: 2580
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3861 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3862 noerror: 26499
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3863 formerr: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3864 servfail: 3
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3865 nxdomain: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3866 notimp: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3867 refused: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3868 timedout: 243
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3869 unknown: 478
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3870 resolver_zone2:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3871 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3872 name: 325460
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3873 srv: 1130
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3874 addr: 12580
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3875 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3876 noerror: 226499
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3877 formerr: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3878 servfail: 283
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3879 nxdomain: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3880 notimp: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3881 refused: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3882 timedout: 743
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3883 unknown: 1478
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3884 NginxResolverZone:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3885 title: Resolver Zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3886 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3887 Statistics of DNS requests and responses per particular
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3888 <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</a>.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3889 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3890 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3891 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3892 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3893 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3894 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3895 name:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3896 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3897 description: The total number of requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3898 to resolve names to addresses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3899 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3900 srv:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3901 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3902 description: The total number of requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3903 to resolve SRV records.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3904 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3905 addr:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3906 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3907 description: The total number of requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3908 to resolve addresses to names.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3909 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3910 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3911 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3912 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3913 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3914 noerror:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3915 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3916 description: The total number of successful responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3917 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3918 formerr:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3919 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3920 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3921 FORMERR (<literal>Format error</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3922 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3923 servfail:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3924 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3925 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3926 SERVFAIL (<literal>Server failure</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3927 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3928 nxdomain:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3929 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3930 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3931 NXDOMAIN (<literal>Host not found</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3932 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3933 notimp:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3934 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3935 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3936 NOTIMP (<literal>Unimplemented</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3937 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3938 refused:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3939 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3940 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3941 REFUSED (<literal>Operation refused</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3942 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3943 timedout:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3944 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3945 description: The total number of timed out requests.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3946 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3947 unknown:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3948 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3949 description: The total number of requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3950 completed with an unknown error.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3951 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3952 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3953 resolver_zone1:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3954 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3955 name: 25460
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3956 srv: 130
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3957 addr: 2580
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3958 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3959 noerror: 26499
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3960 formerr: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3961 servfail: 3
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3962 nxdomain: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3963 notimp: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3964 refused: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3965 timedout: 243
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3966 unknown: 478
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3967 NginxError:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3968 title: Error
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3969 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3970 nginx error object.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3971 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3972 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3973 error:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3974 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3975 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3976 status:
2132 a645aa9f2ebf Changed type of HTTP error code to integer in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2082 diff changeset	3977 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3978 description: HTTP error code.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3979 text:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3980 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3981 description: Error description.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3982 code:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3983 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3984 description: Internal nginx error code.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3985 request_id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3986 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3987 description: The ID of the request, equals the value of the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3988 <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3989 variable.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3990 href:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3991 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3992 description: Link to reference documentation.

Mercurial > hg > nginx-site

annotate yaml/nginx_api.yaml @ 2494:78d4e25adf49