nginx-site: yaml/nginx_api.yaml annotate

author	Ruslan Ermilov <ru@nginx.com>
date	Sat, 26 Aug 2017 00:56:05 +0300
parents
children	a810103f8a75

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:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 version: '1.0'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4 title: NGINX Plus REST API
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	5 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	6 NGINX Plus REST
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7 [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	8 provides access to NGINX Plus status information,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 on-the-fly configuration of upstream servers and
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 [key-value](https://nginx.org/en/docs/http/ngx_http_keyval_module.html)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 pairs management.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	12 basePath: /api/1
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
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17 - name: SSL
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 - name: Slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 - name: HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20 - name: HTTP Requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 - name: HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 - name: HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23 - name: HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 - name: HTTP Keyvals
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 - name: Stream
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26 - name: Stream Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 - name: Stream Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 - name: Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 - name: Method POST
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 - name: Method PATCH
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 - name: Method DELETE
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 schemes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 - http
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34 paths:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 /:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 - General Info
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 Return list of root endpoints
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 Returns a list of root endpoints.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 operationId: getAPIEndpoints
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 $ref: '#/definitions/ArrayOfStrings'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 /nginx:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 - General Info
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 Return status of nginx running instance
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60 Returns nginx version, build name, address,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61 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	62 operationId: getNginx
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 Limits which fields of nginx running instance will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 $ref: '#/definitions/NginxObject'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 /processes:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 - Processes
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 Return nginx processes status
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 Returns the number of abnormally terminated
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
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99 Reset nginx processes statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 Resets counters of abnormally terminated and respawned
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 child processes.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 operationId: deleteProcesses
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 /connections:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 - Connections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 Return client connections statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 Returns statistics of client connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 operationId: getConnections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 $ref: '#/definitions/NginxConnections'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	125 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	127 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	129 Limits which fields of the connections statistics will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	132 - Connections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 - Method DELETE
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 Reset client connections statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137 Resets statistics of accepted and dropped
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 client connections.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139 operationId: deleteConnections
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143 /ssl:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146 - SSL
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 Return SSL statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 Returns SSL statistics.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 operationId: getSsl
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 $ref: '#/definitions/NginxSSLObject'
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 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 Limits which fields of SSL statistics will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 delete:
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 - SSL
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169 - Method DELETE
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171 Reset SSL statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 Resets counters of SSL handshakes and session reuses.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 operationId: deleteSslStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178 /slabs/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	180 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 - Slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184 Return status of all slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186 Returns status of slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	187 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	188 operationId: getSlabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	189 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	192 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	193 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	194 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	195 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	196 Limits which fields of slab zones will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197 If the “<literal>fields</literal>” value is empty,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	198 then only zone names are output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	200 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	202 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 $ref: '#/definitions/NginxSlabZoneMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 '/slabs/{slabZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	205 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	206 - name: slabZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 in: path
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209 The name of the shared memory zone with slab allocator.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214 - Slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217 Return status of a slab
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 Returns status of slabs for a particular shared memory zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220 with slab allocator.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	221 operationId: getSlabZone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	223 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	228 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229 Limits which fields of the slab zone will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	230 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	231 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	232 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	233 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234 $ref: '#/definitions/NginxSlabZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236 description: Slab not found (SlabNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	240 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241 - Slabs
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 - Method DELETE
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 Reset slab statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 Resets the “<literal>reqs</literal>” and “<literal>fails</literal>”
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 metrics for each memory slot.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248 operationId: deleteSlabZoneStats
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	252 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 description: Slab not found (SlabNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256 /http/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	257 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259 - HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262 Return list of HTTP-related endpoints
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 Returns a list of first level HTTP endpoints.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 operationId: getHttp
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272 $ref: '#/definitions/ArrayOfStrings'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 /http/requests:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	276 - HTTP Requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 Return HTTP requests statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 Returns status of client HTTP requests.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 operationId: getHttpRequests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 Limits which fields of client HTTP requests statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291 will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 $ref: '#/definitions/NginxHTTPRequests'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 - HTTP Requests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300 - Method DELETE
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	302 Reset HTTP requests statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 Resets the number of total client HTTP requests.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 operationId: deleteHttpRequests
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 /http/server_zones/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 - HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 Return status of all HTTP server zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 Returns status information for each HTTP
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 [server zone](https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone).
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319 operationId: getHttpServerZones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 - in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324 name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	325 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	326 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327 Limits which fields of server zones will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 If the “<literal>fields</literal>” value is empty,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329 then only server zone names are output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334 $ref: '#/definitions/NginxHTTPServerZonesMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335 '/http/server_zones/{httpServerZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	337 - name: httpServerZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 in: path
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	339 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	340 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	342 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	343 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	344 - HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	345 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347 Return status of an HTTP server zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	348 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349 Returns status of a particular HTTP server zone.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350 operationId: getHttpServerZone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 Limits which fields of the server zone will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363 $ref: '#/definitions/NginxHTTPServerZone'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	364 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365 description: Server zone not found (ServerZoneNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 - HTTP Server Zones
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371 - Method DELETE
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 Reset statistics for an HTTP server zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375 Resets statistics of accepted and discarded requests, responses,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376 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	377 operationId: deleteHttpServerZoneStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	378 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382 description: Server zone not found (ServerZoneNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	383 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	385 /http/caches/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	386 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	388 - HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	389 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	390 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	391 Return status of all caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	392 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	393 Returns status of each cache configured by
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	394 [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	395 and other “<literal>*_cache_path</literal>” directives.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	396 operationId: getHttpCaches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	397 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	398 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	399 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	400 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	401 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	402 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	403 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	404 Limits which fields of cache zones will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405 If the “<literal>fields</literal>” value is empty,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406 then only names of cache zones are output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	407 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	408 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	409 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	410 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411 $ref: '#/definitions/NginxHTTPCachesMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412 '/http/caches/{httpCacheZoneName}':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414 - name: httpCacheZoneName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	415 in: path
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	416 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	417 The name of the cache zone.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	418 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	420 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	421 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	422 - HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425 Return status of a cache
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	427 Returns status of a particular cache.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	428 operationId: getHttpCacheZone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	429 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	432 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	433 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	434 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	435 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	436 Limits which fields of the cache zone will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	437 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	438 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	439 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	440 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441 $ref: '#/definitions/NginxHTTPCache'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	442 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	443 description: Cache not found (CacheNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	444 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	446 delete:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	447 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	448 - HTTP Caches
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	449 - Method DELETE
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451 Reset cache statistics
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	453 Resets statistics of cache hits/misses in a particular cache zone.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	454 operationId: deleteHttpCacheZoneStat
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	455 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	456 '204':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458 '404':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459 description: Cache not found (CacheNotFound)
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	461 $ref: '#/definitions/NginxError'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	462 /http/upstreams/:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	463 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	465 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	467 summary: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	468 Return status of all HTTP upstream server groups
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	469 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	470 Returns status of each HTTP upstream server group
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	471 and its servers.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472 operationId: getHttpUpstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	473 produces:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	474 - application/json
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	475 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 - name: fields
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477 in: query
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	478 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	479 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	480 Limits which fields of upstream server groups will be output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	481 If the “<literal>fields</literal>” value is empty,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	482 only names of upstreams are output.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	483 responses:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	484 '200':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	485 description: Success
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	486 schema:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	487 $ref: '#/definitions/NginxHTTPUpstreamMap'
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	488 '/http/upstreams/{httpUpstreamName}/':
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	489 parameters:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	490 - name: httpUpstreamName
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	491 in: path
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	492 description: \|
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	493 The name of an HTTP upstream server group.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	494 required: true
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	495 type: string
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	496 get:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	497 tags:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	498 - HTTP Upstreams
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	499 - Method GET
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	500 summary: \|

2028

5c55b7054b58 Updated docs for the upcoming NGINX Plus release.