nginx-site: yaml/nginx_api.yaml annotate

annotate yaml/nginx_api.yaml @ 2493:407147d8020f

Documented 413 error for PATCH and POST methods in the API.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Thu, 19 Dec 2019 16:29:20 +0300
parents	98fd810c13e0
children	78d4e25adf49

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),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	779 route is too long (UpstreamBadRoute),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	780 “service” is empty (UpstreamBadService),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	781 no resolver defined to resolve (UpstreamConfNoResolver),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	782 upstream “name” has no backup (UpstreamNoBackup),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	783 upstream “name” memory exhausted (UpstreamOutOfMemory)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	784 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	785 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	786 '404':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	787 description: Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	788 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	790 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	791 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	792 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	793 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	794 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	795 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	796 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	797 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	798 '/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	799 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	800 - name: httpUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	801 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	802 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	803 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	804 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	805 - name: httpUpstreamServerId
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	806 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	807 description: The ID of the server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	808 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	809 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	810 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	811 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	812 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	813 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	814 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	815 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	816 in the HTTP upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	817 operationId: getHttpUpstreamPeer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	818 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	819 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	820 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	821 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	822 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	823 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	824 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	825 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	826 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	827 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	828 invalid server ID (UpstreamBadServerId)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	829 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	830 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	831 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	832 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	833 Upstream not found (UpstreamNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	834 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	835 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	836 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	837 patch:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	838 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	839 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	840 - Method PATCH
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	841 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	842 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	843 in an HTTP upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	844 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	845 operationId: patchHttpUpstreamPeer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	846 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	847 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	848 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	849 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	850 name: patchHttpUpstreamServer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	851 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	852 The “ID”, “backup”, and “service” parameters
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	853 cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	854 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	855 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	856 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	857 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	858 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	859 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	860 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	861 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	862 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	863 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	864 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	865 invalid “parameter” value (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	866 unknown parameter “name” (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	867 nested object or list (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	868 “error” while parsing (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	869 invalid “server” argument (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	870 invalid server ID (UpstreamBadServerId),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	871 invalid “weight” (UpstreamBadWeight),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	872 invalid “max_conns” (UpstreamBadMaxConns),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	873 invalid “max_fails” (UpstreamBadMaxFails),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	874 invalid “fail_timeout” (UpstreamBadFailTimeout),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	875 invalid “slow_start” (UpstreamBadSlowStart),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	876 route is too long (UpstreamBadRoute),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	877 “service” is empty (UpstreamBadService),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	878 server “ID” address is immutable (UpstreamServerImmutable),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	879 server “ID” weight is immutable (UpstreamServerWeightImmutable),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	880 upstream “name” memory exhausted (UpstreamOutOfMemory)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	881 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	882 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	883 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	884 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	885 Upstream not found (UpstreamNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	886 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	887 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	888 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	889 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	890 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	891 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	892 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	893 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	894 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	895 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	896 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	897 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	898 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	899 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	900 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	901 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	902 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	903 operationId: deleteHttpUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	904 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	905 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	906 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	907 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	908 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	909 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	910 $ref: '#/definitions/NginxHTTPUpstreamConfServerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	911 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	912 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	913 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	914 invalid server ID (UpstreamBadServerId),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	915 server “id” not removable (UpstreamServerImmutable)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	916 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	917 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	918 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	919 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	920 Upstream not found (UpstreamNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	921 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	922 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	923 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	924 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	925 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	926 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	927 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	928 /http/keyvals/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	929 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	930 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	931 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	932 - Method GET
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	933 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	934 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	935 [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	936 operationId: getHttpKeyvalZones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	937 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	938 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	939 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	940 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	941 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	942 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	943 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	944 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	945 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	946 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	947 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	948 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	949 $ref: '#/definitions/NginxHTTPKeyvalZonesMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	950 '/http/keyvals/{httpKeyvalZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	951 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	952 - name: httpKeyvalZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	953 in: path
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	954 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	955 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	956 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	957 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	958 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	959 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	960 - Method GET
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	961 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	962 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	963 [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	964 operationId: getHttpKeyvalZoneKeysValues
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	965 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	966 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	967 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	968 - name: key
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	969 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	970 type: string
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	971 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	972 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	973 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	974 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	975 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	976 $ref: '#/definitions/NginxHTTPKeyvalZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	977 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	978 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979 Keyval not found (KeyvalNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	980 keyval key not found (KeyvalKeyNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	981 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	982 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	983 post:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	985 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	986 - Method POST
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	987 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	988 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	989 [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	990 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	991 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	992 operationId: postHttpKeyvalZoneData
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	993 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	994 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	995 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	996 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	997 name: Key-value
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	998 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	999 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	1000 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	1001 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	1002 with the expire parameter
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1003 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	1004 parameter of the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1005 <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	1006 directive.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1007 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1008 schema:
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1009 $ref: '#/definitions/NginxHTTPKeyvalZonePostPatch'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1010 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1011 '201':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1012 description: Created
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1013 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1014 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1015 Invalid JSON (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1016 invalid key format (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1017 key required (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1018 keyval timeout is not enabled (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1019 only one key can be added (KeyvalFormatError)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1020 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1021 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1022 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1023 description: Keyval not found (KeyvalNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1024 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1025 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1026 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1027 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1028 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1029 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1030 '409':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1031 description: Key already exists (KeyvalKeyExists)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1032 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1033 $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	1034 '413':
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1035 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	1036 schema:
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1037 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1038 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1039 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1040 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1041 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1042 patch:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1043 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1044 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1045 - Method PATCH
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1046 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	1047 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	1048 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	1049 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	1050 If
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1051 <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	1052 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	1053 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	1054 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	1055 with the expire parameter
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1056 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	1057 parameter of the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1058 <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	1059 directive.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1060 operationId: patchHttpKeyvalZoneKeyValue
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1061 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1062 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1063 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1064 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1065 name: httpKeyvalZoneKeyValue
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1066 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	1067 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1068 schema:
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1069 $ref: '#/definitions/NginxHTTPKeyvalZonePostPatch'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1070 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1071 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1072 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1073 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1074 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1075 Invalid JSON (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1076 key required (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1077 keyval timeout is not enabled (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1078 only one key can be updated (KeyvalFormatError)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1079 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1080 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1081 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1082 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1083 Keyval not found (KeyvalNotFound),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1084 keyval key not found (KeyvalKeyNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1085 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1086 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1087 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1088 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1089 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1090 $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	1091 '413':
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1092 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	1093 schema:
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1094 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1095 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1096 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1097 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1098 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1099 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1100 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1101 - HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1102 - Method DELETE
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1103 summary: Empty the HTTP keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1104 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	1105 [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	1106 If
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1107 <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	1108 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	1109 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	1110 operationId: deleteHttpKeyvalZoneData
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1111 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1112 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1113 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1114 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1115 description: Keyval not found (KeyvalNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1117 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1118 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1119 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1120 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1121 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1122 /stream/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1123 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1124 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1125 - Stream
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1126 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	1127 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	1128 operationId: getStream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1129 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1130 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1131 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1132 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1133 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1134 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1135 $ref: '#/definitions/ArrayOfStrings'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1136 /stream/server_zones/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1137 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1138 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1139 - Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1140 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1141 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	1142 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	1143 [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	1144 operationId: getStreamServerZones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1145 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1146 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1147 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1148 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1149 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1150 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1151 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	1152 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	1153 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	1154 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1155 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1156 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1157 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1158 $ref: '#/definitions/NginxStreamServerZonesMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1159 '/stream/server_zones/{streamServerZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1160 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1161 - name: streamServerZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1162 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1163 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	1164 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1165 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1166 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1167 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1168 - Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1169 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1170 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	1171 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	1172 operationId: getStreamServerZone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1173 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1174 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1175 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1176 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1177 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1178 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1179 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	1180 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1181 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1182 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1183 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1184 $ref: '#/definitions/NginxStreamServerZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1185 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1186 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1187 Server zone not found (ServerZoneNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1188 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1189 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1190 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1191 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1192 - Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1193 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1194 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	1195 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	1196 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	1197 operationId: deleteStreamServerZoneStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1198 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1199 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1200 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1201 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1202 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1203 Server zone not found (ServerZoneNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1204 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1205 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1206 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1207 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1208 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1209 $ref: '#/definitions/NginxError'
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1210 /stream/limit_conns/:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1211 get:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1212 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1213 - Stream Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1214 - Method GET
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1215 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	1216 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	1217 [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	1218 operationId: getStreamLimitConnZones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1219 produces:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1220 - application/json
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1221 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1222 - in: query
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1223 name: fields
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1224 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1225 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	1226 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	1227 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	1228 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1229 '200':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1230 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1231 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1232 $ref: '#/definitions/NginxStreamLimitConnZonesMap'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1233 '/stream/limit_conns/{streamLimitConnZoneName}':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1234 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1235 - name: streamLimitConnZoneName
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1236 in: path
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1237 description: The name of a
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1238 [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	1239 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1240 required: true
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1241 get:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1242 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1243 - Stream Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1244 - Method GET
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1245 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	1246 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	1247 [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	1248 operationId: getStreamLimitConnZone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1249 produces:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1250 - application/json
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1251 parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1252 - name: fields
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1253 in: query
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1254 type: string
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1255 description: Limits which fields of the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1256 [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	1257 will be output.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1258 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1259 '200':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1260 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1261 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1262 $ref: '#/definitions/NginxStreamLimitConnZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1263 '404':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1264 description: limit_conn not found (LimitConnNotFound)
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/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1267 delete:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1268 tags:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1269 - Stream Limit Conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1270 - Method DELETE
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1271 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	1272 description: Resets the connection limiting statistics.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1273 operationId: deleteStreamLimitConnZoneStat
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1274 responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1275 '204':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1276 description: Success
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1277 '404':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1278 description: limit_conn not found (LimitConnNotFound)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1279 schema:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1280 $ref: '#/definitions/NginxError'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1281 '405':
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1282 description: Method disabled (MethodDisabled)
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'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1285 /stream/upstreams/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1286 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1287 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1288 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1289 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1290 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	1291 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	1292 and its servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1293 operationId: getStreamUpstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1294 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1295 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1296 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1297 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1298 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1299 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1300 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	1301 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	1302 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	1303 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1304 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1305 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1306 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1307 $ref: '#/definitions/NginxStreamUpstreamMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1308 '/stream/upstreams/{streamUpstreamName}/':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1309 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1310 - name: streamUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1311 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1312 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	1313 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1314 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1315 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1316 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1317 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1318 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1319 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	1320 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	1321 and its servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1322 operationId: getStreamUpstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1323 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1324 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1325 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1326 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1327 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1328 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1329 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	1330 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1331 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1332 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1333 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1334 $ref: '#/definitions/NginxStreamUpstream'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1335 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1336 description: Upstream is static (UpstreamStatic)
2028 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/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1339 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1340 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1341 Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1342 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1343 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1344 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1345 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1346 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1347 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1348 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	1349 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	1350 in an upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1351 operationId: deleteStreamUpstreamStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1352 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1353 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1354 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1355 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1356 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1357 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1358 description: Upstream is static (UpstreamStatic)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1359 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1360 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1361 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1362 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1363 Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1364 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1365 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1366 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1367 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1368 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1369 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1370 '/stream/upstreams/{streamUpstreamName}/servers/':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1371 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1372 - name: streamUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1373 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1374 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	1375 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1376 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1377 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1378 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1379 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1380 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1381 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	1382 description: Returns configuration of each server
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1383 in a particular stream upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1384 operationId: getStreamUpstreamServers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1385 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1386 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1387 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1388 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1389 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1390 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1391 $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1392 '400':
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1393 description: Upstream is static (UpstreamStatic)
2028 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/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1396 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1397 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1398 Upstream not found (UpstreamNotFound)
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1399 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1400 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1401 post:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1402 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1403 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1404 - Method POST
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1405 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	1406 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	1407 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	1408 operationId: postStreamUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1409 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1410 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1411 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1412 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1413 name: postStreamUpstreamServer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1414 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	1415 in the JSON format.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1416 The “ID”, “backup”, and “service” parameters
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1417 cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1418 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1419 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1420 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1421 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1422 '201':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1423 description: Created
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1424 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1425 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1426 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1427 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1428 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1429 invalid “parameter” value (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1430 missing “server” argument (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1431 unknown parameter “name” (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1432 nested object or list (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1433 “error” while parsing (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1434 no port in server “host” (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1435 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	1436 service upstream “host” requires domain name (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1437 invalid “weight” (UpstreamBadWeight),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1438 invalid “max_conns” (UpstreamBadMaxConns),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1439 invalid “max_fails” (UpstreamBadMaxFails),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1440 invalid “fail_timeout” (UpstreamBadFailTimeout),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1441 invalid “slow_start” (UpstreamBadSlowStart),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1442 “service” is empty (UpstreamBadService),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1443 no resolver defined to resolve (UpstreamConfNoResolver),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1444 upstream “name” has no backup (UpstreamNoBackup),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1445 upstream “name” memory exhausted (UpstreamOutOfMemory)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1446 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1447 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1448 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1449 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1450 Upstream not found (UpstreamNotFound)
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'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1453 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1454 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1455 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1456 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1457 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1458 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1459 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1460 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1461 '/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1462 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1463 - name: streamUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1464 in: path
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1465 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	1466 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1467 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1468 - name: streamUpstreamServerId
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 ID of the server.
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 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1474 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1475 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1476 - Method GET
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1477 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	1478 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	1479 in the stream upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1480 operationId: getStreamUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1481 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1482 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1483 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1484 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1485 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1486 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1487 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1488 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1489 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1490 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1491 invalid server ID (UpstreamBadServerId)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1492 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1493 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1494 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1495 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1496 Upstream not found (UpstreamNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1497 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	1498 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1499 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1500 patch:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1501 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1502 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1503 - Method PATCH
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1504 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	1505 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	1506 in a stream upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1507 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	1508 operationId: patchStreamUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1509 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1510 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1511 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1512 - in: body
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1513 name: patchStreamUpstreamServer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1514 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	1515 The “ID”, “backup”, and “service” parameters
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1516 cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1517 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1518 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1519 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1520 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1521 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1522 description: Success
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 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1526 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1527 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1528 invalid “parameter” value (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1529 unknown parameter “name” (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1530 nested object or list (UpstreamConfFormatError),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1531 “error” while parsing (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1532 invalid “server” argument (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1533 no port in server “host” (UpstreamBadAddress),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1534 invalid server ID (UpstreamBadServerId),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1535 invalid “weight” (UpstreamBadWeight),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1536 invalid “max_conns” (UpstreamBadMaxConns),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1537 invalid “max_fails” (UpstreamBadMaxFails),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1538 invalid “fail_timeout” (UpstreamBadFailTimeout),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1539 invalid “slow_start” (UpstreamBadSlowStart),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1540 “service” is empty (UpstreamBadService),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1541 server “ID” address is immutable (UpstreamServerImmutable),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1542 server “ID” weight is immutable (UpstreamServerWeightImmutable),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1543 upstream “name” memory exhausted (UpstreamOutOfMemory)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1544 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1545 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1546 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1547 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1548 Upstream not found (UpstreamNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1549 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	1550 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1551 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1552 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1553 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1554 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1555 $ref: '#/definitions/NginxError'
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1556 '415':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1557 description: JSON error (JsonError)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1558 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1559 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1560 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1561 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1562 - Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1563 - Method DELETE
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1564 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	1565 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	1566 operationId: deleteStreamUpstreamServer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1567 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1568 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1569 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1570 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1571 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1572 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1573 $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1574 '400':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1575 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1576 Upstream is static (UpstreamStatic),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1577 invalid server ID (UpstreamBadServerId),
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1578 server “id” not removable (UpstreamServerImmutable)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1579 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1580 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1581 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1582 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1583 Upstream not found (UpstreamNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1584 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	1585 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1586 $ref: '#/definitions/NginxError'
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1587 '405':
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1588 description: Method disabled (MethodDisabled)
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1589 schema:
593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	1590 $ref: '#/definitions/NginxError'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1591 /stream/keyvals/:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1592 get:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1593 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1594 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1595 - Method GET
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1596 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	1597 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	1598 [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	1599 operationId: getStreamKeyvalZones
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1600 produces:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1601 - application/json
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1602 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1603 - name: fields
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1604 in: query
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1605 type: string
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1606 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	1607 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	1608 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1609 '200':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1610 description: Success
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1611 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1612 $ref: '#/definitions/NginxStreamKeyvalZonesMap'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1613 '/stream/keyvals/{streamKeyvalZoneName}':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1614 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1615 - name: streamKeyvalZoneName
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1616 in: path
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1617 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	1618 required: true
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1619 type: string
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1620 get:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1621 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1622 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1623 - Method GET
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1624 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	1625 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	1626 [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	1627 operationId: getStreamKeyvalZoneKeysValues
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1628 produces:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1629 - application/json
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1630 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1631 - name: key
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1632 in: query
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1633 type: string
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1634 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	1635 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1636 '200':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1637 description: Success
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1638 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1639 $ref: '#/definitions/NginxStreamKeyvalZone'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1640 '404':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1641 description: \|
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1642 Keyval not found (KeyvalNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1643 keyval key not found (KeyvalKeyNotFound)
2082 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/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1646 post:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1647 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1648 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1649 - Method POST
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1650 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	1651 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	1652 [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	1653 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	1654 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	1655 operationId: postStreamKeyvalZoneData
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1656 produces:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1657 - application/json
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1658 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1659 - in: body
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1660 name: Key-value
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1661 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	1662 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	1663 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	1664 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	1665 with the expire parameter
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1666 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	1667 parameter of the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1668 <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	1669 directive.
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1670 required: true
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1671 schema:
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1672 $ref: '#/definitions/NginxStreamKeyvalZonePostPatch'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1673 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1674 '201':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1675 description: Created
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1676 '400':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1677 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1678 Invalid JSON (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1679 invalid key format (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1680 key required (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1681 keyval timeout is not enabled (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1682 only one key can be added (KeyvalFormatError)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1683 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1684 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1685 '404':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1686 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1687 Keyval not found (KeyvalNotFound)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1688 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1689 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1690 '405':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1691 description: Method disabled (MethodDisabled)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1692 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1693 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1694 '409':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1695 description: Key already exists (KeyvalKeyExists)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1696 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1697 $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	1698 '413':
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1699 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	1700 schema:
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1701 $ref: '#/definitions/NginxError'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1702 '415':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1703 description: JSON error (JsonError)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1704 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1705 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1706 patch:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1707 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1708 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1709 - Method PATCH
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1710 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	1711 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	1712 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	1713 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	1714 If
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1715 <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	1716 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	1717 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	1718 Expiration time is specified in milliseconds
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1719 with the expire parameter
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1720 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	1721 parameter of the
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1722 <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	1723 directive.
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1724 operationId: patchStreamKeyvalZoneKeyValue
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1725 produces:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1726 - application/json
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1727 parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1728 - in: body
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1729 name: streamKeyvalZoneKeyValue
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1730 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	1731 required: true
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1732 schema:
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1733 $ref: '#/definitions/NginxStreamKeyvalZonePostPatch'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1734 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1735 '204':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1736 description: Success
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1737 '400':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1738 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1739 Invalid JSON (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1740 key required (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1741 keyval timeout is not enabled (KeyvalFormatError),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1742 only one key can be updated (KeyvalFormatError)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1743 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1744 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1745 '404':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1746 description: \|
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1747 Keyval not found (KeyvalNotFound),
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1748 keyval key not found (KeyvalKeyNotFound)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1749 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1750 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1751 '405':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1752 description: Method disabled (MethodDisabled)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1753 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1754 $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	1755 '413':
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1756 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	1757 schema:
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	1758 $ref: '#/definitions/NginxError'
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1759 '415':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1760 description: JSON error (JsonError)
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'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1763 delete:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1764 tags:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1765 - Stream Keyvals
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1766 - Method DELETE
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1767 summary: Empty the stream keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1768 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	1769 [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	1770 If
bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1771 <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	1772 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	1773 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	1774 operationId: deleteStreamKeyvalZoneData
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1775 responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1776 '204':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1777 description: Success
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1778 '404':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1779 description: \|
2364 bb7e58ea3559 Updated yaml api spec for NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2253 diff changeset	1780 Keyval not found (KeyvalNotFound)
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1781 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1782 $ref: '#/definitions/NginxError'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1783 '405':
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1784 description: Method disabled (MethodDisabled)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1785 schema:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1786 $ref: '#/definitions/NginxError'
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1787 /stream/zone_sync/:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1788 get:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1789 tags:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1790 - Stream Zone Sync
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1791 - Method GET
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1792 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	1793 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	1794 operationId: getStreamZoneSync
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1795 produces:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1796 - application/json
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1797 responses:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1798 '200':
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1799 description: Success
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1800 schema:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1801 $ref: '#/definitions/NginxStreamZoneSync'
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1802 /resolvers/:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1803 get:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1804 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1805 - Resolvers
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1806 - Method GET
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1807 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	1808 description: Returns status information for each
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1809 [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	1810 operationId: getResolverZones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1811 produces:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1812 - application/json
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1813 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1814 '200':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1815 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1816 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1817 $ref: '#/definitions/NginxResolverZonesMap'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1818 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1819 - in: query
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1820 name: fields
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1821 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1822 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	1823 '/resolvers/{resolverZoneName}':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1824 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1825 - name: resolverZoneName
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1826 in: path
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1827 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	1828 required: true
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 get:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1831 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1832 - Resolvers
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1833 - Method GET
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1834 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	1835 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	1836 [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	1837 operationId: getResolverZone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1838 produces:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1839 - application/json
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1840 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1841 - name: fields
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1842 in: query
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1843 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1844 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	1845 (requests, responses, or both).
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1846 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1847 '200':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1848 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1849 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1850 $ref: '#/definitions/NginxResolverZone'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1851 '404':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1852 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1853 Resolver zone not found (ResolverZoneNotFound)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1854 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1855 $ref: '#/definitions/NginxError'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1856 delete:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1857 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1858 - Resolvers
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1859 - Method DELETE
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1860 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	1861 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	1862 operationId: deleteResolverZoneStat
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1863 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1864 '204':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1865 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1866 '404':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1867 description: Resolver zone not found (ResolverZoneNotFound)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1868 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1869 $ref: '#/definitions/NginxError'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1870 '405':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1871 description: Method disabled (MethodDisabled)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1872 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1873 $ref: '#/definitions/NginxError'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1874 /ssl:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1875 get:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1876 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1877 - SSL
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1878 - Method GET
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1879 summary: Return SSL statistics
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1880 description: Returns SSL statistics.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1881 operationId: getSsl
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1882 produces:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1883 - application/json
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1884 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1885 '200':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1886 description: Success
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1887 schema:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1888 $ref: '#/definitions/NginxSSLObject'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1889 parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1890 - in: query
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1891 name: fields
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1892 type: string
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1893 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	1894 delete:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1895 tags:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1896 - SSL
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1897 - Method DELETE
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1898 summary: Reset SSL statistics
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1899 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	1900 operationId: deleteSslStat
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1901 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1902 '204':
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	1903 description: Success
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1904 ###
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1905 ###DEFINITIONS
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1906 ###
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1907 definitions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1908 ArrayOfStrings:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1909 title: Array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1910 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1911 An array of strings.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1912 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1913 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1914 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1915 NginxObject:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1916 title: nginx
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1917 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1918 General information about nginx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1919 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1920 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1921 version:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1922 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1923 description: Version of nginx.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1924 build:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1925 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1926 description: Name of nginx build.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1927 address:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1928 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1929 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	1930 generation:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1931 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1932 description: The total number of configuration
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1933 <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	1934 load_timestamp:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1935 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1936 format: date-time
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1937 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	1938 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	1939 timestamp:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1940 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1941 format: date-time
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1942 description: Current time
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1943 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	1944 pid:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1945 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1946 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	1947 ppid:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1948 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1949 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	1950 <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	1951 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1952 nginx:
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1953 version: 1.17.3
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1954 build: nginx-plus-r19
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1955 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	1956 generation: 6
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1957 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	1958 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	1959 pid: 32212
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1960 ppid: 32210
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1961 NginxProcesses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1962 title: Processes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1963 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1964 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1965 respawned:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1966 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1967 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	1968 and respawned child processes.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1969 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1970 respawned: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1971 NginxConnections:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1972 title: Connections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1973 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1974 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	1975 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1976 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1977 accepted:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1978 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1979 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	1980 dropped:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1981 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1982 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	1983 active:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1984 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1985 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	1986 idle:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1987 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	1988 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	1989 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1990 accepted: 4968119
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1991 dropped: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1992 active: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1993 idle: 117
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1994 NginxSSLObject:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1995 title: SSL
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1996 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1997 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1998 handshakes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1999 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2000 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	2001 handshakes_failed:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2002 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2003 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	2004 session_reuses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2005 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2006 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	2007 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2008 handshakes: 79572
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2009 handshakes_failed: 21025
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2010 session_reuses: 15762
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2011 NginxSlabZoneMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2012 title: Slab Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2013 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2014 Status zones that use slab allocator.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2015 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2016 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2017 $ref: '#/definitions/NginxSlabZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2018 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2019 http_cache:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2020 pages:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2021 used: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2022 free: 2452
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2023 slots:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2024 8:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2025 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2026 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2027 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2028 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2029 16:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2030 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2031 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2032 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2033 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2034 32:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2035 used: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2036 free: 126
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2037 reqs: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2038 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2039 64:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2040 used: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2041 free: 62
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2042 reqs: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2043 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2044 128:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2045 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2046 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2047 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2048 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2049 dns-backends:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2050 pages:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2051 used: 1143
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2052 free: 2928
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2053 slots:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2054 8:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2055 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2056 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2057 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2058 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2059 16:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2060 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2061 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2062 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2063 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2064 32:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2065 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2066 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2067 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2068 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2069 64:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2070 used: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2071 free: 63
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2072 reqs: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2073 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2074 128:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2075 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2076 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2077 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2078 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2079 256:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2080 used: 18078
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2081 free: 178
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2082 reqs: 1635736
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2083 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2084 NginxSlabZone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2085 title: Shared memory zone with slab allocator
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2086 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2087 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2088 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2089 pages:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2090 type: object
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2091 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	2092 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2093 used:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2094 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2095 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	2096 free:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2097 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2098 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	2099 slots:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2100 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2101 title: Memory Slots
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2102 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	2103 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2104 $ref: '#/definitions/NginxSlabZoneSlot'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2105 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2106 pages:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2107 used: 1143
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2108 free: 2928
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2109 slots:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2110 8:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2111 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2112 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2113 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2114 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2115 16:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2116 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2117 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2118 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2119 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2120 32:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2121 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2122 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2123 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2124 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2125 64:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2126 used: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2127 free: 63
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2128 reqs: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2129 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2130 128:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2131 used: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2132 free: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2133 reqs: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2134 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2135 256:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2136 used: 18078
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2137 free: 178
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2138 reqs: 1635736
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2139 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2140 NginxSlabZoneSlot:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2141 title: Memory Slot
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2142 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2143 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2144 used:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2145 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2146 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	2147 free:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2148 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2149 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	2150 reqs:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2151 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2152 description: The total number of attempts
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2153 to allocate memory of specified size.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2154 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2155 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2156 description: The number of unsuccessful attempts
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2157 to allocate memory of specified size.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2158 NginxHTTPRequests:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2159 title: HTTP Requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2160 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2161 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2162 total:
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 total number of client requests.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2165 current:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2166 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2167 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	2168 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2169 total: 10624511
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2170 current: 4
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2171 NginxHTTPServerZonesMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2172 title: HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2173 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2174 Status data for all HTTP
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	2175 <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	2176 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2177 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2178 $ref: '#/definitions/NginxHTTPServerZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2179 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2180 site1:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2181 processing: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2182 requests: 736395
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2183 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2184 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2185 2xx: 727290
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2186 3xx: 4614
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2187 4xx: 934
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2188 5xx: 1535
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2189 total: 734373
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2190 discarded: 2020
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2191 received: 180157219
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2192 sent: 20183175459
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2193 site2:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2194 processing: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2195 requests: 185307
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2196 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2197 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2198 2xx: 112674
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2199 3xx: 45383
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2200 4xx: 2504
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2201 5xx: 4419
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2202 total: 164980
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2203 discarded: 20326
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2204 received: 51575327
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2205 sent: 2983241510
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2206 NginxHTTPServerZone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2207 title: HTTP Server Zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2208 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2209 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2210 processing:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2211 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2212 description: The number of client requests
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2213 that are currently being processed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2214 requests:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2215 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2216 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	2217 responses:
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2218 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	2219 number of responses with status codes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2220 “<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	2221 “<code>4xx</code>”, and “<code>5xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2222 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2223 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2224 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2225 1xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2226 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2227 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	2228 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2229 2xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2230 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2231 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	2232 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2233 3xx:
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>3xx</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 4xx:
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>4xx</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 5xx:
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>5xx</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 total:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2246 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2247 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	2248 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2249 discarded:
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 total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2252 requests completed without sending a response.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2253 received:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2254 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2255 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	2256 sent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2257 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2258 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	2259 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2260 processing: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2261 requests: 706690
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2262 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2263 1xx: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2264 2xx: 699482
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2265 3xx: 4522
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2266 4xx: 907
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2267 5xx: 266
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2268 total: 705177
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2269 discarded: 1513
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2270 received: 172711587
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2271 sent: 19415530115
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2272 NginxHTTPLocationZonesMap:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2273 title: HTTP Location Zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2274 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2275 Status data for all HTTP
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2276 <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	2277 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2278 additionalProperties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2279 $ref: '#/definitions/NginxHTTPLocationZone'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2280 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2281 site1:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2282 requests: 736395
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2283 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2284 1xx: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2285 2xx: 727290
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2286 3xx: 4614
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2287 4xx: 934
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2288 5xx: 1535
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2289 total: 734373
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2290 discarded: 2020
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2291 received: 180157219
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2292 sent: 20183175459
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2293 site2:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2294 requests: 185307
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2295 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2296 1xx: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2297 2xx: 112674
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2298 3xx: 45383
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2299 4xx: 2504
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2300 5xx: 4419
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2301 total: 164980
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2302 discarded: 20326
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2303 received: 51575327
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2304 sent: 2983241510
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2305 NginxHTTPLocationZone:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2306 title: HTTP Location Zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2307 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2308 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2309 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2310 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2311 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	2312 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2313 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	2314 number of responses with status codes
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2315 “<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	2316 “<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	2317 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2318 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2319 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2320 1xx:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2321 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2322 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	2323 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2324 2xx:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2325 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2326 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	2327 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2328 3xx:
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>3xx</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 4xx:
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>4xx</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 5xx:
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>5xx</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 total:
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 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	2343 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2344 discarded:
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 total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2347 requests completed without sending a response.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2348 received:
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 bytes received from clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2351 sent:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2352 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2353 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	2354 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	2355 requests: 706690
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2356 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2357 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2358 2xx: 699482
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2359 3xx: 4522
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2360 4xx: 907
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2361 5xx: 266
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2362 total: 705177
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2363 discarded: 1513
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2364 received: 172711587
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2365 sent: 19415530115
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2366 NginxHTTPCachesMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2367 title: HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2368 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2369 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	2370 <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	2371 and other “<code>*_cache_path</code>” directives.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2372 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2373 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2374 $ref: '#/definitions/NginxHTTPCache'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2375 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2376 http-cache:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2377 size: 530915328
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2378 max_size: 536870912
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2379 cold: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2380 hit:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2381 responses: 254032
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2382 bytes: 6685627875
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2383 stale:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2384 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2385 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2386 updating:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2387 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2388 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2389 revalidated:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2390 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2391 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2392 miss:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2393 responses: 1619201
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2394 bytes: 53841943822
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2395 expired:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2396 responses: 45859
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2397 bytes: 1656847080
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2398 responses_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2399 bytes_written: 1641825173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2400 bypass:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2401 responses: 200187
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2402 bytes: 5510647548
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2403 responses_written: 200173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2404 bytes_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2405 frontend-cache:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2406 size: 530915328
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2407 max_size: 536870912
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2408 cold: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2409 hit:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2410 responses: 254032
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2411 bytes: 6685627875
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2412 stale:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2413 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2414 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2415 updating:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2416 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2417 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2418 revalidated:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2419 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2420 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2421 miss:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2422 responses: 1619201
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2423 bytes: 53841943822
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2424 expired:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2425 responses: 45859
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2426 bytes: 1656847080
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2427 responses_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2428 bytes_written: 1641825173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2429 bypass:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2430 responses: 200187
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2431 bytes: 5510647548
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2432 responses_written: 200173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2433 bytes_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2434 NginxHTTPCache:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2435 title: HTTP Cache
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2436 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2437 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2438 size:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2439 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2440 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	2441 max_size:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2442 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2443 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	2444 specified in the configuration.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2445 cold:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2446 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2447 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	2448 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	2449 hit:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2450 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2451 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2452 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2453 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2454 description: The total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2455 <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	2456 responses read from the cache.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2457 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2458 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2459 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	2460 stale:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2461 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2462 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2463 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2464 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2465 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	2466 <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	2467 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	2468 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2469 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2470 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	2471 updating:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2472 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2473 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2474 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2475 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2476 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	2477 while responses were being updated (see
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2478 <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	2479 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	2480 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2481 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2482 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	2483 revalidated:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2484 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2485 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2486 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2487 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2488 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	2489 read from the cache (see
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2490 <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	2491 and other “<code>*_cache_revalidate</code>” directives.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2492 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2493 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2494 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	2495 miss:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2496 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2497 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2498 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2499 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2500 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	2501 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2502 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2503 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	2504 responses_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2505 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2506 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	2507 bytes_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2508 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2509 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	2510 expired:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2511 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2512 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2513 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2514 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2515 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	2516 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2517 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2518 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	2519 responses_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2520 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2521 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	2522 bytes_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2523 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2524 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	2525 bypass:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2526 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2527 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2528 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2529 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2530 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	2531 <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	2532 and other “<code>*_cache_bypass</code>” directives.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2533 bytes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2534 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2535 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	2536 responses_written:
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 written to the cache.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2539 bytes_written:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2540 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2541 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	2542 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2543 size: 530915328
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2544 max_size: 536870912
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2545 cold: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2546 hit:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2547 responses: 254032
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2548 bytes: 6685627875
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2549 stale:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2550 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2551 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2552 updating:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2553 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2554 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2555 revalidated:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2556 responses: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2557 bytes: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2558 miss:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2559 responses: 1619201
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2560 bytes: 53841943822
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2561 expired:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2562 responses: 45859
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2563 bytes: 1656847080
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2564 responses_written: 44992
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2565 bytes_written: 1641825173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2566 bypass:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2567 responses: 200187
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2568 bytes: 5510647548
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2569 responses_written: 200173
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2570 bytes_written: 44992
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2571 NginxHTTPLimitConnZonesMap:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2572 title: HTTP limit_conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2573 description: \|
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2574 Status data for all HTTP
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2575 <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	2576 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2577 additionalProperties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2578 $ref: '#/definitions/NginxHTTPLimitConnZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2579 NginxHTTPLimitConnZone:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2580 title: HTTP Connections Limiting
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2581 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2582 properties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2583 passed:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2584 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2585 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	2586 nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2587 rejected:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2588 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2589 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	2590 rejected_dry_run:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2591 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2592 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	2593 <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	2594 mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2595 example:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2596 passed: 15
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2597 rejected: 0
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2598 rejected_dry_run: 2
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2599 NginxHTTPLimitReqZonesMap:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2600 title: HTTP limit_reqs
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2601 description: \|
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2602 Status data for all HTTP
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2603 <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	2604 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2605 additionalProperties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2606 $ref: '#/definitions/NginxHTTPLimitReqZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2607 NginxHTTPLimitReqZone:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2608 title: HTTP Requests Rate Limiting
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2609 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2610 properties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2611 passed:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2612 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2613 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	2614 nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2615 delayed:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2616 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2617 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	2618 rejected:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2619 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2620 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	2621 delayed_dry_run:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2622 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2623 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	2624 <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	2625 mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2626 rejected_dry_run:
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 accounted as rejected in the
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2629 <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	2630 mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2631 example:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2632 passed: 15
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2633 delayed: 4
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2634 rejected: 0
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2635 delayed_dry_run: 1
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2636 rejected_dry_run: 2
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2637 NginxHTTPUpstreamMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2638 title: HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2639 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2640 Status information of all HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2641 <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	2642 <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	2643 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2644 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2645 $ref: '#/definitions/NginxHTTPUpstream'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2646 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2647 trac-backend:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2648 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2649 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2650 server: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2651 name: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2652 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2653 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2654 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2655 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2656 requests: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2657 header_time: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2658 response_time: 36
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2659 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2660 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2661 2xx: 666310
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2662 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2663 4xx: 915
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2664 5xx: 6
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2665 total: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2666 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2667 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2668 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2669 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2670 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2671 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2672 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2673 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2674 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2675 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2676 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	2677 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2678 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2679 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2680 name: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2681 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2682 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2683 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2684 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2685 requests: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2686 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2687 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2688 2xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2689 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2690 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2691 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2692 total: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2693 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2694 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2695 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2696 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2697 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2698 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2699 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2700 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2701 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2702 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2703 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	2704 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2705 keepalive: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2706 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2707 zone: trac-backend
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2708 hg-backend:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2709 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2710 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2711 server: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2712 name: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2713 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2714 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2715 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2716 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2717 requests: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2718 header_time: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2719 response_time: 36
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2720 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2721 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2722 2xx: 666310
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2723 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2724 4xx: 915
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2725 5xx: 6
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2726 total: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2727 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2728 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2729 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2730 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2731 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2732 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2733 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2734 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2735 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2736 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2737 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	2738 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2739 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2740 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2741 name: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2742 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2743 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2744 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2745 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2746 requests: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2747 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2748 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2749 2xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2750 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2751 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2752 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2753 total: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2754 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2755 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2756 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2757 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2758 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2759 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2760 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2761 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2762 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2763 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2764 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	2765 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2766 keepalive: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2767 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2768 zone: hg-backend
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2769 NginxHTTPUpstream:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2770 title: HTTP Upstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2771 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2772 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2773 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2774 $ref: '#/definitions/NginxHTTPUpstreamPeerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2775 keepalive:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2776 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2777 description: The current number of idle
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2778 <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	2779 connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2780 zombies:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2781 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2782 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	2783 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	2784 zone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2785 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2786 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	2787 <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	2788 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	2789 queue:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2790 type: object
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2791 description: >
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2792 For the requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2793 <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	2794 the following data are provided:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2795 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2796 size:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2797 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2798 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	2799 max_size:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2800 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2801 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	2802 at the same time.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2803 overflows:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2804 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2805 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	2806 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2807 upstream_backend:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2808 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2809 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2810 server: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2811 name: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2812 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2813 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2814 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2815 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2816 max_conns: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2817 requests: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2818 header_time: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2819 response_time: 36
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2820 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2821 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2822 2xx: 666310
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2823 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2824 4xx: 915
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2825 5xx: 6
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2826 total: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2827 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2828 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2829 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2830 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2831 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2832 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2833 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2834 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2835 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2836 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2837 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	2838 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2839 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2840 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2841 name: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2842 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2843 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2844 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2845 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2846 max_conns: 20
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2847 requests: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2848 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2849 1xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2850 2xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2851 3xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2852 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2853 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2854 total: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2855 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2856 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2857 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2858 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2859 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2860 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2861 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2862 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2863 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2864 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2865 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	2866 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2867 keepalive: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2868 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2869 zone: upstream_backend
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2870 NginxHTTPUpstreamPeerMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2871 title: HTTP Upstream Servers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2872 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2873 An array of HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2874 <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	2875 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2876 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2877 $ref: '#/definitions/NginxHTTPUpstreamPeer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2878 NginxHTTPUpstreamPeer:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2879 title: HTTP Upstream Server
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2880 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2881 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2882 id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2883 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2884 description: The ID of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2885 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2886 server:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2887 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2888 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	2889 of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2890 service:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2891 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2892 description: The
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2893 <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	2894 parameter value of the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2895 <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	2896 directive.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2897 name:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2898 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2899 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	2900 <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	2901 directive.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2902 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2903 backup:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2904 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2905 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	2906 <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	2907 server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2908 weight:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2909 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2910 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	2911 of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2912 state:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2913 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2914 enum:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2915 - up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2916 - draining
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2917 - down
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2918 - unavail
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2919 - checking
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2920 - unhealthy
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2921 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	2922 “<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	2923 “<code>unavail</code>”, “<code>checking</code>”,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2924 and “<code>unhealthy</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2925 active:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2926 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2927 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	2928 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2929 max_conns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2930 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2931 description: The
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2932 <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	2933 limit for the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2934 requests:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2935 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2936 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	2937 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2938 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2939 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2940 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2941 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2942 1xx:
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 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	2945 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2946 2xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2947 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2948 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	2949 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2950 3xx:
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>3xx</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 4xx:
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>4xx</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 5xx:
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>5xx</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 total:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2963 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2964 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	2965 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2966 sent:
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 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	2969 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2970 received:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2971 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2972 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	2973 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2974 fails:
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 unsuccessful attempts
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2977 to communicate with the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2978 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2979 unavail:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2980 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2981 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	2982 (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	2983 attempts reaching the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2984 <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	2985 threshold.
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 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2988 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2989 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2990 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2991 checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2992 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	2993 description: The total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2994 <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	2995 requests made.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2996 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2997 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2998 description: The number of failed health checks.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2999 unhealthy:
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: 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	3002 (state “<code>unhealthy</code>”).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3003 last_passed:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3004 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3005 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	3006 and passed
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3007 <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	3008 downtime:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3009 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3010 readOnly: true
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3011 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	3012 “<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	3013 downstart:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3014 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3015 format: date-time
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3016 readOnly: true
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3017 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	3018 “<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	3019 or “<code>unhealthy</code>”,
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3020 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	3021 selected:
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 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	3026 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	3027 header_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3028 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3029 readOnly: true
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3030 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	3031 <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	3032 from the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3033 response_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3034 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3035 readOnly: true
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3036 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	3037 <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	3038 from the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3039 NginxHTTPUpstreamConfServerMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3040 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	3041 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	3042 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3043 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3044 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3045 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3046 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3047 server: 10.0.0.1:8088
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3048 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3049 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3050 max_fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3051 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3052 slow_start: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3053 route: ''
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3054 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3055 down: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3056 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3057 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3058 weight: 4
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3059 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3060 max_fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3061 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3062 slow_start: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3063 route: ''
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3064 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3065 down: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3066 NginxHTTPUpstreamConfServer:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3067 title: HTTP Upstream Server
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3068 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3069 Dynamically configurable parameters of an HTTP upstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3070 <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	3071 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3072 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3073 id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3074 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3075 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	3076 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	3077 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3078 server:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3079 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3080 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3081 <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	3082 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3083 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	3084 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	3085 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	3086 applied to the upstream configuration
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3087 without the need of restarting nginx.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3088 This requires the
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_core_module.html#resolver">resolver</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3090 directive in the “<code>http</code>” block.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3091 See also the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3092 <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	3093 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3094 service:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3095 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3096 description: Same as the
2028 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_upstream_module.html#service">service</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3098 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3099 This parameter cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3100 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3101 weight:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3102 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3103 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3104 <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	3105 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3106 max_conns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3107 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3108 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3109 <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	3110 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3111 max_fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3112 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3113 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3114 <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	3115 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3116 fail_timeout:
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3117 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3118 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3119 <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	3120 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3121 slow_start:
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3122 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3123 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3124 <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	3125 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3126 route:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3127 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3128 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3129 <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	3130 parameter of the HTTP upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3131 backup:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3132 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3133 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	3134 <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	3135 server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3136 This parameter cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3137 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3138 down:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3139 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3140 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3141 <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	3142 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	3143 drain:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3144 type: boolean
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3145 description: Same as the
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3146 <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	3147 parameter of the HTTP upstream server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3148 parent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3149 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3150 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	3151 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	3152 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3153 host:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3154 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3155 description: Hostname of the resolved server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3156 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	3157 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3158 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3159 id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3160 server: 10.0.0.1:8089
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3161 weight: 4
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3162 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3163 max_fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3164 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3165 slow_start: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3166 route: ''
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3167 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3168 down: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3169 NginxHTTPKeyvalZonesMap:
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3170 title: HTTP Keyval Shared Memory Zones
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3171 description: \|
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3172 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	3173 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3174 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3175 $ref: '#/definitions/NginxHTTPKeyvalZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3176 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3177 keyval_zone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3178 key1: value1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3179 key2: value2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3180 key3: value3
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3181 one:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3182 arg1: value1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3183 arg2: value2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3184 arg3: value3
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3185 NginxHTTPKeyvalZone:
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3186 title: HTTP Keyval Shared Memory Zone
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3187 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3188 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	3189 when using the GET method.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3190 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3191 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3192 key1: value1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3193 key2: value2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3194 key3: value3
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3195 NginxHTTPKeyvalZonePostPatch:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3196 title: HTTP Keyval Shared Memory Zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3197 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3198 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	3199 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	3200 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3201 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3202 key1: value1
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3203 key2: value2
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3204 key3:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3205 value: value3
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3206 expire: 30000
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3207 NginxStreamServerZonesMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3208 title: Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3209 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3210 Status information for all stream
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	3211 <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	3212 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3213 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3214 $ref: '#/definitions/NginxStreamServerZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3215 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3216 mysql-frontend:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3217 processing: 2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3218 connections: 270925
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3219 sessions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3220 2xx: 155564
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3221 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3222 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3223 total: 270925
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3224 discarded: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3225 received: 28988975
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3226 sent: 3879346317
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3227 dns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3228 processing: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3229 connections: 155569
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3230 sessions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3231 2xx: 155564
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3232 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3233 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3234 total: 155569
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3235 discarded: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3236 received: 4200363
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3237 sent: 20489184
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3238 NginxStreamServerZone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3239 title: Stream Server Zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3240 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3241 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3242 processing:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3243 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3244 description: The number of client connections
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3245 that are currently being processed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3246 connections:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3247 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3248 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	3249 sessions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3250 type: object
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3251 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	3252 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	3253 “<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	3254 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3255 2xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3256 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3257 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	3258 <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	3259 “<code>2xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3260 4xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3261 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3262 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	3263 <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	3264 “<code>4xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3265 5xx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3266 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3267 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	3268 <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	3269 “<code>5xx</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3270 total:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3271 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3272 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	3273 discarded:
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
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3276 connections completed without creating a session.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3277 received:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3278 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3279 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	3280 sent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3281 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3282 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	3283 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3284 dns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3285 processing: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3286 connections: 155569
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3287 sessions:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3288 2xx: 155564
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3289 4xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3290 5xx: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3291 total: 155569
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3292 discarded: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3293 received: 4200363
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3294 sent: 20489184
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3295 NginxStreamLimitConnZonesMap:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3296 title: Stream limit_conns
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3297 description: \|
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3298 Status data for all stream
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3299 <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	3300 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3301 additionalProperties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3302 $ref: '#/definitions/NginxStreamLimitConnZone'
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3303 NginxStreamLimitConnZone:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3304 title: Stream Connections Limiting
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3305 type: object
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3306 properties:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3307 passed:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3308 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3309 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	3310 nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3311 rejected:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3312 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3313 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	3314 rejected_dry_run:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3315 type: integer
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3316 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	3317 <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	3318 mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3319 example:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3320 passed: 15
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3321 rejected: 0
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3322 rejected_dry_run: 2
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3323 NginxStreamUpstreamMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3324 title: Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3325 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	3326 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3327 additionalProperties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3328 $ref: '#/definitions/NginxStreamUpstream'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3329 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3330 mysql_backends:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3331 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3332 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3333 server: 10.0.0.1:12345
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3334 name: 10.0.0.1:12345
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3335 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3336 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3337 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3338 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3339 max_conns: 30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3340 connecions: 1231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3341 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3342 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3343 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3344 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3345 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3346 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3347 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3348 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3349 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3350 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3351 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	3352 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3353 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3354 server: 10.0.0.1:12346
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3355 name: 10.0.0.1:12346
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3356 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3357 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3358 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3359 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3360 max_conns: 30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3361 connections: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3362 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3363 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3364 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3365 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3366 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3367 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3368 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3369 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3370 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3371 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3372 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	3373 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3374 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3375 zone: mysql_backends
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3376 dns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3377 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3378 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3379 server: 10.0.0.1:12347
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3380 name: 10.0.0.1:12347
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3381 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3382 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3383 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3384 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3385 max_conns: 30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3386 connections: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3387 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3388 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3389 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3390 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3391 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3392 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3393 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3394 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3395 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3396 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3397 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	3398 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3399 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3400 server: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3401 name: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3402 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3403 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3404 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3405 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3406 connections: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3407 max_conns: 30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3408 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3409 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3410 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3411 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3412 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3413 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3414 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3415 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3416 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3417 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3418 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	3419 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3420 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3421 zone: dns
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3422 NginxStreamUpstream:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3423 title: Stream Upstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3424 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3425 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3426 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3427 $ref: '#/definitions/NginxStreamUpstreamPeerMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3428 zombies:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3429 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3430 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	3431 but still processing active client connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3432 zone:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3433 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3434 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	3435 <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	3436 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	3437 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3438 dns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3439 peers:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3440 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3441 server: 10.0.0.1:12347
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3442 name: 10.0.0.1:12347
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3443 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3444 weight: 5
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3445 state: up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3446 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3447 max_conns: 50
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3448 connections: 667231
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3449 sent: 251946292
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3450 received: 19222475454
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3451 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3452 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3453 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3454 checks: 26214
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3455 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3456 unhealthy: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3457 last_passed: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3458 downtime: 0
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3459 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	3460 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3461 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3462 server: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3463 name: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3464 backup: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3465 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3466 state: unhealthy
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3467 active: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3468 max_conns: 50
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3469 connections: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3470 sent: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3471 received: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3472 fails: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3473 unavail: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3474 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3475 checks: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3476 fails: 26284
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3477 unhealthy: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3478 last_passed: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3479 downtime: 262925617
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3480 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	3481 selected: 2019-10-01T15:01:25Z
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3482 zombies: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3483 zone: dns
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3484 NginxStreamUpstreamPeerMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3485 title: Stream Upstream Servers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3486 description: Array of stream upstream servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3487 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3488 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3489 $ref: '#/definitions/NginxStreamUpstreamPeer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3490 NginxStreamUpstreamPeer:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3491 title: Stream Upstream Server
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3492 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3493 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3494 id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3495 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3496 description: The ID of the server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3497 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3498 server:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3499 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3500 description: An
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3501 <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	3502 of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3503 service:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3504 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3505 description: The
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3506 <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	3507 parameter value of the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3508 <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	3509 directive.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3510 name:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3511 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3512 format: hostname
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3513 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	3514 <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	3515 directive.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3516 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3517 backup:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3518 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3519 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	3520 <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	3521 server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3522 weight:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3523 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3524 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	3525 of the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3526 state:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3527 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3528 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3529 enum:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3530 - up
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3531 - down
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3532 - unavail
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3533 - checking
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3534 - unhealthy
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3535 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	3536 “<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	3537 “<code>checking</code>”, or “<code>unhealthy</code>”.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3538 active:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3539 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3540 description: The current number of connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3541 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3542 max_conns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3543 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3544 description: The
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3545 <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	3546 limit for the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3547 connections:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3548 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3549 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	3550 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3551 connect_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3552 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3553 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	3554 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3555 first_byte_time:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3556 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3557 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	3558 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3559 response_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 receive the last byte of data.
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 sent:
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 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	3566 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3567 received:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3568 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3569 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	3570 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3571 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3572 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3573 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	3574 to communicate with the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3575 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3576 unavail:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3577 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3578 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	3579 (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	3580 attempts reaching the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3581 <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	3582 threshold.
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 health_checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3585 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3586 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3587 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3588 checks:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3589 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3590 description: The total number of
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3591 <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	3592 requests made.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3593 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3594 fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3595 type: integer
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3596 description: The number of failed health checks.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3597 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3598 unhealthy:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3599 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3600 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	3601 (state “<code>unhealthy</code>”).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3602 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3603 last_passed:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3604 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3605 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	3606 was successful and passed
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3607 <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	3608 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3609 downtime:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3610 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3611 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	3612 “<code>unavail</code>”, “<code>checking</code>”,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3613 and “<code>unhealthy</code>” states.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3614 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3615 downstart:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3616 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3617 format: date-time
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3618 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	3619 “<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	3620 or “<code>unhealthy</code>”,
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3621 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	3622 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3623 selected:
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 was last selected
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3627 to process a connection,
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3628 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	3629 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3630 NginxStreamUpstreamConfServerMap:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3631 title: Stream Upstream Servers
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3632 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3633 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	3634 type: array
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3635 items:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3636 $ref: '#/definitions/NginxStreamUpstreamConfServer'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3637 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3638 - id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3639 server: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3640 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3641 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3642 max_fails: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3643 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3644 slow_start: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3645 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3646 down: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3647 - id: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3648 server: 10.0.0.1:12349
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3649 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3650 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3651 max_fails: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3652 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3653 slow_start: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3654 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3655 down: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3656 NginxStreamUpstreamConfServer:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3657 title: Stream Upstream Server
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3658 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3659 Dynamically configurable parameters of a stream upstream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3660 <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	3661 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3662 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3663 id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3664 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3665 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	3666 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	3667 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3668 server:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3669 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3670 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3671 <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	3672 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3673 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	3674 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	3675 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	3676 applied to the upstream configuration
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3677 without the need of restarting nginx.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3678 This requires the
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_core_module.html#resolver">resolver</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3680 directive in the “<code>stream</code>” block.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3681 See also the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3682 <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	3683 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3684 service:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3685 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3686 description: Same as the
2028 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_upstream_module.html#service">service</a>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3688 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3689 This parameter cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3690 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3691 weight:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3692 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3693 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3694 <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	3695 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3696 max_conns:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3697 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3698 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3699 <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	3700 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3701 max_fails:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3702 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3703 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3704 <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	3705 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3706 fail_timeout:
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3707 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3708 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3709 <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	3710 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3711 slow_start:
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3712 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3713 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3714 <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	3715 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3716 backup:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3717 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3718 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	3719 <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	3720 server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3721 This parameter cannot be changed.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3722 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3723 down:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3724 type: boolean
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3725 description: Same as the
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3726 <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	3727 parameter of the stream upstream server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3728 parent:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3729 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3730 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	3731 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	3732 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3733 host:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3734 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3735 description: Hostname of the resolved server.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3736 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	3737 readOnly: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3738 example:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3739 id: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3740 server: 10.0.0.1:12348
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3741 weight: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3742 max_conns: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3743 max_fails: 1
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3744 fail_timeout: 10s
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3745 slow_start: 0
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3746 backup: false
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3747 down: false
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3748 NginxStreamKeyvalZonesMap:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3749 title: Stream Keyval Shared Memory Zones
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3750 description: \|
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3751 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	3752 type: object
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3753 additionalProperties:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3754 $ref: '#/definitions/NginxStreamKeyvalZone'
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3755 example:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3756 keyval_zone:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3757 key1: value1
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3758 key2: value2
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3759 key3: value3
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3760 one:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3761 arg1: value1
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3762 arg2: value2
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3763 arg3: value3
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3764 NginxStreamKeyvalZone:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3765 title: Stream Keyval Shared Memory Zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3766 description: \|
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3767 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	3768 type: object
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3769 example:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3770 key1: value1
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3771 key2: value2
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3772 key3: value3
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3773 NginxStreamKeyvalZonePostPatch:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3774 title: Stream Keyval Shared Memory Zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3775 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3776 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	3777 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	3778 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3779 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3780 key1: value1
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3781 key2: value2
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3782 key3:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3783 value: value3
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3784 expire: 30000
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3785 NginxStreamZoneSync:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3786 title: Stream Zone Sync Node
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3787 type: object
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3788 properties:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3789 zones:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3790 type: object
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3791 title: Zone Sync Zones
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3792 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	3793 additionalProperties:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3794 $ref: '#/definitions/NginxStreamZoneSyncZone'
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3795 status:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3796 type: object
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3797 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	3798 properties:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3799 bytes_in:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3800 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3801 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	3802 msgs_in:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3803 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3804 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	3805 msgs_out:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3806 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3807 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	3808 bytes_out:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3809 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3810 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	3811 nodes_online:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3812 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3813 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	3814 example:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3815 zones:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3816 zone1:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3817 records_pending: 2061
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3818 records_total: 260575
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3819 zone2:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3820 records_pending: 0
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3821 records_total: 14749
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3822 status:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3823 bytes_in: 1364923761
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3824 msgs_in: 337236
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3825 msgs_out: 346717
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3826 bytes_out: 1402765472
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3827 nodes_online: 15
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3828 NginxStreamZoneSyncZone:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3829 title: Sync Zone
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3830 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	3831 type: object
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3832 properties:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3833 records_pending:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3834 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3835 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	3836 records_total:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3837 type: integer
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3838 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	3839 NginxResolverZonesMap:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3840 title: Resolver Zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3841 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3842 Status data for all
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3843 <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	3844 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3845 additionalProperties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3846 $ref: '#/definitions/NginxResolverZone'
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3847 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3848 resolver_zone1:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3849 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3850 name: 25460
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3851 srv: 130
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3852 addr: 2580
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3853 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3854 noerror: 26499
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3855 formerr: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3856 servfail: 3
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3857 nxdomain: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3858 notimp: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3859 refused: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3860 timedout: 243
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3861 unknown: 478
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3862 resolver_zone2:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3863 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3864 name: 325460
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3865 srv: 1130
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3866 addr: 12580
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3867 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3868 noerror: 226499
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3869 formerr: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3870 servfail: 283
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3871 nxdomain: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3872 notimp: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3873 refused: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3874 timedout: 743
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3875 unknown: 1478
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3876 NginxResolverZone:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3877 title: Resolver Zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3878 description: \|
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3879 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	3880 <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	3881 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3882 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3883 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3884 type: object
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3885 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3886 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3887 name:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3888 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3889 description: The total number of requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3890 to resolve names to addresses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3891 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3892 srv:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3893 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3894 description: The total number of requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3895 to resolve SRV records.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3896 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3897 addr:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3898 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3899 description: The total number of requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3900 to resolve addresses to names.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3901 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3902 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3903 type: object
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 properties:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3906 noerror:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3907 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3908 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	3909 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3910 formerr:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3911 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3912 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3913 FORMERR (<literal>Format error</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3914 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3915 servfail:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3916 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3917 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3918 SERVFAIL (<literal>Server failure</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3919 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3920 nxdomain:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3921 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3922 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3923 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	3924 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3925 notimp:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3926 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3927 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3928 NOTIMP (<literal>Unimplemented</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3929 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3930 refused:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3931 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3932 description: The total number of
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3933 REFUSED (<literal>Operation refused</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3934 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3935 timedout:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3936 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3937 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	3938 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3939 unknown:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3940 type: integer
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3941 description: The total number of requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3942 completed with an unknown error.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3943 readOnly: true
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3944 example:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3945 resolver_zone1:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3946 requests:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3947 name: 25460
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3948 srv: 130
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3949 addr: 2580
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3950 responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3951 noerror: 26499
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3952 formerr: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3953 servfail: 3
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3954 nxdomain: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3955 notimp: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3956 refused: 0
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3957 timedout: 243
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2364 diff changeset	3958 unknown: 478
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3959 NginxError:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3960 title: Error
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3961 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3962 nginx error object.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3963 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3964 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3965 error:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3966 type: object
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3967 properties:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3968 status:
2132 a645aa9f2ebf Changed type of HTTP error code to integer in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2082 diff changeset	3969 type: integer
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3970 description: HTTP error code.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3971 text:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3972 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3973 description: Error description.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3974 code:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3975 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3976 description: Internal nginx error code.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3977 request_id:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3978 type: string
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2028 diff changeset	3979 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	3980 <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	3981 variable.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3982 href:
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: Link to reference documentation.

Mercurial > hg > nginx-site

annotate yaml/nginx_api.yaml @ 2493:407147d8020f