Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_api_module.xml @ 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
282 <para> 282 <para>
283 Possible responses: 283 Possible responses:
284 </para> 284 </para>
285 <list type="bullet"> 285 <list type="bullet">
286 <listitem>200 - Success, returns an array of strings</listitem> 286 <listitem>200 - Success, returns an array of strings</listitem>
287 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
287 </list> 288 </list>
288 </listitem> 289 </listitem>
289 </list> 290 </list>
290 </tag-desc> 291 </tag-desc>
291 <tag-name id="nginx" name="/nginx"> 292 <tag-name id="nginx" name="/nginx">
309 <para> 310 <para>
310 Possible responses: 311 Possible responses:
311 </para> 312 </para>
312 <list type="bullet"> 313 <list type="bullet">
313 <listitem>200 - Success, returns <link id="def_nginx_object">nginx</link></listitem> 314 <listitem>200 - Success, returns <link id="def_nginx_object">nginx</link></listitem>
315 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
314 </list> 316 </list>
315 </listitem> 317 </listitem>
316 </list> 318 </list>
317 </tag-desc> 319 </tag-desc>
318 <tag-name id="processes" name="/processes"> 320 <tag-name id="processes" name="/processes">
327 <para> 329 <para>
328 Possible responses: 330 Possible responses:
329 </para> 331 </para>
330 <list type="bullet"> 332 <list type="bullet">
331 <listitem>200 - Success, returns <link id="def_nginx_processes">Processes</link></listitem> 333 <listitem>200 - Success, returns <link id="def_nginx_processes">Processes</link></listitem>
334 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
332 </list> 335 </list>
333 </listitem> 336 </listitem>
334 <listitem id="deleteProcesses"> 337 <listitem id="deleteProcesses">
335 <literal>DELETE</literal> - Reset nginx processes statistics 338 <literal>DELETE</literal> - Reset nginx processes statistics
336 <para>Resets counters of abnormally terminated and respawned child processes.</para> 339 <para>Resets counters of abnormally terminated and respawned child processes.</para>
337 <para> 340 <para>
338 Possible responses: 341 Possible responses:
339 </para> 342 </para>
340 <list type="bullet"> 343 <list type="bullet">
341 <listitem>204 - Success</listitem> 344 <listitem>204 - Success</listitem>
345 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
342 </list> 346 </list>
343 </listitem> 347 </listitem>
344 </list> 348 </list>
345 </tag-desc> 349 </tag-desc>
346 <tag-name id="connections" name="/connections"> 350 <tag-name id="connections" name="/connections">
364 <para> 368 <para>
365 Possible responses: 369 Possible responses:
366 </para> 370 </para>
367 <list type="bullet"> 371 <list type="bullet">
368 <listitem>200 - Success, returns <link id="def_nginx_connections">Connections</link></listitem> 372 <listitem>200 - Success, returns <link id="def_nginx_connections">Connections</link></listitem>
373 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
369 </list> 374 </list>
370 </listitem> 375 </listitem>
371 <listitem id="deleteConnections"> 376 <listitem id="deleteConnections">
372 <literal>DELETE</literal> - Reset client connections statistics 377 <literal>DELETE</literal> - Reset client connections statistics
373 <para>Resets statistics of accepted and dropped client connections.</para> 378 <para>Resets statistics of accepted and dropped client connections.</para>
374 <para> 379 <para>
375 Possible responses: 380 Possible responses:
376 </para> 381 </para>
377 <list type="bullet"> 382 <list type="bullet">
378 <listitem>204 - Success</listitem> 383 <listitem>204 - Success</listitem>
384 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
379 </list> 385 </list>
380 </listitem> 386 </listitem>
381 </list> 387 </list>
382 </tag-desc> 388 </tag-desc>
383 <tag-name id="slabs_" name="/slabs/"> 389 <tag-name id="slabs_" name="/slabs/">
401 <para> 407 <para>
402 Possible responses: 408 Possible responses:
403 </para> 409 </para>
404 <list type="bullet"> 410 <list type="bullet">
405 <listitem>200 - Success, returns a collection of "<link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link>" objects for all slabs</listitem> 411 <listitem>200 - Success, returns a collection of "<link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link>" objects for all slabs</listitem>
412 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
406 </list> 413 </list>
407 </listitem> 414 </listitem>
408 </list> 415 </list>
409 </tag-desc> 416 </tag-desc>
410 <tag-name id="slabs_slab_zone_name" name="/slabs/{slabZoneName}"> 417 <tag-name id="slabs_slab_zone_name" name="/slabs/{slabZoneName}">
435 <para> 442 <para>
436 Possible responses: 443 Possible responses:
437 </para> 444 </para>
438 <list type="bullet"> 445 <list type="bullet">
439 <listitem>200 - Success, returns <link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link></listitem> 446 <listitem>200 - Success, returns <link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link></listitem>
440 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 447 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>),
448 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
441 </list> 449 </list>
442 </listitem> 450 </listitem>
443 <listitem id="deleteSlabZoneStats"> 451 <listitem id="deleteSlabZoneStats">
444 <literal>DELETE</literal> - Reset slab statistics 452 <literal>DELETE</literal> - Reset slab statistics
445 <para>Resets the “<literal>reqs</literal>” and “<literal>fails</literal>” metrics for each memory slot.</para> 453 <para>Resets the “<literal>reqs</literal>” and “<literal>fails</literal>” metrics for each memory slot.</para>
446 <para> 454 <para>
447 Possible responses: 455 Possible responses:
448 </para> 456 </para>
449 <list type="bullet"> 457 <list type="bullet">
450 <listitem>204 - Success</listitem> 458 <listitem>204 - Success</listitem>
451 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 459 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>),
460 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
452 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 461 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
453 </list> 462 </list>
454 </listitem> 463 </listitem>
455 </list> 464 </list>
456 </tag-desc> 465 </tag-desc>
466 <para> 475 <para>
467 Possible responses: 476 Possible responses:
468 </para> 477 </para>
469 <list type="bullet"> 478 <list type="bullet">
470 <listitem>200 - Success, returns an array of strings</listitem> 479 <listitem>200 - Success, returns an array of strings</listitem>
480 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
471 </list> 481 </list>
472 </listitem> 482 </listitem>
473 </list> 483 </list>
474 </tag-desc> 484 </tag-desc>
475 <tag-name id="http_requests" name="/http/requests"> 485 <tag-name id="http_requests" name="/http/requests">
493 <para> 503 <para>
494 Possible responses: 504 Possible responses:
495 </para> 505 </para>
496 <list type="bullet"> 506 <list type="bullet">
497 <listitem>200 - Success, returns <link id="def_nginx_http_requests">HTTP Requests</link></listitem> 507 <listitem>200 - Success, returns <link id="def_nginx_http_requests">HTTP Requests</link></listitem>
508 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
498 </list> 509 </list>
499 </listitem> 510 </listitem>
500 <listitem id="deleteHttpRequests"> 511 <listitem id="deleteHttpRequests">
501 <literal>DELETE</literal> - Reset HTTP requests statistics 512 <literal>DELETE</literal> - Reset HTTP requests statistics
502 <para>Resets the number of total client HTTP requests.</para> 513 <para>Resets the number of total client HTTP requests.</para>
503 <para> 514 <para>
504 Possible responses: 515 Possible responses:
505 </para> 516 </para>
506 <list type="bullet"> 517 <list type="bullet">
507 <listitem>204 - Success</listitem> 518 <listitem>204 - Success</listitem>
519 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
508 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 520 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
509 </list> 521 </list>
510 </listitem> 522 </listitem>
511 </list> 523 </list>
512 </tag-desc> 524 </tag-desc>
531 <para> 543 <para>
532 Possible responses: 544 Possible responses:
533 </para> 545 </para>
534 <list type="bullet"> 546 <list type="bullet">
535 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_server_zone">HTTP Server Zone</link>" objects for all HTTP server zones</listitem> 547 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_server_zone">HTTP Server Zone</link>" objects for all HTTP server zones</listitem>
548 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
536 </list> 549 </list>
537 </listitem> 550 </listitem>
538 </list> 551 </list>
539 </tag-desc> 552 </tag-desc>
540 <tag-name id="http_server_zones_http_server_zone_name" name="/http/server_zones/{httpServerZoneName}"> 553 <tag-name id="http_server_zones_http_server_zone_name" name="/http/server_zones/{httpServerZoneName}">
565 <para> 578 <para>
566 Possible responses: 579 Possible responses:
567 </para> 580 </para>
568 <list type="bullet"> 581 <list type="bullet">
569 <listitem>200 - Success, returns <link id="def_nginx_http_server_zone">HTTP Server Zone</link></listitem> 582 <listitem>200 - Success, returns <link id="def_nginx_http_server_zone">HTTP Server Zone</link></listitem>
570 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 583 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
584 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
571 </list> 585 </list>
572 </listitem> 586 </listitem>
573 <listitem id="deleteHttpServerZoneStat"> 587 <listitem id="deleteHttpServerZoneStat">
574 <literal>DELETE</literal> - Reset statistics for an HTTP server zone 588 <literal>DELETE</literal> - Reset statistics for an HTTP server zone
575 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular HTTP server zone.</para> 589 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular HTTP server zone.</para>
576 <para> 590 <para>
577 Possible responses: 591 Possible responses:
578 </para> 592 </para>
579 <list type="bullet"> 593 <list type="bullet">
580 <listitem>204 - Success</listitem> 594 <listitem>204 - Success</listitem>
581 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 595 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
596 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
582 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 597 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
583 </list> 598 </list>
584 </listitem> 599 </listitem>
585 </list> 600 </list>
586 </tag-desc> 601 </tag-desc>
605 <para> 620 <para>
606 Possible responses: 621 Possible responses:
607 </para> 622 </para>
608 <list type="bullet"> 623 <list type="bullet">
609 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_location_zone">HTTP Location Zone</link>" objects for all HTTP location zones</listitem> 624 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_location_zone">HTTP Location Zone</link>" objects for all HTTP location zones</listitem>
625 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
610 </list> 626 </list>
611 </listitem> 627 </listitem>
612 </list> 628 </list>
613 </tag-desc> 629 </tag-desc>
614 <tag-name id="http_location_zones_http_location_zone_name" name="/http/location_zones/{httpLocationZoneName}"> 630 <tag-name id="http_location_zones_http_location_zone_name" name="/http/location_zones/{httpLocationZoneName}">
639 <para> 655 <para>
640 Possible responses: 656 Possible responses:
641 </para> 657 </para>
642 <list type="bullet"> 658 <list type="bullet">
643 <listitem>200 - Success, returns <link id="def_nginx_http_location_zone">HTTP Location Zone</link></listitem> 659 <listitem>200 - Success, returns <link id="def_nginx_http_location_zone">HTTP Location Zone</link></listitem>
644 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 660 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>),
661 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
645 </list> 662 </list>
646 </listitem> 663 </listitem>
647 <listitem id="deleteHttpLocationZoneStat"> 664 <listitem id="deleteHttpLocationZoneStat">
648 <literal>DELETE</literal> - Reset statistics for a location zone. 665 <literal>DELETE</literal> - Reset statistics for a location zone.
649 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular location zone.</para> 666 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular location zone.</para>
650 <para> 667 <para>
651 Possible responses: 668 Possible responses:
652 </para> 669 </para>
653 <list type="bullet"> 670 <list type="bullet">
654 <listitem>204 - Success</listitem> 671 <listitem>204 - Success</listitem>
655 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 672 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>),
673 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
656 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 674 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
657 </list> 675 </list>
658 </listitem> 676 </listitem>
659 </list> 677 </list>
660 </tag-desc> 678 </tag-desc>
679 <para> 697 <para>
680 Possible responses: 698 Possible responses:
681 </para> 699 </para>
682 <list type="bullet"> 700 <list type="bullet">
683 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all HTTP caches</listitem> 701 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all HTTP caches</listitem>
702 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
684 </list> 703 </list>
685 </listitem> 704 </listitem>
686 </list> 705 </list>
687 </tag-desc> 706 </tag-desc>
688 <tag-name id="http_caches_http_cache_zone_name" name="/http/caches/{httpCacheZoneName}"> 707 <tag-name id="http_caches_http_cache_zone_name" name="/http/caches/{httpCacheZoneName}">
713 <para> 732 <para>
714 Possible responses: 733 Possible responses:
715 </para> 734 </para>
716 <list type="bullet"> 735 <list type="bullet">
717 <listitem>200 - Success, returns <link id="def_nginx_http_cache">HTTP Cache</link></listitem> 736 <listitem>200 - Success, returns <link id="def_nginx_http_cache">HTTP Cache</link></listitem>
718 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 737 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>),
738 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
719 </list> 739 </list>
720 </listitem> 740 </listitem>
721 <listitem id="deleteHttpCacheZoneStat"> 741 <listitem id="deleteHttpCacheZoneStat">
722 <literal>DELETE</literal> - Reset cache statistics 742 <literal>DELETE</literal> - Reset cache statistics
723 <para>Resets statistics of cache hits/misses in a particular cache zone.</para> 743 <para>Resets statistics of cache hits/misses in a particular cache zone.</para>
724 <para> 744 <para>
725 Possible responses: 745 Possible responses:
726 </para> 746 </para>
727 <list type="bullet"> 747 <list type="bullet">
728 <listitem>204 - Success</listitem> 748 <listitem>204 - Success</listitem>
729 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 749 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>),
750 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
730 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 751 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
731 </list> 752 </list>
732 </listitem> 753 </listitem>
733 </list> 754 </list>
734 </tag-desc> 755 </tag-desc>
753 <para> 774 <para>
754 Possible responses: 775 Possible responses:
755 </para> 776 </para>
756 <list type="bullet"> 777 <list type="bullet">
757 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link>" objects for all HTTP limit conns</listitem> 778 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link>" objects for all HTTP limit conns</listitem>
779 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
758 </list> 780 </list>
759 </listitem> 781 </listitem>
760 </list> 782 </list>
761 </tag-desc> 783 </tag-desc>
762 <tag-name id="http_limit_conns_http_limit_conn_zone_name" name="/http/limit_conns/{httpLimitConnZoneName}"> 784 <tag-name id="http_limit_conns_http_limit_conn_zone_name" name="/http/limit_conns/{httpLimitConnZoneName}">
787 <para> 809 <para>
788 Possible responses: 810 Possible responses:
789 </para> 811 </para>
790 <list type="bullet"> 812 <list type="bullet">
791 <listitem>200 - Success, returns <link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link></listitem> 813 <listitem>200 - Success, returns <link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link></listitem>
792 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 814 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>),
815 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
793 </list> 816 </list>
794 </listitem> 817 </listitem>
795 <listitem id="deleteHttpLimitConnZoneStat"> 818 <listitem id="deleteHttpLimitConnZoneStat">
796 <literal>DELETE</literal> - Reset statistics for an HTTP limit_conn zone 819 <literal>DELETE</literal> - Reset statistics for an HTTP limit_conn zone
797 <para>Resets the connection limiting statistics.</para> 820 <para>Resets the connection limiting statistics.</para>
798 <para> 821 <para>
799 Possible responses: 822 Possible responses:
800 </para> 823 </para>
801 <list type="bullet"> 824 <list type="bullet">
802 <listitem>204 - Success</listitem> 825 <listitem>204 - Success</listitem>
803 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 826 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>),
827 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
804 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 828 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
805 </list> 829 </list>
806 </listitem> 830 </listitem>
807 </list> 831 </list>
808 </tag-desc> 832 </tag-desc>
827 <para> 851 <para>
828 Possible responses: 852 Possible responses:
829 </para> 853 </para>
830 <list type="bullet"> 854 <list type="bullet">
831 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link>" objects for all HTTP limit reqs</listitem> 855 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link>" objects for all HTTP limit reqs</listitem>
856 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
832 </list> 857 </list>
833 </listitem> 858 </listitem>
834 </list> 859 </list>
835 </tag-desc> 860 </tag-desc>
836 <tag-name id="http_limit_reqs_http_limit_req_zone_name" name="/http/limit_reqs/{httpLimitReqZoneName}"> 861 <tag-name id="http_limit_reqs_http_limit_req_zone_name" name="/http/limit_reqs/{httpLimitReqZoneName}">
861 <para> 886 <para>
862 Possible responses: 887 Possible responses:
863 </para> 888 </para>
864 <list type="bullet"> 889 <list type="bullet">
865 <listitem>200 - Success, returns <link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link></listitem> 890 <listitem>200 - Success, returns <link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link></listitem>
866 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 891 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>),
892 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
867 </list> 893 </list>
868 </listitem> 894 </listitem>
869 <listitem id="deleteHttpLimitReqZoneStat"> 895 <listitem id="deleteHttpLimitReqZoneStat">
870 <literal>DELETE</literal> - Reset statistics for an HTTP limit_req zone 896 <literal>DELETE</literal> - Reset statistics for an HTTP limit_req zone
871 <para>Resets the requests limiting statistics.</para> 897 <para>Resets the requests limiting statistics.</para>
872 <para> 898 <para>
873 Possible responses: 899 Possible responses:
874 </para> 900 </para>
875 <list type="bullet"> 901 <list type="bullet">
876 <listitem>204 - Success</listitem> 902 <listitem>204 - Success</listitem>
877 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 903 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>),
904 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
878 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 905 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
879 </list> 906 </list>
880 </listitem> 907 </listitem>
881 </list> 908 </list>
882 </tag-desc> 909 </tag-desc>
901 <para> 928 <para>
902 Possible responses: 929 Possible responses:
903 </para> 930 </para>
904 <list type="bullet"> 931 <list type="bullet">
905 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all HTTP upstreams</listitem> 932 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all HTTP upstreams</listitem>
933 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
906 </list> 934 </list>
907 </listitem> 935 </listitem>
908 </list> 936 </list>
909 </tag-desc> 937 </tag-desc>
910 <tag-name id="http_upstreams_http_upstream_name_" name="/http/upstreams/{httpUpstreamName}/"> 938 <tag-name id="http_upstreams_http_upstream_name_" name="/http/upstreams/{httpUpstreamName}/">
936 Possible responses: 964 Possible responses:
937 </para> 965 </para>
938 <list type="bullet"> 966 <list type="bullet">
939 <listitem>200 - Success, returns <link id="def_nginx_http_upstream">HTTP Upstream</link></listitem> 967 <listitem>200 - Success, returns <link id="def_nginx_http_upstream">HTTP Upstream</link></listitem>
940 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 968 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
941 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 969 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
970 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
942 </list> 971 </list>
943 </listitem> 972 </listitem>
944 <listitem id="deleteHttpUpstreamStat"> 973 <listitem id="deleteHttpUpstreamStat">
945 <literal>DELETE</literal> - Reset statistics of an HTTP upstream server group 974 <literal>DELETE</literal> - Reset statistics of an HTTP upstream server group
946 <para>Resets the statistics for each upstream server in an upstream server group and queue statistics.</para> 975 <para>Resets the statistics for each upstream server in an upstream server group and queue statistics.</para>
948 Possible responses: 977 Possible responses:
949 </para> 978 </para>
950 <list type="bullet"> 979 <list type="bullet">
951 <listitem>204 - Success</listitem> 980 <listitem>204 - Success</listitem>
952 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 981 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
953 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 982 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
983 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
954 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 984 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
955 </list> 985 </list>
956 </listitem> 986 </listitem>
957 </list> 987 </list>
958 </tag-desc> 988 </tag-desc>
976 Possible responses: 1006 Possible responses:
977 </para> 1007 </para>
978 <list type="bullet"> 1008 <list type="bullet">
979 <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem> 1009 <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem>
980 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1010 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
981 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1011 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
1012 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
982 </list> 1013 </list>
983 </listitem> 1014 </listitem>
984 <listitem id="postHttpUpstreamServer"> 1015 <listitem id="postHttpUpstreamServer">
985 <literal>POST</literal> - Add a server to an HTTP upstream server group 1016 <literal>POST</literal> - Add a server to an HTTP upstream server group
986 <para>Adds a new server to an HTTP upstream server group. Server parameters are specified in the JSON format.</para> 1017 <para>Adds a new server to an HTTP upstream server group. Server parameters are specified in the JSON format.</para>
1015 route is too long (<literal>UpstreamBadRoute</literal>), 1046 route is too long (<literal>UpstreamBadRoute</literal>),
1016 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1047 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1017 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), 1048 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>),
1018 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), 1049 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>),
1019 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1050 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1020 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1051 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
1052 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1021 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1053 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1022 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1054 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1023 </list> 1055 </list>
1024 </listitem> 1056 </listitem>
1025 </list> 1057 </list>
1049 </para> 1081 </para>
1050 <list type="bullet"> 1082 <list type="bullet">
1051 <listitem>200 - Success, returns <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link></listitem> 1083 <listitem>200 - Success, returns <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link></listitem>
1052 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), 1084 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>),
1053 invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1085 invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1054 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1086 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
1055 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1087 unknown version (<literal>UnknownVersion</literal>),
1088 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1056 </list> 1089 </list>
1057 </listitem> 1090 </listitem>
1058 <listitem id="patchHttpUpstreamPeer"> 1091 <listitem id="patchHttpUpstreamPeer">
1059 <literal>PATCH</literal> - Modify a server in an HTTP upstream server group 1092 <literal>PATCH</literal> - Modify a server in an HTTP upstream server group
1060 <para>Modifies settings of a particular server in an HTTP upstream server group. Server parameters are specified in the JSON format.</para> 1093 <para>Modifies settings of a particular server in an HTTP upstream server group. Server parameters are specified in the JSON format.</para>
1088 route is too long (<literal>UpstreamBadRoute</literal>), 1121 route is too long (<literal>UpstreamBadRoute</literal>),
1089 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1122 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1090 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), 1123 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>),
1091 server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), 1124 server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>),
1092 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1125 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1093 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1126 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
1094 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1127 unknown version (<literal>UnknownVersion</literal>),
1128 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1095 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1129 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1096 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1130 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1097 </list> 1131 </list>
1098 </listitem> 1132 </listitem>
1099 <listitem id="deleteHttpUpstreamServer"> 1133 <listitem id="deleteHttpUpstreamServer">
1105 <list type="bullet"> 1139 <list type="bullet">
1106 <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem> 1140 <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem>
1107 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), 1141 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>),
1108 invalid server ID (<literal>UpstreamBadServerId</literal>), 1142 invalid server ID (<literal>UpstreamBadServerId</literal>),
1109 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1143 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1110 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1144 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
1111 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1145 unknown version (<literal>UnknownVersion</literal>),
1146 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1112 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1147 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1113 </list> 1148 </list>
1114 </listitem> 1149 </listitem>
1115 </list> 1150 </list>
1116 </tag-desc> 1151 </tag-desc>
1135 <para> 1170 <para>
1136 Possible responses: 1171 Possible responses:
1137 </para> 1172 </para>
1138 <list type="bullet"> 1173 <list type="bullet">
1139 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>" objects for all HTTP keyvals</listitem> 1174 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>" objects for all HTTP keyvals</listitem>
1175 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1140 </list> 1176 </list>
1141 </listitem> 1177 </listitem>
1142 </list> 1178 </list>
1143 </tag-desc> 1179 </tag-desc>
1144 <tag-name id="http_keyvals_http_keyval_zone_name" name="/http/keyvals/{httpKeyvalZoneName}"> 1180 <tag-name id="http_keyvals_http_keyval_zone_name" name="/http/keyvals/{httpKeyvalZoneName}">
1170 Possible responses: 1206 Possible responses:
1171 </para> 1207 </para>
1172 <list type="bullet"> 1208 <list type="bullet">
1173 <listitem>200 - Success, returns <link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link></listitem> 1209 <listitem>200 - Success, returns <link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link></listitem>
1174 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1210 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1175 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1211 keyval key not found (<literal>KeyvalKeyNotFound</literal>),
1212 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1176 </list> 1213 </list>
1177 </listitem> 1214 </listitem>
1178 <listitem id="postHttpKeyvalZoneData"> 1215 <listitem id="postHttpKeyvalZoneData">
1179 <literal>POST</literal> - Add a key-value pair to the HTTP keyval zone 1216 <literal>POST</literal> - Add a key-value pair to the HTTP keyval zone
1180 <para>Adds a new key-value pair to the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty.</para> 1217 <para>Adds a new key-value pair to the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty.</para>
1196 invalid key format (<literal>KeyvalFormatError</literal>), 1233 invalid key format (<literal>KeyvalFormatError</literal>),
1197 key required (<literal>KeyvalFormatError</literal>), 1234 key required (<literal>KeyvalFormatError</literal>),
1198 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1235 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1199 only one key can be added (<literal>KeyvalFormatError</literal>), 1236 only one key can be added (<literal>KeyvalFormatError</literal>),
1200 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1237 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1201 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1238 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1239 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1202 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1240 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1203 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1241 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1204 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> 1242 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1205 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1243 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1206 </list> 1244 </list>
1226 key required (<literal>KeyvalFormatError</literal>), 1264 key required (<literal>KeyvalFormatError</literal>),
1227 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1265 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1228 only one key can be updated (<literal>KeyvalFormatError</literal>), 1266 only one key can be updated (<literal>KeyvalFormatError</literal>),
1229 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1267 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1230 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1268 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1231 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1269 keyval key not found (<literal>KeyvalKeyNotFound</literal>),
1270 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1232 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1271 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1233 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> 1272 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1234 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1273 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1235 </list> 1274 </list>
1236 </listitem> 1275 </listitem>
1240 <para> 1279 <para>
1241 Possible responses: 1280 Possible responses:
1242 </para> 1281 </para>
1243 <list type="bullet"> 1282 <list type="bullet">
1244 <listitem>204 - Success</listitem> 1283 <listitem>204 - Success</listitem>
1245 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1284 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1285 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1246 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1286 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1247 </list> 1287 </list>
1248 </listitem> 1288 </listitem>
1249 </list> 1289 </list>
1250 </tag-desc> 1290 </tag-desc>
1260 <para> 1300 <para>
1261 Possible responses: 1301 Possible responses:
1262 </para> 1302 </para>
1263 <list type="bullet"> 1303 <list type="bullet">
1264 <listitem>200 - Success, returns an array of strings</listitem> 1304 <listitem>200 - Success, returns an array of strings</listitem>
1305 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1265 </list> 1306 </list>
1266 </listitem> 1307 </listitem>
1267 </list> 1308 </list>
1268 </tag-desc> 1309 </tag-desc>
1269 <tag-name id="stream_server_zones_" name="/stream/server_zones/"> 1310 <tag-name id="stream_server_zones_" name="/stream/server_zones/">
1287 <para> 1328 <para>
1288 Possible responses: 1329 Possible responses:
1289 </para> 1330 </para>
1290 <list type="bullet"> 1331 <list type="bullet">
1291 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_server_zone">Stream Server Zone</link>" objects for all stream server zones</listitem> 1332 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_server_zone">Stream Server Zone</link>" objects for all stream server zones</listitem>
1333 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1292 </list> 1334 </list>
1293 </listitem> 1335 </listitem>
1294 </list> 1336 </list>
1295 </tag-desc> 1337 </tag-desc>
1296 <tag-name id="stream_server_zones_stream_server_zone_name" name="/stream/server_zones/{streamServerZoneName}"> 1338 <tag-name id="stream_server_zones_stream_server_zone_name" name="/stream/server_zones/{streamServerZoneName}">
1321 <para> 1363 <para>
1322 Possible responses: 1364 Possible responses:
1323 </para> 1365 </para>
1324 <list type="bullet"> 1366 <list type="bullet">
1325 <listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem> 1367 <listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem>
1326 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1368 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
1369 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1327 </list> 1370 </list>
1328 </listitem> 1371 </listitem>
1329 <listitem id="deleteStreamServerZoneStat"> 1372 <listitem id="deleteStreamServerZoneStat">
1330 <literal>DELETE</literal> - Reset statistics for a stream server zone 1373 <literal>DELETE</literal> - Reset statistics for a stream server zone
1331 <para>Resets statistics of accepted and discarded connections, sessions, received and sent bytes in a particular stream server zone.</para> 1374 <para>Resets statistics of accepted and discarded connections, sessions, received and sent bytes in a particular stream server zone.</para>
1332 <para> 1375 <para>
1333 Possible responses: 1376 Possible responses:
1334 </para> 1377 </para>
1335 <list type="bullet"> 1378 <list type="bullet">
1336 <listitem>204 - Success</listitem> 1379 <listitem>204 - Success</listitem>
1337 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1380 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
1381 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1338 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1382 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1339 </list> 1383 </list>
1340 </listitem> 1384 </listitem>
1341 </list> 1385 </list>
1342 </tag-desc> 1386 </tag-desc>
1361 <para> 1405 <para>
1362 Possible responses: 1406 Possible responses:
1363 </para> 1407 </para>
1364 <list type="bullet"> 1408 <list type="bullet">
1365 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link>" objects for all stream limit conns</listitem> 1409 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link>" objects for all stream limit conns</listitem>
1410 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1366 </list> 1411 </list>
1367 </listitem> 1412 </listitem>
1368 </list> 1413 </list>
1369 </tag-desc> 1414 </tag-desc>
1370 <tag-name id="stream_limit_conns_stream_limit_conn_zone_name" name="/stream/limit_conns/{streamLimitConnZoneName}"> 1415 <tag-name id="stream_limit_conns_stream_limit_conn_zone_name" name="/stream/limit_conns/{streamLimitConnZoneName}">
1395 <para> 1440 <para>
1396 Possible responses: 1441 Possible responses:
1397 </para> 1442 </para>
1398 <list type="bullet"> 1443 <list type="bullet">
1399 <listitem>200 - Success, returns <link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link></listitem> 1444 <listitem>200 - Success, returns <link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link></listitem>
1400 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1445 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>),
1446 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1401 </list> 1447 </list>
1402 </listitem> 1448 </listitem>
1403 <listitem id="deleteStreamLimitConnZoneStat"> 1449 <listitem id="deleteStreamLimitConnZoneStat">
1404 <literal>DELETE</literal> - Reset statistics for a stream limit_conn zone 1450 <literal>DELETE</literal> - Reset statistics for a stream limit_conn zone
1405 <para>Resets the connection limiting statistics.</para> 1451 <para>Resets the connection limiting statistics.</para>
1406 <para> 1452 <para>
1407 Possible responses: 1453 Possible responses:
1408 </para> 1454 </para>
1409 <list type="bullet"> 1455 <list type="bullet">
1410 <listitem>204 - Success</listitem> 1456 <listitem>204 - Success</listitem>
1411 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1457 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>),
1458 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1412 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1459 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1413 </list> 1460 </list>
1414 </listitem> 1461 </listitem>
1415 </list> 1462 </list>
1416 </tag-desc> 1463 </tag-desc>
1435 <para> 1482 <para>
1436 Possible responses: 1483 Possible responses:
1437 </para> 1484 </para>
1438 <list type="bullet"> 1485 <list type="bullet">
1439 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams</listitem> 1486 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams</listitem>
1487 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1440 </list> 1488 </list>
1441 </listitem> 1489 </listitem>
1442 </list> 1490 </list>
1443 </tag-desc> 1491 </tag-desc>
1444 <tag-name id="stream_upstreams_stream_upstream_name_" name="/stream/upstreams/{streamUpstreamName}/"> 1492 <tag-name id="stream_upstreams_stream_upstream_name_" name="/stream/upstreams/{streamUpstreamName}/">
1470 Possible responses: 1518 Possible responses:
1471 </para> 1519 </para>
1472 <list type="bullet"> 1520 <list type="bullet">
1473 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream">Stream Upstream</link></listitem> 1521 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream">Stream Upstream</link></listitem>
1474 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1522 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1475 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1523 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
1524 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1476 </list> 1525 </list>
1477 </listitem> 1526 </listitem>
1478 <listitem id="deleteStreamUpstreamStat"> 1527 <listitem id="deleteStreamUpstreamStat">
1479 <literal>DELETE</literal> - Reset statistics of a stream upstream server group 1528 <literal>DELETE</literal> - Reset statistics of a stream upstream server group
1480 <para>Resets the statistics for each upstream server in an upstream server group.</para> 1529 <para>Resets the statistics for each upstream server in an upstream server group.</para>
1482 Possible responses: 1531 Possible responses:
1483 </para> 1532 </para>
1484 <list type="bullet"> 1533 <list type="bullet">
1485 <listitem>204 - Success</listitem> 1534 <listitem>204 - Success</listitem>
1486 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1535 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1487 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1536 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
1537 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1488 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1538 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1489 </list> 1539 </list>
1490 </listitem> 1540 </listitem>
1491 </list> 1541 </list>
1492 </tag-desc> 1542 </tag-desc>
1510 Possible responses: 1560 Possible responses:
1511 </para> 1561 </para>
1512 <list type="bullet"> 1562 <list type="bullet">
1513 <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem> 1563 <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem>
1514 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1564 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1515 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1565 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
1566 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1516 </list> 1567 </list>
1517 </listitem> 1568 </listitem>
1518 <listitem id="postStreamUpstreamServer"> 1569 <listitem id="postStreamUpstreamServer">
1519 <literal>POST</literal> - Add a server to a stream upstream server group 1570 <literal>POST</literal> - Add a server to a stream upstream server group
1520 <para>Adds a new server to a stream upstream server group. Server parameters are specified in the JSON format.</para> 1571 <para>Adds a new server to a stream upstream server group. Server parameters are specified in the JSON format.</para>
1549 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1600 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1550 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), 1601 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>),
1551 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), 1602 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>),
1552 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), 1603 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>),
1553 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1604 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1554 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1605 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
1606 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1555 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1607 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1556 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1608 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1557 </list> 1609 </list>
1558 </listitem> 1610 </listitem>
1559 </list> 1611 </list>
1583 </para> 1635 </para>
1584 <list type="bullet"> 1636 <list type="bullet">
1585 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link></listitem> 1637 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link></listitem>
1586 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), 1638 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>),
1587 invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1639 invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1588 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1640 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
1641 upstream not found (<literal>UpstreamNotFound</literal>),
1589 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1642 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1590 </list> 1643 </list>
1591 </listitem> 1644 </listitem>
1592 <listitem id="patchStreamUpstreamServer"> 1645 <listitem id="patchStreamUpstreamServer">
1593 <literal>PATCH</literal> - Modify a server in a stream upstream server group 1646 <literal>PATCH</literal> - Modify a server in a stream upstream server group
1622 reading request body failed <literal>BodyReadError</literal>), 1675 reading request body failed <literal>BodyReadError</literal>),
1623 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1676 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1624 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), 1677 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>),
1625 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), 1678 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>),
1626 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1679 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1627 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1680 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
1628 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1681 unknown version (<literal>UnknownVersion</literal>),
1682 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1629 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1683 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1630 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1684 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1631 </list> 1685 </list>
1632 </listitem> 1686 </listitem>
1633 <listitem id="deleteStreamUpstreamServer"> 1687 <listitem id="deleteStreamUpstreamServer">
1639 <list type="bullet"> 1693 <list type="bullet">
1640 <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem> 1694 <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem>
1641 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), 1695 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>),
1642 invalid server ID (<literal>UpstreamBadServerId</literal>), 1696 invalid server ID (<literal>UpstreamBadServerId</literal>),
1643 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1697 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1644 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1698 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
1645 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1699 unknown version (<literal>UnknownVersion</literal>),
1700 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1646 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1701 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1647 </list> 1702 </list>
1648 </listitem> 1703 </listitem>
1649 </list> 1704 </list>
1650 </tag-desc> 1705 </tag-desc>
1669 <para> 1724 <para>
1670 Possible responses: 1725 Possible responses:
1671 </para> 1726 </para>
1672 <list type="bullet"> 1727 <list type="bullet">
1673 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>" objects for all stream keyvals</listitem> 1728 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>" objects for all stream keyvals</listitem>
1729 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1674 </list> 1730 </list>
1675 </listitem> 1731 </listitem>
1676 </list> 1732 </list>
1677 </tag-desc> 1733 </tag-desc>
1678 <tag-name id="stream_keyvals_stream_keyval_zone_name" name="/stream/keyvals/{streamKeyvalZoneName}"> 1734 <tag-name id="stream_keyvals_stream_keyval_zone_name" name="/stream/keyvals/{streamKeyvalZoneName}">
1704 Possible responses: 1760 Possible responses:
1705 </para> 1761 </para>
1706 <list type="bullet"> 1762 <list type="bullet">
1707 <listitem>200 - Success, returns <link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link></listitem> 1763 <listitem>200 - Success, returns <link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link></listitem>
1708 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1764 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1709 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1765 keyval key not found (<literal>KeyvalKeyNotFound</literal>),
1766 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1710 </list> 1767 </list>
1711 </listitem> 1768 </listitem>
1712 <listitem id="postStreamKeyvalZoneData"> 1769 <listitem id="postStreamKeyvalZoneData">
1713 <literal>POST</literal> - Add a key-value pair to the stream keyval zone 1770 <literal>POST</literal> - Add a key-value pair to the stream keyval zone
1714 <para>Adds a new key-value pair to the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the stream keyval shared memory zone is empty.</para> 1771 <para>Adds a new key-value pair to the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the stream keyval shared memory zone is empty.</para>
1730 invalid key format (<literal>KeyvalFormatError</literal>), 1787 invalid key format (<literal>KeyvalFormatError</literal>),
1731 key required (<literal>KeyvalFormatError</literal>), 1788 key required (<literal>KeyvalFormatError</literal>),
1732 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1789 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1733 only one key can be added (<literal>KeyvalFormatError</literal>), 1790 only one key can be added (<literal>KeyvalFormatError</literal>),
1734 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1791 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1735 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1792 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1793 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1736 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1794 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1737 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1795 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1738 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> 1796 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1739 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1797 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1740 </list> 1798 </list>
1760 key required (<literal>KeyvalFormatError</literal>), 1818 key required (<literal>KeyvalFormatError</literal>),
1761 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1819 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1762 only one key can be updated (<literal>KeyvalFormatError</literal>), 1820 only one key can be updated (<literal>KeyvalFormatError</literal>),
1763 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1821 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1764 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1822 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1765 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1823 keyval key not found (<literal>KeyvalKeyNotFound</literal>),
1824 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1766 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1825 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1767 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> 1826 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1768 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1827 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1769 </list> 1828 </list>
1770 </listitem> 1829 </listitem>
1774 <para> 1833 <para>
1775 Possible responses: 1834 Possible responses:
1776 </para> 1835 </para>
1777 <list type="bullet"> 1836 <list type="bullet">
1778 <listitem>204 - Success</listitem> 1837 <listitem>204 - Success</listitem>
1779 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1838 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1839 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1780 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1840 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1781 </list> 1841 </list>
1782 </listitem> 1842 </listitem>
1783 </list> 1843 </list>
1784 </tag-desc> 1844 </tag-desc>
1794 <para> 1854 <para>
1795 Possible responses: 1855 Possible responses:
1796 </para> 1856 </para>
1797 <list type="bullet"> 1857 <list type="bullet">
1798 <listitem>200 - Success, returns <link id="def_nginx_stream_zone_sync">Stream Zone Sync Node</link></listitem> 1858 <listitem>200 - Success, returns <link id="def_nginx_stream_zone_sync">Stream Zone Sync Node</link></listitem>
1859 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1799 </list> 1860 </list>
1800 </listitem> 1861 </listitem>
1801 </list> 1862 </list>
1802 </tag-desc> 1863 </tag-desc>
1803 <tag-name id="resolvers_" name="/resolvers/"> 1864 <tag-name id="resolvers_" name="/resolvers/">
1821 <para> 1882 <para>
1822 Possible responses: 1883 Possible responses:
1823 </para> 1884 </para>
1824 <list type="bullet"> 1885 <list type="bullet">
1825 <listitem>200 - Success, returns a collection of "<link id="def_nginx_resolver_zone">Resolver Zone</link>" objects for all resolvers</listitem> 1886 <listitem>200 - Success, returns a collection of "<link id="def_nginx_resolver_zone">Resolver Zone</link>" objects for all resolvers</listitem>
1887 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1826 </list> 1888 </list>
1827 </listitem> 1889 </listitem>
1828 </list> 1890 </list>
1829 </tag-desc> 1891 </tag-desc>
1830 <tag-name id="resolvers_resolver_zone_name" name="/resolvers/{resolverZoneName}"> 1892 <tag-name id="resolvers_resolver_zone_name" name="/resolvers/{resolverZoneName}">
1855 <para> 1917 <para>
1856 Possible responses: 1918 Possible responses:
1857 </para> 1919 </para>
1858 <list type="bullet"> 1920 <list type="bullet">
1859 <listitem>200 - Success, returns <link id="def_nginx_resolver_zone">Resolver Zone</link></listitem> 1921 <listitem>200 - Success, returns <link id="def_nginx_resolver_zone">Resolver Zone</link></listitem>
1860 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1922 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>),
1923 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1861 </list> 1924 </list>
1862 </listitem> 1925 </listitem>
1863 <listitem id="deleteResolverZoneStat"> 1926 <listitem id="deleteResolverZoneStat">
1864 <literal>DELETE</literal> - Reset statistics for a resolver zone. 1927 <literal>DELETE</literal> - Reset statistics for a resolver zone.
1865 <para>Resets statistics in a particular resolver zone.</para> 1928 <para>Resets statistics in a particular resolver zone.</para>
1866 <para> 1929 <para>
1867 Possible responses: 1930 Possible responses:
1868 </para> 1931 </para>
1869 <list type="bullet"> 1932 <list type="bullet">
1870 <listitem>204 - Success</listitem> 1933 <listitem>204 - Success</listitem>
1871 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1934 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>),
1935 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1872 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1936 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1873 </list> 1937 </list>
1874 </listitem> 1938 </listitem>
1875 </list> 1939 </list>
1876 </tag-desc> 1940 </tag-desc>
1895 <para> 1959 <para>
1896 Possible responses: 1960 Possible responses:
1897 </para> 1961 </para>
1898 <list type="bullet"> 1962 <list type="bullet">
1899 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem> 1963 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem>
1964 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1900 </list> 1965 </list>
1901 </listitem> 1966 </listitem>
1902 <listitem id="deleteSslStat"> 1967 <listitem id="deleteSslStat">
1903 <literal>DELETE</literal> - Reset SSL statistics 1968 <literal>DELETE</literal> - Reset SSL statistics
1904 <para>Resets counters of SSL handshakes and session reuses.</para> 1969 <para>Resets counters of SSL handshakes and session reuses.</para>
1905 <para> 1970 <para>
1906 Possible responses: 1971 Possible responses:
1907 </para> 1972 </para>
1908 <list type="bullet"> 1973 <list type="bullet">
1909 <listitem>204 - Success</listitem> 1974 <listitem>204 - Success</listitem>
1975 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1910 </list> 1976 </list>
1911 </listitem> 1977 </listitem>
1912 </list> 1978 </list>
1913 </tag-desc> 1979 </tag-desc>
1914 </list> 1980 </list>