Mercurial > hg > nginx-site

comparison yaml/nginx_api.yaml @ 2499:20dbb29cbe05

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the "Unknown version" error in the API.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 03 Feb 2020 17:04:41 +0000
parents 78d4e25adf49
children 8a9b2efa92aa
comparison
equal deleted inserted replaced
2498:9ceda894f3d7 2499:20dbb29cbe05
52 responses: 52 responses:
53 '200': 53 '200':
54 description: Success 54 description: Success
55 schema: 55 schema:
56 $ref: '#/definitions/ArrayOfStrings' 56 $ref: '#/definitions/ArrayOfStrings'
57 '404':
58 description: Unknown version (*UnknownVersion*)
59 schema:
60 $ref: '#/definitions/NginxError'
57 /nginx: 61 /nginx:
58 get: 62 get:
59 tags: 63 tags:
60 - General Info 64 - General Info
61 - Method GET 65 - Method GET
73 responses: 77 responses:
74 '200': 78 '200':
75 description: Success 79 description: Success
76 schema: 80 schema:
77 $ref: '#/definitions/NginxObject' 81 $ref: '#/definitions/NginxObject'
82 '404':
83 description: Unknown version (*UnknownVersion*)
84 schema:
85 $ref: '#/definitions/NginxError'
78 /processes: 86 /processes:
79 get: 87 get:
80 tags: 88 tags:
81 - Processes 89 - Processes
82 - Method GET 90 - Method GET
89 responses: 97 responses:
90 '200': 98 '200':
91 description: Success 99 description: Success
92 schema: 100 schema:
93 $ref: '#/definitions/NginxProcesses' 101 $ref: '#/definitions/NginxProcesses'
102 '404':
103 description: Unknown version (*UnknownVersion*)
104 schema:
105 $ref: '#/definitions/NginxError'
94 delete: 106 delete:
95 tags: 107 tags:
96 - Processes 108 - Processes
97 - Method DELETE 109 - Method DELETE
98 summary: Reset nginx processes statistics 110 summary: Reset nginx processes statistics
100 child processes. 112 child processes.
101 operationId: deleteProcesses 113 operationId: deleteProcesses
102 responses: 114 responses:
103 '204': 115 '204':
104 description: Success 116 description: Success
117 '404':
118 description: Unknown version (*UnknownVersion*)
119 schema:
120 $ref: '#/definitions/NginxError'
105 /connections: 121 /connections:
106 get: 122 get:
107 tags: 123 tags:
108 - Connections 124 - Connections
109 - Method GET 125 - Method GET
115 responses: 131 responses:
116 '200': 132 '200':
117 description: Success 133 description: Success
118 schema: 134 schema:
119 $ref: '#/definitions/NginxConnections' 135 $ref: '#/definitions/NginxConnections'
136 '404':
137 description: Unknown version (*UnknownVersion*)
138 schema:
139 $ref: '#/definitions/NginxError'
120 parameters: 140 parameters:
121 - in: query 141 - in: query
122 name: fields 142 name: fields
123 type: string 143 type: string
124 description: Limits which fields of the connections statistics will be output. 144 description: Limits which fields of the connections statistics will be output.
131 client connections. 151 client connections.
132 operationId: deleteConnections 152 operationId: deleteConnections
133 responses: 153 responses:
134 '204': 154 '204':
135 description: Success 155 description: Success
156 '404':
157 description: Unknown version (*UnknownVersion*)
158 schema:
159 $ref: '#/definitions/NginxError'
136 /slabs/: 160 /slabs/:
137 get: 161 get:
138 tags: 162 tags:
139 - Slabs 163 - Slabs
140 - Method GET 164 - Method GET
154 responses: 178 responses:
155 '200': 179 '200':
156 description: Success 180 description: Success
157 schema: 181 schema:
158 $ref: '#/definitions/NginxSlabZoneMap' 182 $ref: '#/definitions/NginxSlabZoneMap'
183 '404':
184 description: Unknown version (*UnknownVersion*)
185 schema:
186 $ref: '#/definitions/NginxError'
159 '/slabs/{slabZoneName}': 187 '/slabs/{slabZoneName}':
160 parameters: 188 parameters:
161 - name: slabZoneName 189 - name: slabZoneName
162 in: path 190 in: path
163 description: The name of the shared memory zone with slab allocator. 191 description: The name of the shared memory zone with slab allocator.
182 '200': 210 '200':
183 description: Success 211 description: Success
184 schema: 212 schema:
185 $ref: '#/definitions/NginxSlabZone' 213 $ref: '#/definitions/NginxSlabZone'
186 '404': 214 '404':
187 description: Slab not found (*SlabNotFound*) 215 description: |
216 Slab not found (*SlabNotFound*),
217 unknown version (*UnknownVersion*)
188 schema: 218 schema:
189 $ref: '#/definitions/NginxError' 219 $ref: '#/definitions/NginxError'
190 delete: 220 delete:
191 tags: 221 tags:
192 - Slabs 222 - Slabs
197 operationId: deleteSlabZoneStats 227 operationId: deleteSlabZoneStats
198 responses: 228 responses:
199 '204': 229 '204':
200 description: Success 230 description: Success
201 '404': 231 '404':
202 description: Slab not found (*SlabNotFound*) 232 description: |
233 Slab not found (*SlabNotFound*),
234 unknown version (*UnknownVersion*)
203 schema: 235 schema:
204 $ref: '#/definitions/NginxError' 236 $ref: '#/definitions/NginxError'
205 '405': 237 '405':
206 description: Method disabled (*MethodDisabled*) 238 description: Method disabled (*MethodDisabled*)
207 schema: 239 schema:
219 responses: 251 responses:
220 '200': 252 '200':
221 description: Success 253 description: Success
222 schema: 254 schema:
223 $ref: '#/definitions/ArrayOfStrings' 255 $ref: '#/definitions/ArrayOfStrings'
256 '404':
257 description: Unknown version (*UnknownVersion*)
258 schema:
259 $ref: '#/definitions/NginxError'
224 /http/requests: 260 /http/requests:
225 get: 261 get:
226 tags: 262 tags:
227 - HTTP Requests 263 - HTTP Requests
228 - Method GET 264 - Method GET
240 responses: 276 responses:
241 '200': 277 '200':
242 description: Success 278 description: Success
243 schema: 279 schema:
244 $ref: '#/definitions/NginxHTTPRequests' 280 $ref: '#/definitions/NginxHTTPRequests'
281 '404':
282 description: Unknown version (*UnknownVersion*)
283 schema:
284 $ref: '#/definitions/NginxError'
245 delete: 285 delete:
246 tags: 286 tags:
247 - HTTP Requests 287 - HTTP Requests
248 - Method DELETE 288 - Method DELETE
249 summary: Reset HTTP requests statistics 289 summary: Reset HTTP requests statistics
250 description: Resets the number of total client HTTP requests. 290 description: Resets the number of total client HTTP requests.
251 operationId: deleteHttpRequests 291 operationId: deleteHttpRequests
252 responses: 292 responses:
253 '204': 293 '204':
254 description: Success 294 description: Success
295 '404':
296 description: Unknown version (*UnknownVersion*)
297 schema:
298 $ref: '#/definitions/NginxError'
255 '405': 299 '405':
256 description: Method disabled (*MethodDisabled*) 300 description: Method disabled (*MethodDisabled*)
257 schema: 301 schema:
258 $ref: '#/definitions/NginxError' 302 $ref: '#/definitions/NginxError'
259 /http/server_zones/: 303 /http/server_zones/:
277 responses: 321 responses:
278 '200': 322 '200':
279 description: Success 323 description: Success
280 schema: 324 schema:
281 $ref: '#/definitions/NginxHTTPServerZonesMap' 325 $ref: '#/definitions/NginxHTTPServerZonesMap'
326 '404':
327 description: Unknown version (*UnknownVersion*)
328 schema:
329 $ref: '#/definitions/NginxError'
282 '/http/server_zones/{httpServerZoneName}': 330 '/http/server_zones/{httpServerZoneName}':
283 parameters: 331 parameters:
284 - name: httpServerZoneName 332 - name: httpServerZoneName
285 in: path 333 in: path
286 description: The name of an HTTP server zone. 334 description: The name of an HTTP server zone.
304 '200': 352 '200':
305 description: Success 353 description: Success
306 schema: 354 schema:
307 $ref: '#/definitions/NginxHTTPServerZone' 355 $ref: '#/definitions/NginxHTTPServerZone'
308 '404': 356 '404':
309 description: Server zone not found (*ServerZoneNotFound*) 357 description: |
358 Server zone not found (*ServerZoneNotFound*),
359 unknown version (*UnknownVersion*)
310 schema: 360 schema:
311 $ref: '#/definitions/NginxError' 361 $ref: '#/definitions/NginxError'
312 delete: 362 delete:
313 tags: 363 tags:
314 - HTTP Server Zones 364 - HTTP Server Zones
319 operationId: deleteHttpServerZoneStat 369 operationId: deleteHttpServerZoneStat
320 responses: 370 responses:
321 '204': 371 '204':
322 description: Success 372 description: Success
323 '404': 373 '404':
324 description: Server zone not found (*ServerZoneNotFound*) 374 description: |
375 Server zone not found (*ServerZoneNotFound*),
376 unknown version (*UnknownVersion*)
325 schema: 377 schema:
326 $ref: '#/definitions/NginxError' 378 $ref: '#/definitions/NginxError'
327 '405': 379 '405':
328 description: Method disabled (*MethodDisabled*) 380 description: Method disabled (*MethodDisabled*)
329 schema: 381 schema:
349 responses: 401 responses:
350 '200': 402 '200':
351 description: Success 403 description: Success
352 schema: 404 schema:
353 $ref: '#/definitions/NginxHTTPLocationZonesMap' 405 $ref: '#/definitions/NginxHTTPLocationZonesMap'
406 '404':
407 description: Unknown version (*UnknownVersion*)
408 schema:
409 $ref: '#/definitions/NginxError'
354 '/http/location_zones/{httpLocationZoneName}': 410 '/http/location_zones/{httpLocationZoneName}':
355 parameters: 411 parameters:
356 - name: httpLocationZoneName 412 - name: httpLocationZoneName
357 in: path 413 in: path
358 description: The name of an HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location). 414 description: The name of an HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
377 '200': 433 '200':
378 description: Success 434 description: Success
379 schema: 435 schema:
380 $ref: '#/definitions/NginxHTTPLocationZone' 436 $ref: '#/definitions/NginxHTTPLocationZone'
381 '404': 437 '404':
382 description: Location zone not found (*LocationZoneNotFound*) 438 description: |
439 Location zone not found (*LocationZoneNotFound*),
440 unknown version (*UnknownVersion*)
383 schema: 441 schema:
384 $ref: '#/definitions/NginxError' 442 $ref: '#/definitions/NginxError'
385 delete: 443 delete:
386 tags: 444 tags:
387 - HTTP Location Zones 445 - HTTP Location Zones
392 operationId: deleteHttpLocationZoneStat 450 operationId: deleteHttpLocationZoneStat
393 responses: 451 responses:
394 '204': 452 '204':
395 description: Success 453 description: Success
396 '404': 454 '404':
397 description: Location zone not found (*LocationZoneNotFound*) 455 description: |
456 Location zone not found (*LocationZoneNotFound*),
457 unknown version (*UnknownVersion*)
398 schema: 458 schema:
399 $ref: '#/definitions/NginxError' 459 $ref: '#/definitions/NginxError'
400 '405': 460 '405':
401 description: Method disabled (*MethodDisabled*) 461 description: Method disabled (*MethodDisabled*)
402 schema: 462 schema:
423 responses: 483 responses:
424 '200': 484 '200':
425 description: Success 485 description: Success
426 schema: 486 schema:
427 $ref: '#/definitions/NginxHTTPCachesMap' 487 $ref: '#/definitions/NginxHTTPCachesMap'
488 '404':
489 description: Unknown version (*UnknownVersion*)
490 schema:
491 $ref: '#/definitions/NginxError'
428 '/http/caches/{httpCacheZoneName}': 492 '/http/caches/{httpCacheZoneName}':
429 parameters: 493 parameters:
430 - name: httpCacheZoneName 494 - name: httpCacheZoneName
431 in: path 495 in: path
432 description: The name of the cache zone. 496 description: The name of the cache zone.
450 '200': 514 '200':
451 description: Success 515 description: Success
452 schema: 516 schema:
453 $ref: '#/definitions/NginxHTTPCache' 517 $ref: '#/definitions/NginxHTTPCache'
454 '404': 518 '404':
455 description: Cache not found (*CacheNotFound*) 519 description: |
520 Cache not found (*CacheNotFound*),
521 unknown version (*UnknownVersion*)
456 schema: 522 schema:
457 $ref: '#/definitions/NginxError' 523 $ref: '#/definitions/NginxError'
458 delete: 524 delete:
459 tags: 525 tags:
460 - HTTP Caches 526 - HTTP Caches
464 operationId: deleteHttpCacheZoneStat 530 operationId: deleteHttpCacheZoneStat
465 responses: 531 responses:
466 '204': 532 '204':
467 description: Success 533 description: Success
468 '404': 534 '404':
469 description: Cache not found (*CacheNotFound*) 535 description: |
536 Cache not found (*CacheNotFound*),
537 unknown version (*UnknownVersion*)
470 schema: 538 schema:
471 $ref: '#/definitions/NginxError' 539 $ref: '#/definitions/NginxError'
472 '405': 540 '405':
473 description: Method disabled (*MethodDisabled*) 541 description: Method disabled (*MethodDisabled*)
474 schema: 542 schema:
494 responses: 562 responses:
495 '200': 563 '200':
496 description: Success 564 description: Success
497 schema: 565 schema:
498 $ref: '#/definitions/NginxHTTPLimitConnZonesMap' 566 $ref: '#/definitions/NginxHTTPLimitConnZonesMap'
567 '404':
568 description: Unknown version (*UnknownVersion*)
569 schema:
570 $ref: '#/definitions/NginxError'
499 '/http/limit_conns/{httpLimitConnZoneName}': 571 '/http/limit_conns/{httpLimitConnZoneName}':
500 parameters: 572 parameters:
501 - name: httpLimitConnZoneName 573 - name: httpLimitConnZoneName
502 in: path 574 in: path
503 description: The name of a 575 description: The name of a
525 '200': 597 '200':
526 description: Success 598 description: Success
527 schema: 599 schema:
528 $ref: '#/definitions/NginxHTTPLimitConnZone' 600 $ref: '#/definitions/NginxHTTPLimitConnZone'
529 '404': 601 '404':
530 description: limit_conn not found (*LimitConnNotFound*) 602 description: |
603 limit_conn not found (*LimitConnNotFound*),
604 unknown version (*UnknownVersion*)
531 schema: 605 schema:
532 $ref: '#/definitions/NginxError' 606 $ref: '#/definitions/NginxError'
533 delete: 607 delete:
534 tags: 608 tags:
535 - HTTP Limit Conns 609 - HTTP Limit Conns
539 operationId: deleteHttpLimitConnZoneStat 613 operationId: deleteHttpLimitConnZoneStat
540 responses: 614 responses:
541 '204': 615 '204':
542 description: Success 616 description: Success
543 '404': 617 '404':
544 description: limit_conn not found (*LimitConnNotFound*) 618 description: |
619 limit_conn not found (*LimitConnNotFound*),
620 unknown version (*UnknownVersion*)
545 schema: 621 schema:
546 $ref: '#/definitions/NginxError' 622 $ref: '#/definitions/NginxError'
547 '405': 623 '405':
548 description: Method disabled (*MethodDisabled*) 624 description: Method disabled (*MethodDisabled*)
549 schema: 625 schema:
569 responses: 645 responses:
570 '200': 646 '200':
571 description: Success 647 description: Success
572 schema: 648 schema:
573 $ref: '#/definitions/NginxHTTPLimitReqZonesMap' 649 $ref: '#/definitions/NginxHTTPLimitReqZonesMap'
650 '404':
651 description: Unknown version (*UnknownVersion*)
652 schema:
653 $ref: '#/definitions/NginxError'
574 '/http/limit_reqs/{httpLimitReqZoneName}': 654 '/http/limit_reqs/{httpLimitReqZoneName}':
575 parameters: 655 parameters:
576 - name: httpLimitReqZoneName 656 - name: httpLimitReqZoneName
577 in: path 657 in: path
578 description: The name of a 658 description: The name of a
600 '200': 680 '200':
601 description: Success 681 description: Success
602 schema: 682 schema:
603 $ref: '#/definitions/NginxHTTPLimitReqZone' 683 $ref: '#/definitions/NginxHTTPLimitReqZone'
604 '404': 684 '404':
605 description: limit_req not found (*LimitReqNotFound*) 685 description: |
686 limit_req not found (*LimitReqNotFound*),
687 unknown version (*UnknownVersion*)
606 schema: 688 schema:
607 $ref: '#/definitions/NginxError' 689 $ref: '#/definitions/NginxError'
608 delete: 690 delete:
609 tags: 691 tags:
610 - HTTP Limit Reqs 692 - HTTP Limit Reqs
614 operationId: deleteHttpLimitReqZoneStat 696 operationId: deleteHttpLimitReqZoneStat
615 responses: 697 responses:
616 '204': 698 '204':
617 description: Success 699 description: Success
618 '404': 700 '404':
619 description: limit_req not found (*LimitReqNotFound*) 701 description: |
702 limit_req not found (*LimitReqNotFound*),
703 unknown version (*UnknownVersion*)
620 schema: 704 schema:
621 $ref: '#/definitions/NginxError' 705 $ref: '#/definitions/NginxError'
622 '405': 706 '405':
623 description: Method disabled (*MethodDisabled*) 707 description: Method disabled (*MethodDisabled*)
624 schema: 708 schema:
644 responses: 728 responses:
645 '200': 729 '200':
646 description: Success 730 description: Success
647 schema: 731 schema:
648 $ref: '#/definitions/NginxHTTPUpstreamMap' 732 $ref: '#/definitions/NginxHTTPUpstreamMap'
733 '404':
734 description: Unknown version (*UnknownVersion*)
735 schema:
736 $ref: '#/definitions/NginxError'
649 '/http/upstreams/{httpUpstreamName}/': 737 '/http/upstreams/{httpUpstreamName}/':
650 parameters: 738 parameters:
651 - name: httpUpstreamName 739 - name: httpUpstreamName
652 in: path 740 in: path
653 description: The name of an HTTP upstream server group. 741 description: The name of an HTTP upstream server group.
676 '400': 764 '400':
677 description: Upstream is static (*UpstreamStatic*) 765 description: Upstream is static (*UpstreamStatic*)
678 schema: 766 schema:
679 $ref: '#/definitions/NginxError' 767 $ref: '#/definitions/NginxError'
680 '404': 768 '404':
681 description: Upstream not found (*UpstreamNotFound*) 769 description: |
770 Unknown version (*UnknownVersion*),
771 upstream not found (*UpstreamNotFound*)
682 schema: 772 schema:
683 $ref: '#/definitions/NginxError' 773 $ref: '#/definitions/NginxError'
684 delete: 774 delete:
685 tags: 775 tags:
686 - HTTP Upstreams 776 - HTTP Upstreams
697 '400': 787 '400':
698 description: Upstream is static (*UpstreamStatic*) 788 description: Upstream is static (*UpstreamStatic*)
699 schema: 789 schema:
700 $ref: '#/definitions/NginxError' 790 $ref: '#/definitions/NginxError'
701 '404': 791 '404':
702 description: Upstream not found (*UpstreamNotFound*) 792 description: |
793 Unknown version (*UnknownVersion*),
794 upstream not found (*UpstreamNotFound*)
703 schema: 795 schema:
704 $ref: '#/definitions/NginxError' 796 $ref: '#/definitions/NginxError'
705 '405': 797 '405':
706 description: Method disabled (*MethodDisabled*) 798 description: Method disabled (*MethodDisabled*)
707 schema: 799 schema:
731 '400': 823 '400':
732 description: Upstream is static (*UpstreamStatic*) 824 description: Upstream is static (*UpstreamStatic*)
733 schema: 825 schema:
734 $ref: '#/definitions/NginxError' 826 $ref: '#/definitions/NginxError'
735 '404': 827 '404':
736 description: Upstream not found (*UpstreamNotFound*) 828 description: |
829 Unknown version (*UnknownVersion*),
830 upstream not found (*UpstreamNotFound*)
737 schema: 831 schema:
738 $ref: '#/definitions/NginxError' 832 $ref: '#/definitions/NginxError'
739 post: 833 post:
740 tags: 834 tags:
741 - HTTP Upstreams 835 - HTTP Upstreams
783 upstream “**name**” has no backup (*UpstreamNoBackup*), 877 upstream “**name**” has no backup (*UpstreamNoBackup*),
784 upstream “**name**” memory exhausted (*UpstreamOutOfMemory*) 878 upstream “**name**” memory exhausted (*UpstreamOutOfMemory*)
785 schema: 879 schema:
786 $ref: '#/definitions/NginxError' 880 $ref: '#/definitions/NginxError'
787 '404': 881 '404':
788 description: Upstream not found (*UpstreamNotFound*) 882 description: |
883 Unknown version (*UnknownVersion*),
884 upstream not found (*UpstreamNotFound*)
789 schema: 885 schema:
790 $ref: '#/definitions/NginxError' 886 $ref: '#/definitions/NginxError'
791 '405': 887 '405':
792 description: Method disabled (*MethodDisabled*) 888 description: Method disabled (*MethodDisabled*)
793 schema: 889 schema:
829 invalid server ID (*UpstreamBadServerId*) 925 invalid server ID (*UpstreamBadServerId*)
830 schema: 926 schema:
831 $ref: '#/definitions/NginxError' 927 $ref: '#/definitions/NginxError'
832 '404': 928 '404':
833 description: | 929 description: |
834 Upstream not found (*UpstreamNotFound*), 930 Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
835 server with ID “**id**” does not exist (*UpstreamServerNotFound*) 931 unknown version (*UnknownVersion*),
932 upstream not found (*UpstreamNotFound*)
836 schema: 933 schema:
837 $ref: '#/definitions/NginxError' 934 $ref: '#/definitions/NginxError'
838 patch: 935 patch:
839 tags: 936 tags:
840 - HTTP Upstreams 937 - HTTP Upstreams
882 upstream “*name*” memory exhausted (*UpstreamOutOfMemory*) 979 upstream “*name*” memory exhausted (*UpstreamOutOfMemory*)
883 schema: 980 schema:
884 $ref: '#/definitions/NginxError' 981 $ref: '#/definitions/NginxError'
885 '404': 982 '404':
886 description: | 983 description: |
887 Upstream not found (*UpstreamNotFound*), 984 Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
888 server with ID “**id**” does not exist (*UpstreamServerNotFound*) 985 unknown version (*UnknownVersion*),
986 upstream not found (*UpstreamNotFound*)
889 schema: 987 schema:
890 $ref: '#/definitions/NginxError' 988 $ref: '#/definitions/NginxError'
891 '405': 989 '405':
892 description: Method disabled (*MethodDisabled*) 990 description: Method disabled (*MethodDisabled*)
893 schema: 991 schema:
917 server “**id**” not removable (*UpstreamServerImmutable*) 1015 server “**id**” not removable (*UpstreamServerImmutable*)
918 schema: 1016 schema:
919 $ref: '#/definitions/NginxError' 1017 $ref: '#/definitions/NginxError'
920 '404': 1018 '404':
921 description: | 1019 description: |
922 Upstream not found (*UpstreamNotFound*), 1020 Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
923 server with ID “**id**” does not exist (*UpstreamServerNotFound*) 1021 unknown version (*UnknownVersion*),
1022 upstream not found (*UpstreamNotFound*)
924 schema: 1023 schema:
925 $ref: '#/definitions/NginxError' 1024 $ref: '#/definitions/NginxError'
926 '405': 1025 '405':
927 description: Method disabled (*MethodDisabled*) 1026 description: Method disabled (*MethodDisabled*)
928 schema: 1027 schema:
947 responses: 1046 responses:
948 '200': 1047 '200':
949 description: Success 1048 description: Success
950 schema: 1049 schema:
951 $ref: '#/definitions/NginxHTTPKeyvalZonesMap' 1050 $ref: '#/definitions/NginxHTTPKeyvalZonesMap'
1051 '404':
1052 description: Unknown version (*UnknownVersion*)
1053 schema:
1054 $ref: '#/definitions/NginxError'
952 '/http/keyvals/{httpKeyvalZoneName}': 1055 '/http/keyvals/{httpKeyvalZoneName}':
953 parameters: 1056 parameters:
954 - name: httpKeyvalZoneName 1057 - name: httpKeyvalZoneName
955 in: path 1058 in: path
956 description: The name of an HTTP keyval shared memory zone. 1059 description: The name of an HTTP keyval shared memory zone.
977 schema: 1080 schema:
978 $ref: '#/definitions/NginxHTTPKeyvalZone' 1081 $ref: '#/definitions/NginxHTTPKeyvalZone'
979 '404': 1082 '404':
980 description: | 1083 description: |
981 Keyval not found (*KeyvalNotFound*), 1084 Keyval not found (*KeyvalNotFound*),
982 keyval key not found (*KeyvalKeyNotFound*) 1085 keyval key not found (*KeyvalKeyNotFound*),
1086 unknown version (*UnknownVersion*)
983 schema: 1087 schema:
984 $ref: '#/definitions/NginxError' 1088 $ref: '#/definitions/NginxError'
985 post: 1089 post:
986 tags: 1090 tags:
987 - HTTP Keyvals 1091 - HTTP Keyvals
1021 only one key can be added (*KeyvalFormatError*), 1125 only one key can be added (*KeyvalFormatError*),
1022 reading request body failed *BodyReadError*) 1126 reading request body failed *BodyReadError*)
1023 schema: 1127 schema:
1024 $ref: '#/definitions/NginxError' 1128 $ref: '#/definitions/NginxError'
1025 '404': 1129 '404':
1026 description: Keyval not found (*KeyvalNotFound*) 1130 description: |
1131 Keyval not found (*KeyvalNotFound*),
1132 unknown version (*UnknownVersion*)
1027 schema: 1133 schema:
1028 $ref: '#/definitions/NginxError' 1134 $ref: '#/definitions/NginxError'
1029 '405': 1135 '405':
1030 description: Method disabled (*MethodDisabled*) 1136 description: Method disabled (*MethodDisabled*)
1031 schema: 1137 schema:
1083 schema: 1189 schema:
1084 $ref: '#/definitions/NginxError' 1190 $ref: '#/definitions/NginxError'
1085 '404': 1191 '404':
1086 description: | 1192 description: |
1087 Keyval not found (*KeyvalNotFound*), 1193 Keyval not found (*KeyvalNotFound*),
1088 keyval key not found (*KeyvalKeyNotFound*) 1194 keyval key not found (*KeyvalKeyNotFound*),
1195 unknown version (*UnknownVersion*)
1089 schema: 1196 schema:
1090 $ref: '#/definitions/NginxError' 1197 $ref: '#/definitions/NginxError'
1091 '405': 1198 '405':
1092 description: Method disabled (*MethodDisabled*) 1199 description: Method disabled (*MethodDisabled*)
1093 schema: 1200 schema:
1114 operationId: deleteHttpKeyvalZoneData 1221 operationId: deleteHttpKeyvalZoneData
1115 responses: 1222 responses:
1116 '204': 1223 '204':
1117 description: Success 1224 description: Success
1118 '404': 1225 '404':
1119 description: Keyval not found (*KeyvalNotFound*) 1226 description: |
1227 Keyval not found (*KeyvalNotFound*),
1228 unknown version (*UnknownVersion*)
1120 schema: 1229 schema:
1121 $ref: '#/definitions/NginxError' 1230 $ref: '#/definitions/NginxError'
1122 '405': 1231 '405':
1123 description: Method disabled (*MethodDisabled*) 1232 description: Method disabled (*MethodDisabled*)
1124 schema: 1233 schema:
1135 responses: 1244 responses:
1136 '200': 1245 '200':
1137 description: Success 1246 description: Success
1138 schema: 1247 schema:
1139 $ref: '#/definitions/ArrayOfStrings' 1248 $ref: '#/definitions/ArrayOfStrings'
1249 '404':
1250 description: Unknown version (*UnknownVersion*)
1251 schema:
1252 $ref: '#/definitions/NginxError'
1140 /stream/server_zones/: 1253 /stream/server_zones/:
1141 get: 1254 get:
1142 tags: 1255 tags:
1143 - Stream Server Zones 1256 - Stream Server Zones
1144 - Method GET 1257 - Method GET
1158 responses: 1271 responses:
1159 '200': 1272 '200':
1160 description: Success 1273 description: Success
1161 schema: 1274 schema:
1162 $ref: '#/definitions/NginxStreamServerZonesMap' 1275 $ref: '#/definitions/NginxStreamServerZonesMap'
1276 '404':
1277 description: Unknown version (*UnknownVersion*)
1278 schema:
1279 $ref: '#/definitions/NginxError'
1163 '/stream/server_zones/{streamServerZoneName}': 1280 '/stream/server_zones/{streamServerZoneName}':
1164 parameters: 1281 parameters:
1165 - name: streamServerZoneName 1282 - name: streamServerZoneName
1166 in: path 1283 in: path
1167 description: The name of a stream server zone. 1284 description: The name of a stream server zone.
1186 description: Success 1303 description: Success
1187 schema: 1304 schema:
1188 $ref: '#/definitions/NginxStreamServerZone' 1305 $ref: '#/definitions/NginxStreamServerZone'
1189 '404': 1306 '404':
1190 description: | 1307 description: |
1191 Server zone not found (*ServerZoneNotFound*) 1308 Server zone not found (*ServerZoneNotFound*),
1309 unknown version (*UnknownVersion*)
1192 schema: 1310 schema:
1193 $ref: '#/definitions/NginxError' 1311 $ref: '#/definitions/NginxError'
1194 delete: 1312 delete:
1195 tags: 1313 tags:
1196 - Stream Server Zones 1314 - Stream Server Zones
1202 responses: 1320 responses:
1203 '204': 1321 '204':
1204 description: Success 1322 description: Success
1205 '404': 1323 '404':
1206 description: | 1324 description: |
1207 Server zone not found (*ServerZoneNotFound*) 1325 Server zone not found (*ServerZoneNotFound*),
1326 unknown version (*UnknownVersion*)
1208 schema: 1327 schema:
1209 $ref: '#/definitions/NginxError' 1328 $ref: '#/definitions/NginxError'
1210 '405': 1329 '405':
1211 description: Method disabled (*MethodDisabled*) 1330 description: Method disabled (*MethodDisabled*)
1212 schema: 1331 schema:
1232 responses: 1351 responses:
1233 '200': 1352 '200':
1234 description: Success 1353 description: Success
1235 schema: 1354 schema:
1236 $ref: '#/definitions/NginxStreamLimitConnZonesMap' 1355 $ref: '#/definitions/NginxStreamLimitConnZonesMap'
1356 '404':
1357 description: Unknown version (*UnknownVersion*)
1358 schema:
1359 $ref: '#/definitions/NginxError'
1237 '/stream/limit_conns/{streamLimitConnZoneName}': 1360 '/stream/limit_conns/{streamLimitConnZoneName}':
1238 parameters: 1361 parameters:
1239 - name: streamLimitConnZoneName 1362 - name: streamLimitConnZoneName
1240 in: path 1363 in: path
1241 description: The name of a 1364 description: The name of a
1263 '200': 1386 '200':
1264 description: Success 1387 description: Success
1265 schema: 1388 schema:
1266 $ref: '#/definitions/NginxStreamLimitConnZone' 1389 $ref: '#/definitions/NginxStreamLimitConnZone'
1267 '404': 1390 '404':
1268 description: limit_conn not found (*LimitConnNotFound*) 1391 description: |
1392 limit_conn not found (*LimitConnNotFound*),
1393 unknown version (*UnknownVersion*)
1269 schema: 1394 schema:
1270 $ref: '#/definitions/NginxError' 1395 $ref: '#/definitions/NginxError'
1271 delete: 1396 delete:
1272 tags: 1397 tags:
1273 - Stream Limit Conns 1398 - Stream Limit Conns
1277 operationId: deleteStreamLimitConnZoneStat 1402 operationId: deleteStreamLimitConnZoneStat
1278 responses: 1403 responses:
1279 '204': 1404 '204':
1280 description: Success 1405 description: Success
1281 '404': 1406 '404':
1282 description: limit_conn not found (*LimitConnNotFound*) 1407 description: |
1408 limit_conn not found (*LimitConnNotFound*),
1409 unknown version (*UnknownVersion*)
1283 schema: 1410 schema:
1284 $ref: '#/definitions/NginxError' 1411 $ref: '#/definitions/NginxError'
1285 '405': 1412 '405':
1286 description: Method disabled (*MethodDisabled*) 1413 description: Method disabled (*MethodDisabled*)
1287 schema: 1414 schema:
1307 responses: 1434 responses:
1308 '200': 1435 '200':
1309 description: Success 1436 description: Success
1310 schema: 1437 schema:
1311 $ref: '#/definitions/NginxStreamUpstreamMap' 1438 $ref: '#/definitions/NginxStreamUpstreamMap'
1439 '404':
1440 description: Unknown version (*UnknownVersion*)
1441 schema:
1442 $ref: '#/definitions/NginxError'
1312 '/stream/upstreams/{streamUpstreamName}/': 1443 '/stream/upstreams/{streamUpstreamName}/':
1313 parameters: 1444 parameters:
1314 - name: streamUpstreamName 1445 - name: streamUpstreamName
1315 in: path 1446 in: path
1316 description: The name of a stream upstream server group. 1447 description: The name of a stream upstream server group.
1340 description: Upstream is static (*UpstreamStatic*) 1471 description: Upstream is static (*UpstreamStatic*)
1341 schema: 1472 schema:
1342 $ref: '#/definitions/NginxError' 1473 $ref: '#/definitions/NginxError'
1343 '404': 1474 '404':
1344 description: | 1475 description: |
1345 Upstream not found (*UpstreamNotFound*) 1476 Unknown version (*UnknownVersion*),
1477 upstream not found (*UpstreamNotFound*)
1346 schema: 1478 schema:
1347 $ref: '#/definitions/NginxError' 1479 $ref: '#/definitions/NginxError'
1348 delete: 1480 delete:
1349 tags: 1481 tags:
1350 - Stream Upstreams 1482 - Stream Upstreams
1362 description: Upstream is static (*UpstreamStatic*) 1494 description: Upstream is static (*UpstreamStatic*)
1363 schema: 1495 schema:
1364 $ref: '#/definitions/NginxError' 1496 $ref: '#/definitions/NginxError'
1365 '404': 1497 '404':
1366 description: | 1498 description: |
1367 Upstream not found (*UpstreamNotFound*) 1499 Unknown version (*UnknownVersion*),
1500 upstream not found (*UpstreamNotFound*)
1368 schema: 1501 schema:
1369 $ref: '#/definitions/NginxError' 1502 $ref: '#/definitions/NginxError'
1370 '405': 1503 '405':
1371 description: Method disabled (*MethodDisabled*) 1504 description: Method disabled (*MethodDisabled*)
1372 schema: 1505 schema:
1397 description: Upstream is static (*UpstreamStatic*) 1530 description: Upstream is static (*UpstreamStatic*)
1398 schema: 1531 schema:
1399 $ref: '#/definitions/NginxError' 1532 $ref: '#/definitions/NginxError'
1400 '404': 1533 '404':
1401 description: | 1534 description: |
1402 Upstream not found (*UpstreamNotFound*) 1535 Unknown version (*UnknownVersion*),
1536 upstream not found (*UpstreamNotFound*)
1403 schema: 1537 schema:
1404 $ref: '#/definitions/NginxError' 1538 $ref: '#/definitions/NginxError'
1405 post: 1539 post:
1406 tags: 1540 tags:
1407 - Stream Upstreams 1541 - Stream Upstreams
1450 reading request body failed *BodyReadError*) 1584 reading request body failed *BodyReadError*)
1451 schema: 1585 schema:
1452 $ref: '#/definitions/NginxError' 1586 $ref: '#/definitions/NginxError'
1453 '404': 1587 '404':
1454 description: | 1588 description: |
1455 Upstream not found (*UpstreamNotFound*) 1589 Unknown version (*UnknownVersion*),
1590 upstream not found (*UpstreamNotFound*)
1456 schema: 1591 schema:
1457 $ref: '#/definitions/NginxError' 1592 $ref: '#/definitions/NginxError'
1458 '405': 1593 '405':
1459 description: Method disabled (*MethodDisabled*) 1594 description: Method disabled (*MethodDisabled*)
1460 schema: 1595 schema:
1496 invalid server ID (*UpstreamBadServerId*) 1631 invalid server ID (*UpstreamBadServerId*)
1497 schema: 1632 schema:
1498 $ref: '#/definitions/NginxError' 1633 $ref: '#/definitions/NginxError'
1499 '404': 1634 '404':
1500 description: | 1635 description: |
1501 Upstream not found (*UpstreamNotFound*), 1636 Unknown version (*UnknownVersion*),
1637 upstream not found (*UpstreamNotFound*),
1502 server with ID “**id**” does not exist (*UpstreamServerNotFound*) 1638 server with ID “**id**” does not exist (*UpstreamServerNotFound*)
1503 schema: 1639 schema:
1504 $ref: '#/definitions/NginxError' 1640 $ref: '#/definitions/NginxError'
1505 patch: 1641 patch:
1506 tags: 1642 tags:
1549 upstream “*name*” memory exhausted (*UpstreamOutOfMemory*) 1685 upstream “*name*” memory exhausted (*UpstreamOutOfMemory*)
1550 schema: 1686 schema:
1551 $ref: '#/definitions/NginxError' 1687 $ref: '#/definitions/NginxError'
1552 '404': 1688 '404':
1553 description: | 1689 description: |
1554 Upstream not found (*UpstreamNotFound*), 1690 Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1555 server with ID “**id**” does not exist (*UpstreamServerNotFound*) 1691 unknown version (*UnknownVersion*),
1692 upstream not found (*UpstreamNotFound*)
1556 schema: 1693 schema:
1557 $ref: '#/definitions/NginxError' 1694 $ref: '#/definitions/NginxError'
1558 '405': 1695 '405':
1559 description: Method disabled (*MethodDisabled*) 1696 description: Method disabled (*MethodDisabled*)
1560 schema: 1697 schema:
1584 server “**id**” not removable (*UpstreamServerImmutable*) 1721 server “**id**” not removable (*UpstreamServerImmutable*)
1585 schema: 1722 schema:
1586 $ref: '#/definitions/NginxError' 1723 $ref: '#/definitions/NginxError'
1587 '404': 1724 '404':
1588 description: | 1725 description: |
1589 Upstream not found (*UpstreamNotFound*), 1726 Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1590 server with ID “**id**” does not exist (*UpstreamServerNotFound*) 1727 unknown version (*UnknownVersion*),
1728 upstream not found (*UpstreamNotFound*)
1591 schema: 1729 schema:
1592 $ref: '#/definitions/NginxError' 1730 $ref: '#/definitions/NginxError'
1593 '405': 1731 '405':
1594 description: Method disabled (*MethodDisabled*) 1732 description: Method disabled (*MethodDisabled*)
1595 schema: 1733 schema:
1614 responses: 1752 responses:
1615 '200': 1753 '200':
1616 description: Success 1754 description: Success
1617 schema: 1755 schema:
1618 $ref: '#/definitions/NginxStreamKeyvalZonesMap' 1756 $ref: '#/definitions/NginxStreamKeyvalZonesMap'
1757 '404':
1758 description: Unknown version (*UnknownVersion*)
1759 schema:
1760 $ref: '#/definitions/NginxError'
1619 '/stream/keyvals/{streamKeyvalZoneName}': 1761 '/stream/keyvals/{streamKeyvalZoneName}':
1620 parameters: 1762 parameters:
1621 - name: streamKeyvalZoneName 1763 - name: streamKeyvalZoneName
1622 in: path 1764 in: path
1623 description: The name of a stream keyval shared memory zone. 1765 description: The name of a stream keyval shared memory zone.
1644 schema: 1786 schema:
1645 $ref: '#/definitions/NginxStreamKeyvalZone' 1787 $ref: '#/definitions/NginxStreamKeyvalZone'
1646 '404': 1788 '404':
1647 description: | 1789 description: |
1648 Keyval not found (*KeyvalNotFound*), 1790 Keyval not found (*KeyvalNotFound*),
1649 keyval key not found (*KeyvalKeyNotFound*) 1791 keyval key not found (*KeyvalKeyNotFound*),
1792 unknown version (*UnknownVersion*)
1650 schema: 1793 schema:
1651 $ref: '#/definitions/NginxError' 1794 $ref: '#/definitions/NginxError'
1652 post: 1795 post:
1653 tags: 1796 tags:
1654 - Stream Keyvals 1797 - Stream Keyvals
1689 reading request body failed *BodyReadError*) 1832 reading request body failed *BodyReadError*)
1690 schema: 1833 schema:
1691 $ref: '#/definitions/NginxError' 1834 $ref: '#/definitions/NginxError'
1692 '404': 1835 '404':
1693 description: | 1836 description: |
1694 Keyval not found (*KeyvalNotFound*) 1837 Keyval not found (*KeyvalNotFound*),
1838 unknown version (*UnknownVersion*)
1695 schema: 1839 schema:
1696 $ref: '#/definitions/NginxError' 1840 $ref: '#/definitions/NginxError'
1697 '405': 1841 '405':
1698 description: Method disabled (*MethodDisabled*) 1842 description: Method disabled (*MethodDisabled*)
1699 schema: 1843 schema:
1751 schema: 1895 schema:
1752 $ref: '#/definitions/NginxError' 1896 $ref: '#/definitions/NginxError'
1753 '404': 1897 '404':
1754 description: | 1898 description: |
1755 Keyval not found (*KeyvalNotFound*), 1899 Keyval not found (*KeyvalNotFound*),
1756 keyval key not found (*KeyvalKeyNotFound*) 1900 keyval key not found (*KeyvalKeyNotFound*),
1901 unknown version (*UnknownVersion*)
1757 schema: 1902 schema:
1758 $ref: '#/definitions/NginxError' 1903 $ref: '#/definitions/NginxError'
1759 '405': 1904 '405':
1760 description: Method disabled (*MethodDisabled*) 1905 description: Method disabled (*MethodDisabled*)
1761 schema: 1906 schema:
1783 responses: 1928 responses:
1784 '204': 1929 '204':
1785 description: Success 1930 description: Success
1786 '404': 1931 '404':
1787 description: | 1932 description: |
1788 Keyval not found (*KeyvalNotFound*) 1933 Keyval not found (*KeyvalNotFound*),
1934 unknown version (*UnknownVersion*)
1789 schema: 1935 schema:
1790 $ref: '#/definitions/NginxError' 1936 $ref: '#/definitions/NginxError'
1791 '405': 1937 '405':
1792 description: Method disabled (*MethodDisabled*) 1938 description: Method disabled (*MethodDisabled*)
1793 schema: 1939 schema:
1805 responses: 1951 responses:
1806 '200': 1952 '200':
1807 description: Success 1953 description: Success
1808 schema: 1954 schema:
1809 $ref: '#/definitions/NginxStreamZoneSync' 1955 $ref: '#/definitions/NginxStreamZoneSync'
1956 '404':
1957 description: Unknown version (*UnknownVersion*)
1958 schema:
1959 $ref: '#/definitions/NginxError'
1810 /resolvers/: 1960 /resolvers/:
1811 get: 1961 get:
1812 tags: 1962 tags:
1813 - Resolvers 1963 - Resolvers
1814 - Method GET 1964 - Method GET
1821 responses: 1971 responses:
1822 '200': 1972 '200':
1823 description: Success 1973 description: Success
1824 schema: 1974 schema:
1825 $ref: '#/definitions/NginxResolverZonesMap' 1975 $ref: '#/definitions/NginxResolverZonesMap'
1976 '404':
1977 description: Unknown version (*UnknownVersion*)
1978 schema:
1979 $ref: '#/definitions/NginxError'
1826 parameters: 1980 parameters:
1827 - in: query 1981 - in: query
1828 name: fields 1982 name: fields
1829 type: string 1983 type: string
1830 description: Limits which fields of resolvers statistics will be output. 1984 description: Limits which fields of resolvers statistics will be output.
1856 description: Success 2010 description: Success
1857 schema: 2011 schema:
1858 $ref: '#/definitions/NginxResolverZone' 2012 $ref: '#/definitions/NginxResolverZone'
1859 '404': 2013 '404':
1860 description: | 2014 description: |
1861 Resolver zone not found (*ResolverZoneNotFound*) 2015 Resolver zone not found (*ResolverZoneNotFound*),
2016 unknown version (*UnknownVersion*)
1862 schema: 2017 schema:
1863 $ref: '#/definitions/NginxError' 2018 $ref: '#/definitions/NginxError'
1864 delete: 2019 delete:
1865 tags: 2020 tags:
1866 - Resolvers 2021 - Resolvers
1870 operationId: deleteResolverZoneStat 2025 operationId: deleteResolverZoneStat
1871 responses: 2026 responses:
1872 '204': 2027 '204':
1873 description: Success 2028 description: Success
1874 '404': 2029 '404':
1875 description: Resolver zone not found (*ResolverZoneNotFound*) 2030 description: |
2031 Resolver zone not found (*ResolverZoneNotFound*),
2032 unknown version (*UnknownVersion*)
1876 schema: 2033 schema:
1877 $ref: '#/definitions/NginxError' 2034 $ref: '#/definitions/NginxError'
1878 '405': 2035 '405':
1879 description: Method disabled (*MethodDisabled*) 2036 description: Method disabled (*MethodDisabled*)
1880 schema: 2037 schema:
1892 responses: 2049 responses:
1893 '200': 2050 '200':
1894 description: Success 2051 description: Success
1895 schema: 2052 schema:
1896 $ref: '#/definitions/NginxSSLObject' 2053 $ref: '#/definitions/NginxSSLObject'
2054 '404':
2055 description: Unknown version (*UnknownVersion*)
2056 schema:
2057 $ref: '#/definitions/NginxError'
1897 parameters: 2058 parameters:
1898 - in: query 2059 - in: query
1899 name: fields 2060 name: fields
1900 type: string 2061 type: string
1901 description: Limits which fields of SSL statistics will be output. 2062 description: Limits which fields of SSL statistics will be output.
1907 description: Resets counters of SSL handshakes and session reuses. 2068 description: Resets counters of SSL handshakes and session reuses.
1908 operationId: deleteSslStat 2069 operationId: deleteSslStat
1909 responses: 2070 responses:
1910 '204': 2071 '204':
1911 description: Success 2072 description: Success
2073 '404':
2074 description: Unknown version (*UnknownVersion*)
2075 schema:
2076 $ref: '#/definitions/NginxError'
1912 ### 2077 ###
1913 ###DEFINITIONS 2078 ###DEFINITIONS
1914 ### 2079 ###
1915 definitions: 2080 definitions:
1916 ArrayOfStrings: 2081 ArrayOfStrings: