Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_api_module_head.xml @ 2992:6e094f915896

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 15 Aug 2023 12:36:26 +0100
parents a85e4d126bc7
children 8b8f94802f41
comparison
equal deleted inserted replaced
2991:1f672755959a 2992:6e094f915896
108 </example> 108 </example>
109 All API requests include 109 All API requests include
110 a supported API <link id="api_version">version</link> in the URI. 110 a supported API <link id="api_version">version</link> in the URI.
111 Examples of API requests with this configuration: 111 Examples of API requests with this configuration:
112 <example> 112 <example>
113 http://127.0.0.1/api/8/ 113 http://127.0.0.1/api/9/
114 http://127.0.0.1/api/8/nginx 114 http://127.0.0.1/api/9/nginx
115 http://127.0.0.1/api/8/connections 115 http://127.0.0.1/api/9/connections
116 http://127.0.0.1/api/8/http/requests 116 http://127.0.0.1/api/9/workers
117 http://127.0.0.1/api/8/http/server_zones/server_backend 117 http://127.0.0.1/api/9/http/requests
118 http://127.0.0.1/api/8/http/caches/cache_backend 118 http://127.0.0.1/api/9/http/server_zones/server_backend
119 http://127.0.0.1/api/8/http/upstreams/backend 119 http://127.0.0.1/api/9/http/caches/cache_backend
120 http://127.0.0.1/api/8/http/upstreams/backend/servers/ 120 http://127.0.0.1/api/9/http/upstreams/backend
121 http://127.0.0.1/api/8/http/upstreams/backend/servers/1 121 http://127.0.0.1/api/9/http/upstreams/backend/servers/
122 http://127.0.0.1/api/8/http/keyvals/one?key=arg1 122 http://127.0.0.1/api/9/http/upstreams/backend/servers/1
123 http://127.0.0.1/api/8/stream/ 123 http://127.0.0.1/api/9/http/keyvals/one?key=arg1
124 http://127.0.0.1/api/8/stream/server_zones/server_backend 124 http://127.0.0.1/api/9/stream/
125 http://127.0.0.1/api/8/stream/upstreams/ 125 http://127.0.0.1/api/9/stream/server_zones/server_backend
126 http://127.0.0.1/api/8/stream/upstreams/backend 126 http://127.0.0.1/api/9/stream/upstreams/
127 http://127.0.0.1/api/8/stream/upstreams/backend/servers/1 127 http://127.0.0.1/api/9/stream/upstreams/backend
128 http://127.0.0.1/api/9/stream/upstreams/backend/servers/1
128 </example> 129 </example>
129 </para> 130 </para>
130 131
131 </section> 132 </section>
132 133
153 154
154 <para id="api_version"> 155 <para id="api_version">
155 All API requests should contain a supported API version in the URI. 156 All API requests should contain a supported API version in the URI.
156 If the request URI equals the location prefix, 157 If the request URI equals the location prefix,
157 the list of supported API versions is returned. 158 the list of supported API versions is returned.
158 The current API version is “<literal>8</literal>”. 159 The current API version is “<literal>9</literal>”.
159 </para> 160 </para>
160 161
161 <para> 162 <para>
162 The optional “<literal>fields</literal>” argument in the request line 163 The optional “<literal>fields</literal>” argument in the request line
163 specifies which fields of the requested objects will be output: 164 specifies which fields of the requested objects will be output:
164 <example> 165 <example>
165 http://127.0.0.1/api/8/nginx?fields=version,build 166 http://127.0.0.1/api/9/nginx?fields=version,build
166 </example> 167 </example>
167 </para> 168 </para>
168 169
169 </directive> 170 </directive>
170 171
206 207
207 <para> 208 <para>
208 <list type="bullet"> 209 <list type="bullet">
209 210
210 <listitem> 211 <listitem>
212 The <link id="workers_">/workers/</link> data
213 were added in <link id="api_version">version</link> 9.
214 </listitem>
215
216 <listitem>
211 Detailed failure counters were added to SSL statistics 217 Detailed failure counters were added to SSL statistics
212 in <link id="api_version">version</link> 8 (1.23.2). 218 in <link id="api_version">version</link> 8 (1.23.2).
213 </listitem> 219 </listitem>
214 220
215 <listitem> 221 <listitem>