Mercurial > hg > nginx-site

comparison yaml/nginx_api.yaml @ 2469:98fd810c13e0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 02 Dec 2019 13:23:05 +0300
parents 12716b241230
children 407147d8020f
comparison
equal deleted inserted replaced
2468:409e1f755037 2469:98fd810c13e0
1 swagger: '2.0' 1 swagger: '2.0'
2 info: 2 info:
3 version: '5.0' 3 version: '6.0'
4 title: NGINX Plus REST API 4 title: NGINX Plus REST API
5 description: NGINX Plus REST 5 description: NGINX Plus REST
6 [API](https://nginx.org/en/docs/http/ngx_http_api_module.html) 6 [API](https://nginx.org/en/docs/http/ngx_http_api_module.html)
7 provides access to NGINX Plus status information, 7 provides access to NGINX Plus status information,
8 on-the-fly configuration of upstream servers and 8 on-the-fly configuration of upstream servers and
9 key-value pairs management for 9 key-value pairs management for
10 [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and 10 [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and
11 [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html). 11 [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html).
12 basePath: /api/5 12 basePath: /api/6
13 tags: 13 tags:
14 - name: General Info 14 - name: General Info
15 - name: Processes 15 - name: Processes
16 - name: Connections 16 - name: Connections
17 - name: Slabs 17 - name: Slabs
20 - name: HTTP 20 - name: HTTP
21 - name: HTTP Requests 21 - name: HTTP Requests
22 - name: HTTP Server Zones 22 - name: HTTP Server Zones
23 - name: HTTP Location Zones 23 - name: HTTP Location Zones
24 - name: HTTP Caches 24 - name: HTTP Caches
25 - name: HTTP Limit Conns
26 - name: HTTP Limit Reqs
25 - name: HTTP Keyvals 27 - name: HTTP Keyvals
26 - name: HTTP Upstreams 28 - name: HTTP Upstreams
27 - name: Stream 29 - name: Stream
28 - name: Stream Server Zones 30 - name: Stream Server Zones
31 - name: Stream Limit Conns
29 - name: Stream Keyvals 32 - name: Stream Keyvals
30 - name: Stream Upstreams 33 - name: Stream Upstreams
31 - name: Stream Zone Sync 34 - name: Stream Zone Sync
32 - name: Method GET 35 - name: Method GET
33 - name: Method POST 36 - name: Method POST
462 responses: 465 responses:
463 '204': 466 '204':
464 description: Success 467 description: Success
465 '404': 468 '404':
466 description: Cache not found (*CacheNotFound*) 469 description: Cache not found (*CacheNotFound*)
470 schema:
471 $ref: '#/definitions/NginxError'
472 '405':
473 description: Method disabled (*MethodDisabled*)
474 schema:
475 $ref: '#/definitions/NginxError'
476 /http/limit_conns/:
477 get:
478 tags:
479 - HTTP Limit Conns
480 - Method GET
481 summary: Return status of all HTTP limit_conn zones
482 description: Returns status information for each HTTP
483 [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
484 operationId: getHttpLimitConnZones
485 produces:
486 - application/json
487 parameters:
488 - in: query
489 name: fields
490 type: string
491 description: Limits which fields of limit_conn zones will be output.
492 If the “<literal>fields</literal>” value is empty,
493 then only zone names will be output.
494 responses:
495 '200':
496 description: Success
497 schema:
498 $ref: '#/definitions/NginxHTTPLimitConnZonesMap'
499 '/http/limit_conns/{httpLimitConnZoneName}':
500 parameters:
501 - name: httpLimitConnZoneName
502 in: path
503 description: The name of a
504 [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
505 type: string
506 required: true
507 get:
508 tags:
509 - HTTP Limit Conns
510 - Method GET
511 summary: Return status of an HTTP limit_conn zone
512 description: Returns status of a particular HTTP
513 [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
514 operationId: getHttpLimitConnZone
515 produces:
516 - application/json
517 parameters:
518 - name: fields
519 in: query
520 type: string
521 description: Limits which fields of the
522 [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone)
523 will be output.
524 responses:
525 '200':
526 description: Success
527 schema:
528 $ref: '#/definitions/NginxHTTPLimitConnZone'
529 '404':
530 description: limit_conn not found (*LimitConnNotFound*)
531 schema:
532 $ref: '#/definitions/NginxError'
533 delete:
534 tags:
535 - HTTP Limit Conns
536 - Method DELETE
537 summary: Reset statistics for an HTTP limit_conn zone
538 description: Resets the connection limiting statistics.
539 operationId: deleteHttpLimitConnZoneStat
540 responses:
541 '204':
542 description: Success
543 '404':
544 description: limit_conn not found (*LimitConnNotFound*)
545 schema:
546 $ref: '#/definitions/NginxError'
547 '405':
548 description: Method disabled (*MethodDisabled*)
549 schema:
550 $ref: '#/definitions/NginxError'
551 /http/limit_reqs/:
552 get:
553 tags:
554 - HTTP Limit Reqs
555 - Method GET
556 summary: Return status of all HTTP limit_req zones
557 description: Returns status information for each HTTP
558 [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
559 operationId: getHttpLimitReqZones
560 produces:
561 - application/json
562 parameters:
563 - in: query
564 name: fields
565 type: string
566 description: Limits which fields of limit_req zones will be output.
567 If the “<literal>fields</literal>” value is empty,
568 then only zone names will be output.
569 responses:
570 '200':
571 description: Success
572 schema:
573 $ref: '#/definitions/NginxHTTPLimitReqZonesMap'
574 '/http/limit_reqs/{httpLimitReqZoneName}':
575 parameters:
576 - name: httpLimitReqZoneName
577 in: path
578 description: The name of a
579 [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
580 type: string
581 required: true
582 get:
583 tags:
584 - HTTP Limit Reqs
585 - Method GET
586 summary: Return status of an HTTP limit_req zone
587 description: Returns status of a particular HTTP
588 [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
589 operationId: getHttpLimitReqZone
590 produces:
591 - application/json
592 parameters:
593 - name: fields
594 in: query
595 type: string
596 description: Limits which fields of the
597 [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone)
598 will be output.
599 responses:
600 '200':
601 description: Success
602 schema:
603 $ref: '#/definitions/NginxHTTPLimitReqZone'
604 '404':
605 description: limit_req not found (*LimitReqNotFound*)
606 schema:
607 $ref: '#/definitions/NginxError'
608 delete:
609 tags:
610 - HTTP Limit Reqs
611 - Method DELETE
612 summary: Reset statistics for an HTTP limit_req zone
613 description: Resets the requests limiting statistics.
614 operationId: deleteHttpLimitReqZoneStat
615 responses:
616 '204':
617 description: Success
618 '404':
619 description: limit_req not found (*LimitReqNotFound*)
467 schema: 620 schema:
468 $ref: '#/definitions/NginxError' 621 $ref: '#/definitions/NginxError'
469 '405': 622 '405':
470 description: Method disabled (*MethodDisabled*) 623 description: Method disabled (*MethodDisabled*)
471 schema: 624 schema:
1038 '204': 1191 '204':
1039 description: Success 1192 description: Success
1040 '404': 1193 '404':
1041 description: | 1194 description: |
1042 Server zone not found (*ServerZoneNotFound*) 1195 Server zone not found (*ServerZoneNotFound*)
1196 schema:
1197 $ref: '#/definitions/NginxError'
1198 '405':
1199 description: Method disabled (*MethodDisabled*)
1200 schema:
1201 $ref: '#/definitions/NginxError'
1202 /stream/limit_conns/:
1203 get:
1204 tags:
1205 - Stream Limit Conns
1206 - Method GET
1207 summary: Return status of all stream limit_conn zones
1208 description: Returns status information for each stream
1209 [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
1210 operationId: getStreamLimitConnZones
1211 produces:
1212 - application/json
1213 parameters:
1214 - in: query
1215 name: fields
1216 type: string
1217 description: Limits which fields of limit_conn zones will be output.
1218 If the “<literal>fields</literal>” value is empty,
1219 then only zone names will be output.
1220 responses:
1221 '200':
1222 description: Success
1223 schema:
1224 $ref: '#/definitions/NginxStreamLimitConnZonesMap'
1225 '/stream/limit_conns/{streamLimitConnZoneName}':
1226 parameters:
1227 - name: streamLimitConnZoneName
1228 in: path
1229 description: The name of a
1230 [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
1231 type: string
1232 required: true
1233 get:
1234 tags:
1235 - Stream Limit Conns
1236 - Method GET
1237 summary: Return status of an stream limit_conn zone
1238 description: Returns status of a particular stream
1239 [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
1240 operationId: getStreamLimitConnZone
1241 produces:
1242 - application/json
1243 parameters:
1244 - name: fields
1245 in: query
1246 type: string
1247 description: Limits which fields of the
1248 [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone)
1249 will be output.
1250 responses:
1251 '200':
1252 description: Success
1253 schema:
1254 $ref: '#/definitions/NginxStreamLimitConnZone'
1255 '404':
1256 description: limit_conn not found (*LimitConnNotFound*)
1257 schema:
1258 $ref: '#/definitions/NginxError'
1259 delete:
1260 tags:
1261 - Stream Limit Conns
1262 - Method DELETE
1263 summary: Reset statistics for a stream limit_conn zone
1264 description: Resets the connection limiting statistics.
1265 operationId: deleteStreamLimitConnZoneStat
1266 responses:
1267 '204':
1268 description: Success
1269 '404':
1270 description: limit_conn not found (*LimitConnNotFound*)
1043 schema: 1271 schema:
1044 $ref: '#/definitions/NginxError' 1272 $ref: '#/definitions/NginxError'
1045 '405': 1273 '405':
1046 description: Method disabled (*MethodDisabled*) 1274 description: Method disabled (*MethodDisabled*)
1047 schema: 1275 schema:
2322 bypass: 2550 bypass:
2323 responses: 200187 2551 responses: 200187
2324 bytes: 5510647548 2552 bytes: 5510647548
2325 responses_written: 200173 2553 responses_written: 200173
2326 bytes_written: 44992 2554 bytes_written: 44992
2555 NginxHTTPLimitConnZonesMap:
2556 title: HTTP limit_conns
2557 description: |
2558 Status data for all HTTP
2559 <a href="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zones</a>.
2560 type: object
2561 additionalProperties:
2562 $ref: '#/definitions/NginxHTTPLimitConnZone'
2563 NginxHTTPLimitConnZone:
2564 title: HTTP Connections Limiting
2565 type: object
2566 properties:
2567 passed:
2568 type: integer
2569 description: The total number of connections that were neither limited
2570 nor accounted as limited.
2571 rejected:
2572 type: integer
2573 description: The total number of connections that were rejected.
2574 rejected_dry_run:
2575 type: integer
2576 description: The total number of connections accounted as rejected in the
2577 <a href="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_dry_run">dry run</a>
2578 mode.
2579 example:
2580 passed: 15
2581 rejected: 0
2582 rejected_dry_run: 2
2583 NginxHTTPLimitReqZonesMap:
2584 title: HTTP limit_reqs
2585 description: |
2586 Status data for all HTTP
2587 <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zones</a>.
2588 type: object
2589 additionalProperties:
2590 $ref: '#/definitions/NginxHTTPLimitReqZone'
2591 NginxHTTPLimitReqZone:
2592 title: HTTP Requests Rate Limiting
2593 type: object
2594 properties:
2595 passed:
2596 type: integer
2597 description: The total number of requests that were neither limited
2598 nor accounted as limited.
2599 delayed:
2600 type: integer
2601 description: The total number of requests that were delayed.
2602 rejected:
2603 type: integer
2604 description: The total number of requests that were rejected.
2605 delayed_dry_run:
2606 type: integer
2607 description: The total number of requests accounted as delayed in the
2608 <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</a>
2609 mode.
2610 rejected_dry_run:
2611 type: integer
2612 description: The total number of requests accounted as rejected in the
2613 <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</a>
2614 mode.
2615 example:
2616 passed: 15
2617 delayed: 4
2618 rejected: 0
2619 delayed_dry_run: 1
2620 rejected_dry_run: 2
2327 NginxHTTPUpstreamMap: 2621 NginxHTTPUpstreamMap:
2328 title: HTTP Upstreams 2622 title: HTTP Upstreams
2329 description: | 2623 description: |
2330 Status information of all HTTP 2624 Status information of all HTTP
2331 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">dynamically configurable</a> 2625 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">dynamically configurable</a>
2980 5xx: 0 3274 5xx: 0
2981 total: 155569 3275 total: 155569
2982 discarded: 0 3276 discarded: 0
2983 received: 4200363 3277 received: 4200363
2984 sent: 20489184 3278 sent: 20489184
3279 NginxStreamLimitConnZonesMap:
3280 title: Stream limit_conns
3281 description: |
3282 Status data for all stream
3283 <a href="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zones</a>.
3284 type: object
3285 additionalProperties:
3286 $ref: '#/definitions/NginxStreamLimitConnZone'
3287 NginxStreamLimitConnZone:
3288 title: Stream Connections Limiting
3289 type: object
3290 properties:
3291 passed:
3292 type: integer
3293 description: The total number of connections that were neither limited
3294 nor accounted as limited.
3295 rejected:
3296 type: integer
3297 description: The total number of connections that were rejected.
3298 rejected_dry_run:
3299 type: integer
3300 description: The total number of connections accounted as rejected in the
3301 <a href="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_dry_run">dry run</a>
3302 mode.
3303 example:
3304 passed: 15
3305 rejected: 0
3306 rejected_dry_run: 2
2985 NginxStreamUpstreamMap: 3307 NginxStreamUpstreamMap:
2986 title: Stream Upstreams 3308 title: Stream Upstreams
2987 description: Status information of stream upstream server groups. 3309 description: Status information of stream upstream server groups.
2988 type: object 3310 type: object
2989 additionalProperties: 3311 additionalProperties: