nginx-site: xml/en/docs/http/ngx_http_api_module

annotate xml/en/docs/http/ngx_http_api_module_head.xml @ 3005:8b8f94802f41

Fixed lang attribute, added module closing tag.

author	Ryan Davis <ry.davis@f5.com>
date	Thu, 31 Aug 2023 15:14:39 -0400
parents	6e094f915896
children

rev	line source
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 <!--
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4 Copyright (C) Nginx, Inc.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	5 -->
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	6
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 <module name="Module ngx_http_api_module"
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 link="/en/docs/http/ngx_http_api_module.html"
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 lang="en"
3005 8b8f94802f41 Fixed lang attribute, added module closing tag. Ryan Davis <ry.davis@f5.com> parents: 2992 diff changeset	12 rev="4">
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14 <section id="summary">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17 The <literal>ngx_http_api_module</literal> module (1.13.3) provides REST API
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 for accessing various status information,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 configuring upstream server groups on-the-fly, and managing
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20 <link doc="ngx_http_keyval_module.xml">key-value pairs</link>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 without the need of reconfiguring nginx.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 <note>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26 The module supersedes the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 <link doc="ngx_http_status_module.xml">ngx_http_status_module</link> and
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 <link doc="ngx_http_upstream_conf_module.xml">ngx_http_upstream_conf_module</link>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 modules.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 </note>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 <para>
2493 407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	34 When using the <literal>PATCH</literal> or <literal>POST</literal> methods,
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	35 make sure that the payload does not exceed the
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	36 <link doc="ngx_http_core_module.xml" id="client_body_buffer_size">buffer size</link>
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	37 for reading the client request body, otherwise, the
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	38 <http-status code="413" text="Request Entity Too Large"/>
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	39 error may be returned.
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	40 </para>
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	41
407147d8020f Documented 413 error for PATCH and POST methods in the API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2469 diff changeset	42 <para>
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 <note>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 This module is available as part of our
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 <commercial_version>commercial subscription</commercial_version>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 </note>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 </section>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 <section id="example" name="Example Configuration">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 <example>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 http {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 upstream backend {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 zone http_backend 64k;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60 server backend1.example.com weight=5;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61 server backend2.example.com;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 proxy_cache_path /data/nginx/cache_backend keys_zone=cache_backend:10m;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 server {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 server_name backend.example.com;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 location / {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 proxy_pass http://backend;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71 proxy_cache cache_backend;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 health_check;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 status_zone server_backend;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 keyval_zone zone=one:32k state=one.keyval;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 keyval $arg_text $text zone=one;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 server {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 listen 127.0.0.1;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 location /api {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 <emphasis>api</emphasis> write=on;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 allow 127.0.0.1;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 deny all;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 stream {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 upstream backend {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 zone stream_backend 64k;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	97 server backend1.example.com:12345 weight=5;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98 server backend2.example.com:12345;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 server {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 listen 127.0.0.1:12345;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 proxy_pass backend;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 status_zone server_backend;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 health_check;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 </example>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	109 All API requests include
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	110 a supported API <link id="api_version">version</link> in the URI.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 Examples of API requests with this configuration:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 <example>
2992 6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	113 http://127.0.0.1/api/9/
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	114 http://127.0.0.1/api/9/nginx
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	115 http://127.0.0.1/api/9/connections
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	116 http://127.0.0.1/api/9/workers
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	117 http://127.0.0.1/api/9/http/requests
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	118 http://127.0.0.1/api/9/http/server_zones/server_backend
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	119 http://127.0.0.1/api/9/http/caches/cache_backend
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	120 http://127.0.0.1/api/9/http/upstreams/backend
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	121 http://127.0.0.1/api/9/http/upstreams/backend/servers/
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	122 http://127.0.0.1/api/9/http/upstreams/backend/servers/1
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	123 http://127.0.0.1/api/9/http/keyvals/one?key=arg1
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	124 http://127.0.0.1/api/9/stream/
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	125 http://127.0.0.1/api/9/stream/server_zones/server_backend
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	126 http://127.0.0.1/api/9/stream/upstreams/
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	127 http://127.0.0.1/api/9/stream/upstreams/backend
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	128 http://127.0.0.1/api/9/stream/upstreams/backend/servers/1
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	129 </example>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	132 </section>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 <section id="directives" name="Directives">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137 <directive name="api">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 <syntax>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139 [<literal>write</literal>=<literal>on</literal>\|<literal>off</literal>]</syntax>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 <default/>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141 <context>location</context>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 Turns on the REST API interface in the surrounding location.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 Access to this location should be
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146 <link doc="ngx_http_core_module.xml" id="satisfy">limited</link>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150 The <literal>write</literal> parameter determines whether the API
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 is read-only or read-write.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 By default, the API is read-only.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	155 <para id="api_version">
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 All API requests should contain a supported API version in the URI.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157 If the request URI equals the location prefix,
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158 the list of supported API versions is returned.
2992 6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	159 The current API version is “<literal>9</literal>”.
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163 The optional “<literal>fields</literal>” argument in the request line
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 specifies which fields of the requested objects will be output:
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 <example>
2992 6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	166 http://127.0.0.1/api/9/nginx?fields=version,build
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 </example>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	168 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170 </directive>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	172
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	173 <directive name="status_zone">
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	174 <syntax><value>zone</value></syntax>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	175 <default/>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	176 <context>server</context>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	177 <context>location</context>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	178 <context>if in location</context>
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	179 <appeared-in>1.13.12</appeared-in>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	180
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	181 <para>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	182 Enables collection of virtual
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	183 <link doc="ngx_http_core_module.xml" id="server">http</link>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	184 or
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	185 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	186 server status information in the specified <value>zone</value>.
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	187 Several servers may share the same zone.
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	188 </para>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	189
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	190 <para id="status_zone_location">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	191 Starting from 1.17.0, status information can be collected
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	192 per <link doc="ngx_http_core_module.xml" id="location"/>.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	193 The special value <literal>off</literal> disables statistics collection
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	194 in nested location blocks.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	195 Note that the statistics is collected
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	196 in the context of a location where processing ends.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	197 It may be different from the original location, if an
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	198 <link doc="ngx_http_core_module.xml" id="internal">internal
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	199 redirect</link> happens during request processing.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	200 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	201
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	202 </directive>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	203
2028 5c55b7054b58 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 </section>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	205
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	206 <section id="compatibility" name="Compatibility">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	207
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	208 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	209 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	210
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	211 <listitem>
2992 6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	212 The <link id="workers_">/workers/</link> data
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	213 were added in <link id="api_version">version</link> 9.
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	214 </listitem>
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	215
6e094f915896 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	216 <listitem>
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2866 diff changeset	217 Detailed failure counters were added to SSL statistics
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2866 diff changeset	218 in <link id="api_version">version</link> 8 (1.23.2).
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2866 diff changeset	219 </listitem>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2866 diff changeset	220
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2866 diff changeset	221 <listitem>
2866 8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	222 The <literal>ssl</literal> data
8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	223 for each HTTP
8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	224 <link id="def_nginx_http_upstream">upstream</link>,
8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	225 <link id="def_nginx_http_server_zone">server zone</link>,
8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	226 and stream
8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	227 <link id="def_nginx_stream_upstream">upstream</link>,
8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	228 <link id="def_nginx_stream_server_zone">server zone</link>,
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2866 diff changeset	229 were added in <link id="api_version">version</link> 8 (1.21.6).
2866 8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	230 </listitem>
8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	231
8bd6f772005f Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2768 diff changeset	232 <listitem>
2768 9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	233 The <literal>codes</literal> data
9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	234 in <literal>responses</literal> for each HTTP
9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	235 <link id="def_nginx_http_upstream">upstream</link>,
9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	236 <link id="def_nginx_http_server_zone">server zone</link>, and
9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	237 <link id="def_nginx_http_location_zone">location zone</link>
9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	238 were added in <link id="api_version">version</link> 7.
9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	239 </listitem>
9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	240
9dd8c203a54a Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2493 diff changeset	241 <listitem>
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	242 The <link id="stream_limit_conns_">/stream/limit_conns/</link> data
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	243 were added in <link id="api_version">version</link> 6.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	244 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	245
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	246 <listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	247 The <link id="http_limit_conns_">/http/limit_conns/</link> data
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	248 were added in <link id="api_version">version</link> 6.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	249 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	250
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	251 <listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	252 The <link id="http_limit_reqs_">/http/limit_reqs/</link> data
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	253 were added in <link id="api_version">version</link> 6.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	254 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	255
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2424 diff changeset	256 <listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	257 The “<literal>expire</literal>” parameter of a
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	258 <link doc="ngx_http_keyval_module.xml">key-value</link> pair can be
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	259 <link id="postHttpKeyvalZoneData">set</link> or
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	260 <link id="patchHttpKeyvalZoneKeyValue">changed</link>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	261 since <link id="api_version">version</link> 5.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	262 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	263
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	264 <listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	265 The <link id="resolvers_">/resolvers/</link> data
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	266 were added in <link id="api_version">version</link> 5.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	267 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	268
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	269 <listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	270 The <link id="http_location_zones_">/http/location_zones/</link> data
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	271 were added in <link id="api_version">version</link> 5.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	272 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	273
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	274 <listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2221 diff changeset	275 The <literal>path</literal> and <literal>method</literal> fields of
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2221 diff changeset	276 <link id="def_nginx_error">nginx error object</link>
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2221 diff changeset	277 were removed in <link id="api_version">version</link> 4.
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2221 diff changeset	278 These fields continue to exist in earlier api versions,
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2221 diff changeset	279 but show an empty value.
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2221 diff changeset	280 </listitem>
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2221 diff changeset	281
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2221 diff changeset	282 <listitem>
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2082 diff changeset	283 The <link id="stream_zone_sync_">/stream/zone_sync/</link> data
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2082 diff changeset	284 were added in <link id="api_version">version</link> 3.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2082 diff changeset	285 </listitem>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2082 diff changeset	286
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2082 diff changeset	287 <listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	288 The <link id="def_nginx_http_upstream_conf_server">drain</link> parameter
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	289 was added in <link id="api_version">version</link> 2.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	290 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	291
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	292 <listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	293 The <link id="stream_keyvals_">/stream/keyvals/</link> data
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	294 were added in <link id="api_version">version</link> 2.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	295 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	296
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	297 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	298 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	299
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2028 diff changeset	300 </section>
3005 8b8f94802f41 Fixed lang attribute, added module closing tag. Ryan Davis <ry.davis@f5.com> parents: 2992 diff changeset	301
8b8f94802f41 Fixed lang attribute, added module closing tag. Ryan Davis <ry.davis@f5.com> parents: 2992 diff changeset	302 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_api_module_head.xml @ 3005:8b8f94802f41