CoCalc -- nginx

GitHub Repository: nginx/nginx.org
Path: blob/main/yaml/nginx_api.yaml
¹ views
1
swagger: '2.0'
2
info:
3
  version: '9.0'
4
  title: NGINX Plus REST API
5
  description: NGINX Plus REST
6
    [API](https://nginx.org/en/docs/http/ngx_http_api_module.html)
7
    provides access to NGINX Plus status information,
8
    on-the-fly configuration of upstream servers and
9
    key-value pairs management for
10
    [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and
11
    [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html).
12
basePath: /api/9
13
tags:
14
  - name: General Info
15
  - name: Processes
16
  - name: Connections
17
  - name: Workers
18
  - name: Slabs
19
  - name: Resolvers
20
  - name: SSL
21
  - name: HTTP
22
  - name: HTTP Requests
23
  - name: HTTP Server Zones
24
  - name: HTTP Location Zones
25
  - name: HTTP Caches
26
  - name: HTTP Limit Conns
27
  - name: HTTP Limit Reqs
28
  - name: HTTP Keyvals
29
  - name: HTTP Upstreams
30
  - name: License
31
  - name: Stream
32
  - name: Stream Server Zones
33
  - name: Stream Limit Conns
34
  - name: Stream Keyvals
35
  - name: Stream Upstreams
36
  - name: Stream Zone Sync
37
  - name: Method GET
38
  - name: Method POST
39
  - name: Method PATCH
40
  - name: Method DELETE
41
schemes:
42
  - http
43
  - https
44
paths:
45
  /:
46
    get:
47
      tags:
48
        - General Info
49
        - Method GET
50
      summary: Return list of root endpoints
51
      description: Returns a list of root endpoints.
52
      operationId: getAPIEndpoints
53
      produces:
54
        - application/json
55
      responses:
56
        '200':
57
          description: Success
58
          schema:
59
            $ref: '#/definitions/ArrayOfStrings'
60
        '404':
61
          description: Unknown version (*UnknownVersion*)
62
          schema:
63
            $ref: '#/definitions/NginxError'
64
  /nginx:
65
    get:
66
      tags:
67
        - General Info
68
        - Method GET
69
      summary: Return status of nginx running instance
70
      description: Returns nginx version, build name, address,
71
        number of configuration reloads, IDs of master and worker processes.
72
      operationId: getNginx
73
      produces:
74
        - application/json
75
      parameters:
76
        - in: query
77
          name: fields
78
          type: string
79
          description: Limits which fields of nginx running instance will be output.
80
      responses:
81
        '200':
82
          description: Success
83
          schema:
84
            $ref: '#/definitions/NginxObject'
85
        '404':
86
          description: Unknown version (*UnknownVersion*)
87
          schema:
88
            $ref: '#/definitions/NginxError'
89
  /processes:
90
    get:
91
      tags:
92
        - Processes
93
        - Method GET
94
      summary: Return nginx processes status
95
      description: Returns the number of abnormally terminated
96
        and respawned child processes.
97
      operationId: getProcesses
98
      produces:
99
        - application/json
100
      responses:
101
        '200':
102
          description: Success
103
          schema:
104
            $ref: '#/definitions/NginxProcesses'
105
        '404':
106
          description: Unknown version (*UnknownVersion*)
107
          schema:
108
            $ref: '#/definitions/NginxError'
109
    delete:
110
      tags:
111
        - Processes
112
        - Method DELETE
113
      summary: Reset nginx processes statistics
114
      description: Resets counters of abnormally terminated and respawned
115
        child processes.
116
      operationId: deleteProcesses
117
      responses:
118
        '204':
119
          description: Success
120
        '404':
121
          description: Unknown version (*UnknownVersion*)
122
          schema:
123
            $ref: '#/definitions/NginxError'
124
        '405':
125
          description: Method disabled (*MethodDisabled*)
126
          schema:
127
            $ref: '#/definitions/NginxError'
128
  /connections:
129
    get:
130
      tags:
131
        - Connections
132
        - Method GET
133
      summary: Return client connections statistics
134
      description: Returns statistics of client connections.
135
      operationId: getConnections
136
      produces:
137
        - application/json
138
      responses:
139
        '200':
140
          description: Success
141
          schema:
142
            $ref: '#/definitions/NginxConnections'
143
        '404':
144
          description: Unknown version (*UnknownVersion*)
145
          schema:
146
            $ref: '#/definitions/NginxError'
147
      parameters:
148
        - in: query
149
          name: fields
150
          type: string
151
          description:  Limits which fields of the connections statistics will be output.
152
    delete:
153
      tags:
154
        - Connections
155
        - Method DELETE
156
      summary: Reset client connections statistics
157
      description: Resets statistics of accepted and dropped
158
        client connections.
159
      operationId: deleteConnections
160
      responses:
161
        '204':
162
          description: Success
163
        '404':
164
          description: Unknown version (*UnknownVersion*)
165
          schema:
166
            $ref: '#/definitions/NginxError'
167
        '405':
168
          description: Method disabled (*MethodDisabled*)
169
          schema:
170
            $ref: '#/definitions/NginxError'
171
  /slabs/:
172
    get:
173
      tags:
174
        - Slabs
175
        - Method GET
176
      summary:  Return status of all slabs
177
      description: Returns status of slabs
178
        for each shared memory zone with slab allocator.
179
      operationId: getSlabs
180
      produces:
181
        - application/json
182
      parameters:
183
        - in: query
184
          name: fields
185
          type: string
186
          description: Limits which fields of slab zones will be output.
187
            If the “<literal>fields</literal>” value is empty,
188
            then only zone names will be output.
189
      responses:
190
        '200':
191
          description: Success
192
          schema:
193
            $ref: '#/definitions/NginxSlabZoneMap'
194
        '404':
195
          description: Unknown version (*UnknownVersion*)
196
          schema:
197
            $ref: '#/definitions/NginxError'
198
  '/slabs/{slabZoneName}':
199
    parameters:
200
      - name: slabZoneName
201
        in: path
202
        description: The name of the shared memory zone with slab allocator.
203
        required: true
204
        type: string
205
    get:
206
      tags:
207
        - Slabs
208
        - Method GET
209
      summary: Return status of a slab
210
      description: Returns status of slabs for a particular shared memory zone
211
        with slab allocator.
212
      operationId: getSlabZone
213
      produces:
214
        - application/json
215
      parameters:
216
        - in: query
217
          name: fields
218
          type: string
219
          description: Limits which fields of the slab zone will be output.
220
      responses:
221
        '200':
222
          description: Success
223
          schema:
224
            $ref: '#/definitions/NginxSlabZone'
225
        '404':
226
          description: |
227
            Slab not found (*SlabNotFound*),
228
            unknown version (*UnknownVersion*)
229
          schema:
230
            $ref: '#/definitions/NginxError'
231
    delete:
232
      tags:
233
        - Slabs
234
        - Method DELETE
235
      summary: Reset slab statistics
236
      description: Resets the “<literal>reqs</literal>” and “<literal>fails</literal>”
237
        metrics for each memory slot.
238
      operationId: deleteSlabZoneStats
239
      responses:
240
        '204':
241
          description: Success
242
        '404':
243
          description: |
244
            Slab not found (*SlabNotFound*),
245
            unknown version (*UnknownVersion*)
246
          schema:
247
            $ref: '#/definitions/NginxError'
248
        '405':
249
          description: Method disabled (*MethodDisabled*)
250
          schema:
251
            $ref: '#/definitions/NginxError'
252
  /http/:
253
    get:
254
      tags:
255
        - HTTP
256
        - Method GET
257
      summary: Return list of HTTP-related endpoints
258
      description: Returns a list of first level HTTP endpoints.
259
      operationId: getHttp
260
      produces:
261
        - application/json
262
      responses:
263
        '200':
264
          description: Success
265
          schema:
266
            $ref: '#/definitions/ArrayOfStrings'
267
        '404':
268
          description: Unknown version (*UnknownVersion*)
269
          schema:
270
            $ref: '#/definitions/NginxError'
271
  /http/requests:
272
    get:
273
      tags:
274
        - HTTP Requests
275
        - Method GET
276
      summary: Return HTTP requests statistics
277
      description: Returns status of client HTTP requests.
278
      operationId: getHttpRequests
279
      produces:
280
        - application/json
281
      parameters:
282
        - in: query
283
          name: fields
284
          type: string
285
          description: Limits which fields of client HTTP requests statistics
286
            will be output.
287
      responses:
288
        '200':
289
          description: Success
290
          schema:
291
            $ref: '#/definitions/NginxHTTPRequests'
292
        '404':
293
          description: Unknown version (*UnknownVersion*)
294
          schema:
295
            $ref: '#/definitions/NginxError'
296
    delete:
297
      tags:
298
        - HTTP Requests
299
        - Method DELETE
300
      summary: Reset HTTP requests statistics
301
      description: Resets the number of total client HTTP requests.
302
      operationId: deleteHttpRequests
303
      responses:
304
        '204':
305
          description: Success
306
        '404':
307
          description: Unknown version (*UnknownVersion*)
308
          schema:
309
            $ref: '#/definitions/NginxError'
310
        '405':
311
          description: Method disabled (*MethodDisabled*)
312
          schema:
313
            $ref: '#/definitions/NginxError'
314
  /http/server_zones/:
315
    get:
316
      tags:
317
        - HTTP Server Zones
318
        - Method GET
319
      summary: Return status of all HTTP server zones
320
      description: Returns status information for each HTTP
321
        [server zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone).
322
      operationId: getHttpServerZones
323
      produces:
324
        - application/json
325
      parameters:
326
        - in: query
327
          name: fields
328
          type: string
329
          description: Limits which fields of server zones will be output.
330
            If the “<literal>fields</literal>” value is empty,
331
            then only server zone names will be output.
332
      responses:
333
        '200':
334
          description: Success
335
          schema:
336
            $ref: '#/definitions/NginxHTTPServerZonesMap'
337
        '404':
338
          description: Unknown version (*UnknownVersion*)
339
          schema:
340
            $ref: '#/definitions/NginxError'
341
  '/http/server_zones/{httpServerZoneName}':
342
    parameters:
343
      - name: httpServerZoneName
344
        in: path
345
        description: The name of an HTTP server zone.
346
        type: string
347
        required: true
348
    get:
349
      tags:
350
        - HTTP Server Zones
351
        - Method GET
352
      summary: Return status of an HTTP server zone
353
      description: Returns status of a particular HTTP server zone.
354
      operationId: getHttpServerZone
355
      produces:
356
        - application/json
357
      parameters:
358
        - name: fields
359
          in: query
360
          type: string
361
          description: Limits which fields of the server zone will be output.
362
      responses:
363
        '200':
364
          description: Success
365
          schema:
366
            $ref: '#/definitions/NginxHTTPServerZone'
367
        '404':
368
          description: |
369
            Server zone not found (*ServerZoneNotFound*),
370
            unknown version (*UnknownVersion*)
371
          schema:
372
            $ref: '#/definitions/NginxError'
373
    delete:
374
      tags:
375
        - HTTP Server Zones
376
        - Method DELETE
377
      summary: Reset statistics for an HTTP server zone
378
      description: Resets statistics of accepted and discarded requests, responses,
379
        received and sent bytes, counters of SSL handshakes and session reuses
380
        in a particular HTTP server zone.
381
      operationId: deleteHttpServerZoneStat
382
      responses:
383
        '204':
384
          description: Success
385
        '404':
386
          description: |
387
            Server zone not found (*ServerZoneNotFound*),
388
            unknown version (*UnknownVersion*)
389
          schema:
390
            $ref: '#/definitions/NginxError'
391
        '405':
392
          description: Method disabled (*MethodDisabled*)
393
          schema:
394
            $ref: '#/definitions/NginxError'
395
  /http/location_zones/:
396
    get:
397
      tags:
398
        - HTTP Location Zones
399
        - Method GET
400
      summary: Return status of all HTTP location zones
401
      description: Returns status information for each HTTP
402
        [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
403
      operationId: getHttpLocationZones
404
      produces:
405
        - application/json
406
      parameters:
407
        - in: query
408
          name: fields
409
          type: string
410
          description: Limits which fields of location zones will be output.
411
            If the “<literal>fields</literal>” value is empty,
412
            then only zone names will be output.
413
      responses:
414
        '200':
415
          description: Success
416
          schema:
417
            $ref: '#/definitions/NginxHTTPLocationZonesMap'
418
        '404':
419
          description: Unknown version (*UnknownVersion*)
420
          schema:
421
            $ref: '#/definitions/NginxError'
422
  '/http/location_zones/{httpLocationZoneName}':
423
    parameters:
424
      - name: httpLocationZoneName
425
        in: path
426
        description: The name of an HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
427
        type: string
428
        required: true
429
    get:
430
      tags:
431
        - HTTP Location Zones
432
        - Method GET
433
      summary: Return status of an HTTP location zone
434
      description: Returns status of a particular
435
        HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
436
      operationId: getHttpLocationZone
437
      produces:
438
        - application/json
439
      parameters:
440
        - name: fields
441
          in: query
442
          type: string
443
          description: Limits which fields of the location zone will be output.
444
      responses:
445
        '200':
446
          description: Success
447
          schema:
448
            $ref: '#/definitions/NginxHTTPLocationZone'
449
        '404':
450
          description: |
451
            Location zone not found (*LocationZoneNotFound*),
452
            unknown version (*UnknownVersion*)
453
          schema:
454
            $ref: '#/definitions/NginxError'
455
    delete:
456
      tags:
457
        - HTTP Location Zones
458
        - Method DELETE
459
      summary: Reset statistics for a location zone.
460
      description: Resets statistics of accepted and discarded requests, responses,
461
        received and sent bytes in a particular location zone.
462
      operationId: deleteHttpLocationZoneStat
463
      responses:
464
        '204':
465
          description: Success
466
        '404':
467
          description: |
468
            Location zone not found (*LocationZoneNotFound*),
469
            unknown version (*UnknownVersion*)
470
          schema:
471
            $ref: '#/definitions/NginxError'
472
        '405':
473
          description: Method disabled (*MethodDisabled*)
474
          schema:
475
            $ref: '#/definitions/NginxError'
476
  /http/caches/:
477
    get:
478
      tags:
479
        - HTTP Caches
480
        - Method GET
481
      summary: Return status of all caches
482
      description: Returns status of each cache configured by
483
        [proxy_cache_path](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path)
484
        and other “<literal>*_cache_path</literal>” directives.
485
      operationId: getHttpCaches
486
      produces:
487
        - application/json
488
      parameters:
489
        - name: fields
490
          in: query
491
          type: string
492
          description: Limits which fields of cache zones will be output.
493
            If the “<literal>fields</literal>” value is empty,
494
            then only names of cache zones will be output.
495
      responses:
496
        '200':
497
          description: Success
498
          schema:
499
            $ref: '#/definitions/NginxHTTPCachesMap'
500
        '404':
501
          description: Unknown version (*UnknownVersion*)
502
          schema:
503
            $ref: '#/definitions/NginxError'
504
  '/http/caches/{httpCacheZoneName}':
505
    parameters:
506
      - name: httpCacheZoneName
507
        in: path
508
        description: The name of the cache zone.
509
        type: string
510
        required: true
511
    get:
512
      tags:
513
        - HTTP Caches
514
        - Method GET
515
      summary: Return status of a cache
516
      description: Returns status of a particular cache.
517
      operationId: getHttpCacheZone
518
      produces:
519
        - application/json
520
      parameters:
521
        - name: fields
522
          in: query
523
          type: string
524
          description: Limits which fields of the cache zone will be output.
525
      responses:
526
        '200':
527
          description: Success
528
          schema:
529
            $ref: '#/definitions/NginxHTTPCache'
530
        '404':
531
          description: |
532
            Cache not found (*CacheNotFound*),
533
            unknown version (*UnknownVersion*)
534
          schema:
535
            $ref: '#/definitions/NginxError'
536
    delete:
537
      tags:
538
        - HTTP Caches
539
        - Method DELETE
540
      summary: Reset cache statistics
541
      description: Resets statistics of cache hits/misses in a particular cache zone.
542
      operationId: deleteHttpCacheZoneStat
543
      responses:
544
        '204':
545
          description: Success
546
        '404':
547
          description: |
548
            Cache not found (*CacheNotFound*),
549
            unknown version (*UnknownVersion*)
550
          schema:
551
            $ref: '#/definitions/NginxError'
552
        '405':
553
          description: Method disabled (*MethodDisabled*)
554
          schema:
555
            $ref: '#/definitions/NginxError'
556
  /http/limit_conns/:
557
    get:
558
      tags:
559
        - HTTP Limit Conns
560
        - Method GET
561
      summary: Return status of all HTTP limit_conn zones
562
      description: Returns status information for each HTTP
563
        [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
564
      operationId: getHttpLimitConnZones
565
      produces:
566
        - application/json
567
      parameters:
568
        - in: query
569
          name: fields
570
          type: string
571
          description: Limits which fields of limit_conn zones will be output.
572
            If the “<literal>fields</literal>” value is empty,
573
            then only zone names will be output.
574
      responses:
575
        '200':
576
          description: Success
577
          schema:
578
            $ref: '#/definitions/NginxHTTPLimitConnZonesMap'
579
        '404':
580
          description: Unknown version (*UnknownVersion*)
581
          schema:
582
            $ref: '#/definitions/NginxError'
583
  '/http/limit_conns/{httpLimitConnZoneName}':
584
    parameters:
585
      - name: httpLimitConnZoneName
586
        in: path
587
        description: The name of a
588
          [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
589
        type: string
590
        required: true
591
    get:
592
      tags:
593
        - HTTP Limit Conns
594
        - Method GET
595
      summary: Return status of an HTTP limit_conn zone
596
      description: Returns status of a particular HTTP
597
        [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
598
      operationId: getHttpLimitConnZone
599
      produces:
600
        - application/json
601
      parameters:
602
        - name: fields
603
          in: query
604
          type: string
605
          description: Limits which fields of the
606
            [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone)
607
            will be output.
608
      responses:
609
        '200':
610
          description: Success
611
          schema:
612
            $ref: '#/definitions/NginxHTTPLimitConnZone'
613
        '404':
614
          description: |
615
            limit_conn not found (*LimitConnNotFound*),
616
            unknown version (*UnknownVersion*)
617
          schema:
618
            $ref: '#/definitions/NginxError'
619
    delete:
620
      tags:
621
        - HTTP Limit Conns
622
        - Method DELETE
623
      summary: Reset statistics for an HTTP limit_conn zone
624
      description: Resets the connection limiting statistics.
625
      operationId: deleteHttpLimitConnZoneStat
626
      responses:
627
        '204':
628
          description: Success
629
        '404':
630
          description: |
631
            limit_conn not found (*LimitConnNotFound*),
632
            unknown version (*UnknownVersion*)
633
          schema:
634
            $ref: '#/definitions/NginxError'
635
        '405':
636
          description: Method disabled (*MethodDisabled*)
637
          schema:
638
            $ref: '#/definitions/NginxError'
639
  /http/limit_reqs/:
640
    get:
641
      tags:
642
        - HTTP Limit Reqs
643
        - Method GET
644
      summary: Return status of all HTTP limit_req zones
645
      description: Returns status information for each HTTP
646
        [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
647
      operationId: getHttpLimitReqZones
648
      produces:
649
        - application/json
650
      parameters:
651
        - in: query
652
          name: fields
653
          type: string
654
          description: Limits which fields of limit_req zones will be output.
655
            If the “<literal>fields</literal>” value is empty,
656
            then only zone names will be output.
657
      responses:
658
        '200':
659
          description: Success
660
          schema:
661
            $ref: '#/definitions/NginxHTTPLimitReqZonesMap'
662
        '404':
663
          description: Unknown version (*UnknownVersion*)
664
          schema:
665
            $ref: '#/definitions/NginxError'
666
  '/http/limit_reqs/{httpLimitReqZoneName}':
667
    parameters:
668
      - name: httpLimitReqZoneName
669
        in: path
670
        description: The name of a
671
          [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
672
        type: string
673
        required: true
674
    get:
675
      tags:
676
        - HTTP Limit Reqs
677
        - Method GET
678
      summary: Return status of an HTTP limit_req zone
679
      description: Returns status of a particular HTTP
680
        [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
681
      operationId: getHttpLimitReqZone
682
      produces:
683
        - application/json
684
      parameters:
685
        - name: fields
686
          in: query
687
          type: string
688
          description: Limits which fields of the
689
            [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone)
690
            will be output.
691
      responses:
692
        '200':
693
          description: Success
694
          schema:
695
            $ref: '#/definitions/NginxHTTPLimitReqZone'
696
        '404':
697
          description: |
698
            limit_req not found (*LimitReqNotFound*),
699
            unknown version (*UnknownVersion*)
700
          schema:
701
            $ref: '#/definitions/NginxError'
702
    delete:
703
      tags:
704
        - HTTP Limit Reqs
705
        - Method DELETE
706
      summary: Reset statistics for an HTTP limit_req zone
707
      description: Resets the requests limiting statistics.
708
      operationId: deleteHttpLimitReqZoneStat
709
      responses:
710
        '204':
711
          description: Success
712
        '404':
713
          description: |
714
            limit_req not found (*LimitReqNotFound*),
715
            unknown version (*UnknownVersion*)
716
          schema:
717
            $ref: '#/definitions/NginxError'
718
        '405':
719
          description: Method disabled (*MethodDisabled*)
720
          schema:
721
            $ref: '#/definitions/NginxError'
722
  /http/upstreams/:
723
    get:
724
      tags:
725
        - HTTP Upstreams
726
        - Method GET
727
      summary: Return status of all HTTP upstream server groups
728
      description: Returns status of each HTTP upstream server group
729
        and its servers.
730
      operationId: getHttpUpstreams
731
      produces:
732
        - application/json
733
      parameters:
734
        - name: fields
735
          in: query
736
          type: string
737
          description: Limits which fields of upstream server groups will be output.
738
            If the “<literal>fields</literal>” value is empty,
739
            only names of upstreams will be output.
740
      responses:
741
        '200':
742
          description: Success
743
          schema:
744
            $ref: '#/definitions/NginxHTTPUpstreamMap'
745
        '404':
746
          description: Unknown version (*UnknownVersion*)
747
          schema:
748
            $ref: '#/definitions/NginxError'
749
  '/http/upstreams/{httpUpstreamName}/':
750
    parameters:
751
    - name: httpUpstreamName
752
      in: path
753
      description: The name of an HTTP upstream server group.
754
      required: true
755
      type: string
756
    get:
757
      tags:
758
        - HTTP Upstreams
759
        - Method GET
760
      summary: Return status of an HTTP upstream server group
761
      description: Returns status of a particular HTTP upstream server group
762
        and its servers.
763
      operationId: getHttpUpstreamName
764
      produces:
765
        - application/json
766
      parameters:
767
        - name: fields
768
          in: query
769
          type: string
770
          description: Limits which fields of the upstream server group will be output.
771
      responses:
772
        '200':
773
          description: Success
774
          schema:
775
            $ref: '#/definitions/NginxHTTPUpstream'
776
        '400':
777
          description: Upstream is static (*UpstreamStatic*)
778
          schema:
779
            $ref: '#/definitions/NginxError'
780
        '404':
781
          description: |
782
            Unknown version (*UnknownVersion*),
783
            upstream not found (*UpstreamNotFound*)
784
          schema:
785
            $ref: '#/definitions/NginxError'
786
    delete:
787
      tags:
788
        - HTTP Upstreams
789
        - Method DELETE
790
      summary: Reset statistics of an HTTP upstream server group
791
      description: Resets the statistics for each upstream server
792
        in an upstream server group and queue statistics.
793
      operationId: deleteHttpUpstreamStat
794
      produces:
795
        - application/json
796
      responses:
797
        '204':
798
          description: Success
799
        '400':
800
          description: Upstream is static (*UpstreamStatic*)
801
          schema:
802
            $ref: '#/definitions/NginxError'
803
        '404':
804
          description: |
805
            Unknown version (*UnknownVersion*),
806
            upstream not found (*UpstreamNotFound*)
807
          schema:
808
            $ref: '#/definitions/NginxError'
809
        '405':
810
          description: Method disabled (*MethodDisabled*)
811
          schema:
812
            $ref: '#/definitions/NginxError'
813
  '/http/upstreams/{httpUpstreamName}/servers/':
814
    parameters:
815
      - name: httpUpstreamName
816
        in: path
817
        description: The name of an upstream server group.
818
        required: true
819
        type: string
820
    get:
821
      tags:
822
        - HTTP Upstreams
823
        - Method GET
824
      summary: Return configuration of all servers in an HTTP upstream server group
825
      description: Returns configuration of each server
826
        in a particular HTTP upstream server group.
827
      operationId: getHttpUpstreamServers
828
      produces:
829
        - application/json
830
      responses:
831
        '200':
832
          description: Success
833
          schema:
834
            $ref: '#/definitions/NginxHTTPUpstreamConfServerMap'
835
        '400':
836
          description: Upstream is static (*UpstreamStatic*)
837
          schema:
838
            $ref: '#/definitions/NginxError'
839
        '404':
840
          description: |
841
            Unknown version (*UnknownVersion*),
842
            upstream not found (*UpstreamNotFound*)
843
          schema:
844
            $ref: '#/definitions/NginxError'
845
    post:
846
      tags:
847
        - HTTP Upstreams
848
        - Method POST
849
      summary: Add a server to an HTTP upstream server group
850
      description: Adds a new server to an HTTP upstream server group.
851
        Server parameters are specified in the JSON format.
852
      operationId: postHttpUpstreamServer
853
      produces:
854
        - application/json
855
      parameters:
856
        - in: body
857
          name: postHttpUpstreamServer
858
          description: Address of a new server and other optional parameters
859
            in the JSON format.
860
            The “*ID*”, “*backup*”, and “*service*” parameters
861
            cannot be changed.
862
          required: true
863
          schema:
864
            $ref: '#/definitions/NginxHTTPUpstreamConfServer'
865
      responses:
866
        '201':
867
          description: Created
868
          schema:
869
            $ref: '#/definitions/NginxHTTPUpstreamConfServer'
870
        '400':
871
          description: |
872
            Upstream is static (*UpstreamStatic*),
873
            invalid “**parameter**” value (*UpstreamConfFormatError*),
874
            missing “*server*” argument (*UpstreamConfFormatError*),
875
            unknown parameter “**name**” (*UpstreamConfFormatError*),
876
            nested object or list (*UpstreamConfFormatError*),
877
            “*error*” while parsing (*UpstreamBadAddress*),
878
            service upstream “*host*” may not have port (*UpstreamBadAddress*),
879
            service upstream “*host*” requires domain name (*UpstreamBadAddress*),
880
            invalid “*weight*” (*UpstreamBadWeight*),
881
            invalid “*max_conns*” (*UpstreamBadMaxConns*),
882
            invalid “*max_fails*” (*UpstreamBadMaxFails*),
883
            invalid “*fail_timeout*” (*UpstreamBadFailTimeout*),
884
            invalid “*slow_start*” (*UpstreamBadSlowStart*),
885
            reading request body failed *BodyReadError*),
886
            route is too long (*UpstreamBadRoute*),
887
            “*service*” is empty (*UpstreamBadService*),
888
            no resolver defined to resolve (*UpstreamConfNoResolver*),
889
            upstream “**name**” has no backup (*UpstreamNoBackup*),
890
            upstream “**name**” memory exhausted (*UpstreamOutOfMemory*)
891
          schema:
892
            $ref: '#/definitions/NginxError'
893
        '404':
894
          description: |
895
            Unknown version (*UnknownVersion*),
896
            upstream not found (*UpstreamNotFound*)
897
          schema:
898
            $ref: '#/definitions/NginxError'
899
        '405':
900
          description: Method disabled (*MethodDisabled*)
901
          schema:
902
            $ref: '#/definitions/NginxError'
903
        '409':
904
          description: Entry exists (*EntryExists*)
905
          schema:
906
            $ref: '#/definitions/NginxError'
907
        '415':
908
          description: JSON error (*JsonError*)
909
          schema:
910
            $ref: '#/definitions/NginxError'
911
  '/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}':
912
    parameters:
913
      - name: httpUpstreamName
914
        in: path
915
        description: The name of the upstream server group.
916
        required: true
917
        type: string
918
      - name: httpUpstreamServerId
919
        in: path
920
        description: The ID of the server.
921
        required: true
922
        type: string
923
    get:
924
      tags:
925
        - HTTP Upstreams
926
        - Method GET
927
      summary: Return configuration of a server in an HTTP upstream server group
928
      description: Returns configuration of a particular server
929
        in the HTTP upstream server group.
930
      operationId: getHttpUpstreamPeer
931
      produces:
932
        - application/json
933
      responses:
934
        '200':
935
          description: Success
936
          schema:
937
            $ref: '#/definitions/NginxHTTPUpstreamConfServer'
938
        '400':
939
          description: |
940
            Upstream is static (*UpstreamStatic*),
941
            invalid server ID (*UpstreamBadServerId*)
942
          schema:
943
            $ref: '#/definitions/NginxError'
944
        '404':
945
          description: |
946
            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
947
            unknown version (*UnknownVersion*),
948
            upstream not found (*UpstreamNotFound*)
949
          schema:
950
            $ref: '#/definitions/NginxError'
951
    patch:
952
      tags:
953
        - HTTP Upstreams
954
        - Method PATCH
955
      summary: Modify a server in an HTTP upstream server group
956
      description: Modifies settings of a particular server
957
        in an HTTP upstream server group.
958
        Server parameters are specified in the JSON format.
959
      operationId: patchHttpUpstreamPeer
960
      produces:
961
        - application/json
962
      parameters:
963
        - in: body
964
          name: patchHttpUpstreamServer
965
          description: Server parameters, specified in the JSON format.
966
            The “*ID*”, “*backup*”, and “*service*” parameters
967
            cannot be changed.
968
          required: true
969
          schema:
970
            $ref: '#/definitions/NginxHTTPUpstreamConfServer'
971
      responses:
972
        '200':
973
          description: Success
974
          schema:
975
            $ref: '#/definitions/NginxHTTPUpstreamConfServer'
976
        '400':
977
          description: |
978
            Upstream is static (*UpstreamStatic*),
979
            invalid “**parameter**” value (*UpstreamConfFormatError*),
980
            unknown parameter “**name**” (*UpstreamConfFormatError*),
981
            nested object or list (*UpstreamConfFormatError*),
982
            “*error*” while parsing (*UpstreamBadAddress*),
983
            invalid “*server*” argument (*UpstreamBadAddress*),
984
            invalid server ID (*UpstreamBadServerId*),
985
            invalid “*weight*” (*UpstreamBadWeight*),
986
            invalid “*max_conns*” (*UpstreamBadMaxConns*),
987
            invalid “*max_fails*” (*UpstreamBadMaxFails*),
988
            invalid “*fail_timeout*” (*UpstreamBadFailTimeout*),
989
            invalid “*slow_start*” (*UpstreamBadSlowStart*),
990
            reading request body failed *BodyReadError*),
991
            route is too long (*UpstreamBadRoute*),
992
            “*service*” is empty (*UpstreamBadService*),
993
            server “**ID**” address is immutable (*UpstreamServerImmutable*),
994
            server “*ID*” weight is immutable (*UpstreamServerWeightImmutable*),
995
            upstream “*name*” memory exhausted (*UpstreamOutOfMemory*)
996
          schema:
997
            $ref: '#/definitions/NginxError'
998
        '404':
999
          description: |
1000
            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1001
            unknown version (*UnknownVersion*),
1002
            upstream not found (*UpstreamNotFound*)
1003
          schema:
1004
            $ref: '#/definitions/NginxError'
1005
        '405':
1006
          description: Method disabled (*MethodDisabled*)
1007
          schema:
1008
            $ref: '#/definitions/NginxError'
1009
        '415':
1010
          description: JSON error (*JsonError*)
1011
          schema:
1012
            $ref: '#/definitions/NginxError'
1013
    delete:
1014
      tags:
1015
        - HTTP Upstreams
1016
        - Method DELETE
1017
      summary: Remove a server from an HTTP upstream server group
1018
      description: Removes a server from an HTTP upstream server group.
1019
      operationId: deleteHttpUpstreamServer
1020
      produces:
1021
        - application/json
1022
      responses:
1023
        '200':
1024
          description: Success
1025
          schema:
1026
            $ref: '#/definitions/NginxHTTPUpstreamConfServerMap'
1027
        '400':
1028
          description: |
1029
            Upstream is static (*UpstreamStatic*),
1030
            invalid server ID (*UpstreamBadServerId*),
1031
            server “**id**” not removable (*UpstreamServerImmutable*)
1032
          schema:
1033
            $ref: '#/definitions/NginxError'
1034
        '404':
1035
          description: |
1036
            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1037
            unknown version (*UnknownVersion*),
1038
            upstream not found (*UpstreamNotFound*)
1039
          schema:
1040
            $ref: '#/definitions/NginxError'
1041
        '405':
1042
          description: Method disabled (*MethodDisabled*)
1043
          schema:
1044
            $ref: '#/definitions/NginxError'
1045
  /http/keyvals/:
1046
    get:
1047
      tags:
1048
        - HTTP Keyvals
1049
        - Method GET
1050
      summary: Return key-value pairs from all HTTP keyval zones
1051
      description: Returns key-value pairs for each HTTP keyval shared memory
1052
        [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
1053
      operationId: getHttpKeyvalZones
1054
      produces:
1055
        - application/json
1056
      parameters:
1057
        - name: fields
1058
          in: query
1059
          type: string
1060
          description: If the “<literal>fields</literal>” value is empty,
1061
            then only HTTP keyval zone names will be output.
1062
      responses:
1063
        '200':
1064
          description: Success
1065
          schema:
1066
            $ref: '#/definitions/NginxHTTPKeyvalZonesMap'
1067
        '404':
1068
          description: Unknown version (*UnknownVersion*)
1069
          schema:
1070
            $ref: '#/definitions/NginxError'
1071
  '/http/keyvals/{httpKeyvalZoneName}':
1072
    parameters:
1073
      - name: httpKeyvalZoneName
1074
        in: path
1075
        description: The name of an HTTP keyval shared memory zone.
1076
        required: true
1077
        type: string
1078
    get:
1079
      tags:
1080
        - HTTP Keyvals
1081
        - Method GET
1082
      summary: Return key-value pairs from an HTTP keyval zone
1083
      description: Returns key-value pairs stored in a particular HTTP keyval shared memory
1084
        [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
1085
      operationId: getHttpKeyvalZoneKeysValues
1086
      produces:
1087
        - application/json
1088
      parameters:
1089
        - name: key
1090
          in: query
1091
          type: string
1092
          description: Get a particular key-value pair from the HTTP keyval zone.
1093
      responses:
1094
        '200':
1095
          description: Success
1096
          schema:
1097
            $ref: '#/definitions/NginxHTTPKeyvalZone'
1098
        '404':
1099
          description: |
1100
            Keyval not found (*KeyvalNotFound*),
1101
            keyval key not found (*KeyvalKeyNotFound*),
1102
            unknown version (*UnknownVersion*)
1103
          schema:
1104
            $ref: '#/definitions/NginxError'
1105
    post:
1106
      tags:
1107
        - HTTP Keyvals
1108
        - Method POST
1109
      summary: Add a key-value pair to the HTTP keyval zone
1110
      description: Adds a new key-value pair to the HTTP keyval shared memory
1111
        [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
1112
        Several key-value pairs can be entered
1113
        if the HTTP keyval shared memory zone is empty.
1114
      operationId: postHttpKeyvalZoneData
1115
      produces:
1116
        - application/json
1117
      parameters:
1118
        - in: body
1119
          name: Key-value
1120
          description: A key-value pair is specified in the JSON format.
1121
            Several key-value pairs can be entered
1122
            if the HTTP keyval shared memory zone is empty.
1123
            Expiration time in milliseconds can be specified for a key-value pair
1124
            with the *expire* parameter
1125
            which overrides the [*timeout*](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout)
1126
            parameter of the
1127
            <a href="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</a>
1128
            directive.
1129
          required: true
1130
          schema:
1131
            $ref: '#/definitions/NginxHTTPKeyvalZonePostPatch'
1132
      responses:
1133
        '201':
1134
          description: Created
1135
        '400':
1136
          description: |
1137
            Invalid JSON (*KeyvalFormatError*),
1138
            invalid key format (*KeyvalFormatError*),
1139
            key required (*KeyvalFormatError*),
1140
            keyval timeout is not enabled (*KeyvalFormatError*),
1141
            only one key can be added (*KeyvalFormatError*),
1142
            reading request body failed *BodyReadError*)
1143
          schema:
1144
            $ref: '#/definitions/NginxError'
1145
        '404':
1146
          description: |
1147
            Keyval not found (*KeyvalNotFound*),
1148
            unknown version (*UnknownVersion*)
1149
          schema:
1150
            $ref: '#/definitions/NginxError'
1151
        '405':
1152
          description: Method disabled (*MethodDisabled*)
1153
          schema:
1154
            $ref: '#/definitions/NginxError'
1155
        '409':
1156
          description: |
1157
            Entry exists (*EntryExists*),
1158
            key already exists (*KeyvalKeyExists*)
1159
          schema:
1160
            $ref: '#/definitions/NginxError'
1161
        '413':
1162
          description: Request Entity Too Large
1163
          schema:
1164
            $ref: '#/definitions/NginxError'
1165
        '415':
1166
          description: JSON error (*JsonError*)
1167
          schema:
1168
            $ref: '#/definitions/NginxError'
1169
    patch:
1170
      tags:
1171
        - HTTP Keyvals
1172
        - Method PATCH
1173
      summary: Modify a key-value or delete a key
1174
      description: Changes the value of the selected key in the key-value pair,
1175
        deletes a key by setting the key value to <literal>null</literal>,
1176
        changes expiration time of a key-value pair.
1177
        If
1178
        <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>
1179
        of keyval zones in a cluster is enabled,
1180
        deletes a key only on a target cluster node.
1181
        Expiration time in milliseconds can be specified for a key-value pair
1182
        with the *expire* parameter
1183
        which overrides the [*timeout*](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout)
1184
        parameter of the
1185
        <a href="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</a>
1186
        directive.
1187
      operationId: patchHttpKeyvalZoneKeyValue
1188
      produces:
1189
        - application/json
1190
      parameters:
1191
        - in: body
1192
          name: httpKeyvalZoneKeyValue
1193
          description: A new value for the key is specified in the JSON format.
1194
          required: true
1195
          schema:
1196
            $ref: '#/definitions/NginxHTTPKeyvalZonePostPatch'
1197
      responses:
1198
        '204':
1199
          description: Success
1200
        '400':
1201
          description: |
1202
            Invalid JSON (*KeyvalFormatError*),
1203
            key required (*KeyvalFormatError*),
1204
            keyval timeout is not enabled (*KeyvalFormatError*),
1205
            only one key can be updated (*KeyvalFormatError*),
1206
            reading request body failed *BodyReadError*)
1207
          schema:
1208
            $ref: '#/definitions/NginxError'
1209
        '404':
1210
          description: |
1211
            Keyval not found (*KeyvalNotFound*),
1212
            keyval key not found (*KeyvalKeyNotFound*),
1213
            unknown version (*UnknownVersion*)
1214
          schema:
1215
            $ref: '#/definitions/NginxError'
1216
        '405':
1217
          description: Method disabled (*MethodDisabled*)
1218
          schema:
1219
            $ref: '#/definitions/NginxError'
1220
        '413':
1221
          description: Request Entity Too Large
1222
          schema:
1223
            $ref: '#/definitions/NginxError'
1224
        '415':
1225
          description: JSON error (*JsonError*)
1226
          schema:
1227
            $ref: '#/definitions/NginxError'
1228
    delete:
1229
      tags:
1230
        - HTTP Keyvals
1231
        - Method DELETE
1232
      summary: Empty the HTTP keyval zone
1233
      description: Deletes all key-value pairs from the HTTP keyval shared memory
1234
        [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
1235
        If
1236
        <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>
1237
        of keyval zones in a cluster is enabled,
1238
        empties the keyval zone only on a target cluster node.
1239
      operationId: deleteHttpKeyvalZoneData
1240
      responses:
1241
        '204':
1242
          description: Success
1243
        '404':
1244
          description: |
1245
            Keyval not found (*KeyvalNotFound*),
1246
            unknown version (*UnknownVersion*)
1247
          schema:
1248
            $ref: '#/definitions/NginxError'
1249
        '405':
1250
          description: Method disabled (*MethodDisabled*)
1251
          schema:
1252
            $ref: '#/definitions/NginxError'
1253
  /stream/:
1254
    get:
1255
      tags:
1256
        - Stream
1257
      summary: Return list of stream-related endpoints
1258
      description: Returns a list of first level stream endpoints.
1259
      operationId: getStream
1260
      produces:
1261
        - application/json
1262
      responses:
1263
        '200':
1264
          description: Success
1265
          schema:
1266
            $ref: '#/definitions/ArrayOfStrings'
1267
        '404':
1268
          description: Unknown version (*UnknownVersion*)
1269
          schema:
1270
            $ref: '#/definitions/NginxError'
1271
  /stream/server_zones/:
1272
    get:
1273
      tags:
1274
        - Stream Server Zones
1275
        - Method GET
1276
      summary: Return status of all stream server zones
1277
      description: Returns status information for each stream
1278
        [server zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone).
1279
      operationId: getStreamServerZones
1280
      produces:
1281
        - application/json
1282
      parameters:
1283
        - name: fields
1284
          in: query
1285
          type: string
1286
          description: Limits which fields of server zones will be output.
1287
            If the “<literal>fields</literal>” value is empty,
1288
            then only server zone names will be output.
1289
      responses:
1290
        '200':
1291
          description: Success
1292
          schema:
1293
            $ref: '#/definitions/NginxStreamServerZonesMap'
1294
        '404':
1295
          description: Unknown version (*UnknownVersion*)
1296
          schema:
1297
            $ref: '#/definitions/NginxError'
1298
  '/stream/server_zones/{streamServerZoneName}':
1299
    parameters:
1300
      - name: streamServerZoneName
1301
        in: path
1302
        description: The name of a stream server zone.
1303
        type: string
1304
        required: true
1305
    get:
1306
      tags:
1307
        - Stream Server Zones
1308
        - Method GET
1309
      summary: Return status of a stream server zone
1310
      description: Returns status of a particular stream server zone.
1311
      operationId: getStreamServerZone
1312
      produces:
1313
        - application/json
1314
      parameters:
1315
        - name: fields
1316
          in: query
1317
          type: string
1318
          description: Limits which fields of the server zone will be output.
1319
      responses:
1320
        '200':
1321
          description: Success
1322
          schema:
1323
            $ref: '#/definitions/NginxStreamServerZone'
1324
        '404':
1325
          description: |
1326
            Server zone not found (*ServerZoneNotFound*),
1327
            unknown version (*UnknownVersion*)
1328
          schema:
1329
            $ref: '#/definitions/NginxError'
1330
    delete:
1331
      tags:
1332
        - Stream Server Zones
1333
        - Method DELETE
1334
      summary: Reset statistics for a stream server zone
1335
      description: Resets statistics of accepted and discarded connections, sessions,
1336
        received and sent bytes, counters of SSL handshakes and session reuses
1337
        in a particular stream server zone.
1338
      operationId: deleteStreamServerZoneStat
1339
      responses:
1340
        '204':
1341
          description: Success
1342
        '404':
1343
          description: |
1344
            Server zone not found (*ServerZoneNotFound*),
1345
            unknown version (*UnknownVersion*)
1346
          schema:
1347
            $ref: '#/definitions/NginxError'
1348
        '405':
1349
          description: Method disabled (*MethodDisabled*)
1350
          schema:
1351
            $ref: '#/definitions/NginxError'
1352
  /stream/limit_conns/:
1353
    get:
1354
      tags:
1355
        - Stream Limit Conns
1356
        - Method GET
1357
      summary: Return status of all stream limit_conn zones
1358
      description: Returns status information for each stream
1359
        [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
1360
      operationId: getStreamLimitConnZones
1361
      produces:
1362
        - application/json
1363
      parameters:
1364
        - in: query
1365
          name: fields
1366
          type: string
1367
          description: Limits which fields of limit_conn zones will be output.
1368
            If the “<literal>fields</literal>” value is empty,
1369
            then only zone names will be output.
1370
      responses:
1371
        '200':
1372
          description: Success
1373
          schema:
1374
            $ref: '#/definitions/NginxStreamLimitConnZonesMap'
1375
        '404':
1376
          description: Unknown version (*UnknownVersion*)
1377
          schema:
1378
            $ref: '#/definitions/NginxError'
1379
  '/stream/limit_conns/{streamLimitConnZoneName}':
1380
    parameters:
1381
      - name: streamLimitConnZoneName
1382
        in: path
1383
        description: The name of a
1384
          [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
1385
        type: string
1386
        required: true
1387
    get:
1388
      tags:
1389
        - Stream Limit Conns
1390
        - Method GET
1391
      summary: Return status of an stream limit_conn zone
1392
      description: Returns status of a particular stream
1393
        [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
1394
      operationId: getStreamLimitConnZone
1395
      produces:
1396
        - application/json
1397
      parameters:
1398
        - name: fields
1399
          in: query
1400
          type: string
1401
          description: Limits which fields of the
1402
            [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone)
1403
            will be output.
1404
      responses:
1405
        '200':
1406
          description: Success
1407
          schema:
1408
            $ref: '#/definitions/NginxStreamLimitConnZone'
1409
        '404':
1410
          description: |
1411
            limit_conn not found (*LimitConnNotFound*),
1412
            unknown version (*UnknownVersion*)
1413
          schema:
1414
            $ref: '#/definitions/NginxError'
1415
    delete:
1416
      tags:
1417
        - Stream Limit Conns
1418
        - Method DELETE
1419
      summary: Reset statistics for a stream limit_conn zone
1420
      description: Resets the connection limiting statistics.
1421
      operationId: deleteStreamLimitConnZoneStat
1422
      responses:
1423
        '204':
1424
          description: Success
1425
        '404':
1426
          description: |
1427
            limit_conn not found (*LimitConnNotFound*),
1428
            unknown version (*UnknownVersion*)
1429
          schema:
1430
            $ref: '#/definitions/NginxError'
1431
        '405':
1432
          description: Method disabled (*MethodDisabled*)
1433
          schema:
1434
            $ref: '#/definitions/NginxError'
1435
  /stream/upstreams/:
1436
    get:
1437
      tags:
1438
        - Stream Upstreams
1439
        - Method GET
1440
      summary: Return status of all stream upstream server groups
1441
      description: Returns status of each stream upstream server group
1442
        and its servers.
1443
      operationId: getStreamUpstreams
1444
      produces:
1445
        - application/json
1446
      parameters:
1447
        - name: fields
1448
          in: query
1449
          type: string
1450
          description: Limits which fields of upstream server groups will be output.
1451
            If the “<literal>fields</literal>” value is empty,
1452
            only names of upstreams will be output.
1453
      responses:
1454
        '200':
1455
          description: Success
1456
          schema:
1457
            $ref: '#/definitions/NginxStreamUpstreamMap'
1458
        '404':
1459
          description: Unknown version (*UnknownVersion*)
1460
          schema:
1461
            $ref: '#/definitions/NginxError'
1462
  '/stream/upstreams/{streamUpstreamName}/':
1463
    parameters:
1464
    - name: streamUpstreamName
1465
      in: path
1466
      description: The name of a stream upstream server group.
1467
      required: true
1468
      type: string
1469
    get:
1470
      tags:
1471
        - Stream Upstreams
1472
        - Method GET
1473
      summary: Return status of a stream upstream server group
1474
      description: Returns status of a particular stream upstream server group
1475
        and its servers.
1476
      operationId: getStreamUpstream
1477
      produces:
1478
        - application/json
1479
      parameters:
1480
        - name: fields
1481
          in: query
1482
          type: string
1483
          description: Limits which fields of the upstream server group will be output.
1484
      responses:
1485
        '200':
1486
          description: Success
1487
          schema:
1488
            $ref: '#/definitions/NginxStreamUpstream'
1489
        '400':
1490
          description: Upstream is static (*UpstreamStatic*)
1491
          schema:
1492
            $ref: '#/definitions/NginxError'
1493
        '404':
1494
          description: |
1495
            Unknown version (*UnknownVersion*),
1496
            upstream not found (*UpstreamNotFound*)
1497
          schema:
1498
            $ref: '#/definitions/NginxError'
1499
    delete:
1500
      tags:
1501
        - Stream Upstreams
1502
        - Method DELETE
1503
      summary: Reset statistics of a stream upstream server group
1504
      description: Resets the statistics for each upstream server
1505
        in an upstream server group.
1506
      operationId: deleteStreamUpstreamStat
1507
      produces:
1508
        - application/json
1509
      responses:
1510
        '204':
1511
          description: Success
1512
        '400':
1513
          description: Upstream is static (*UpstreamStatic*)
1514
          schema:
1515
            $ref: '#/definitions/NginxError'
1516
        '404':
1517
          description: |
1518
            Unknown version (*UnknownVersion*),
1519
            upstream not found (*UpstreamNotFound*)
1520
          schema:
1521
            $ref: '#/definitions/NginxError'
1522
        '405':
1523
          description: Method disabled (*MethodDisabled*)
1524
          schema:
1525
            $ref: '#/definitions/NginxError'
1526
  '/stream/upstreams/{streamUpstreamName}/servers/':
1527
    parameters:
1528
      - name: streamUpstreamName
1529
        in: path
1530
        description: The name of an upstream server group.
1531
        required: true
1532
        type: string
1533
    get:
1534
      tags:
1535
        - Stream Upstreams
1536
        - Method GET
1537
      summary: Return configuration of all servers in a stream upstream server group
1538
      description: Returns configuration of each server
1539
        in a particular stream upstream server group.
1540
      operationId: getStreamUpstreamServers
1541
      produces:
1542
        - application/json
1543
      responses:
1544
        '200':
1545
          description: Success
1546
          schema:
1547
            $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
1548
        '400':
1549
          description: Upstream is static (*UpstreamStatic*)
1550
          schema:
1551
            $ref: '#/definitions/NginxError'
1552
        '404':
1553
          description: |
1554
            Unknown version (*UnknownVersion*),
1555
            upstream not found (*UpstreamNotFound*)
1556
          schema:
1557
            $ref: '#/definitions/NginxError'
1558
    post:
1559
      tags:
1560
        - Stream Upstreams
1561
        - Method POST
1562
      summary: Add a server to a stream upstream server group
1563
      description: Adds a new server to a stream upstream server group.
1564
        Server parameters are specified in the JSON format.
1565
      operationId: postStreamUpstreamServer
1566
      produces:
1567
        - application/json
1568
      parameters:
1569
        - in: body
1570
          name: postStreamUpstreamServer
1571
          description: Address of a new server and other optional parameters
1572
            in the JSON format.
1573
            The “*ID*”, “*backup*”, and “*service*” parameters
1574
            cannot be changed.
1575
          required: true
1576
          schema:
1577
            $ref: '#/definitions/NginxStreamUpstreamConfServer'
1578
      responses:
1579
        '201':
1580
          description: Created
1581
          schema:
1582
            $ref: '#/definitions/NginxStreamUpstreamConfServer'
1583
        '400':
1584
          description: |
1585
            Upstream is static (*UpstreamStatic*),
1586
            invalid “**parameter**” value (*UpstreamConfFormatError*),
1587
            missing “*server*” argument (*UpstreamConfFormatError*),
1588
            unknown parameter “**name**” (*UpstreamConfFormatError*),
1589
            nested object or list (*UpstreamConfFormatError*),
1590
            “*error*” while parsing (*UpstreamBadAddress*),
1591
            no port in server “*host*” (*UpstreamBadAddress*),
1592
            service upstream “*host*” may not have port (*UpstreamBadAddress*),
1593
            service upstream “*host*” requires domain name (*UpstreamBadAddress*),
1594
            invalid “*weight*” (*UpstreamBadWeight*),
1595
            invalid “*max_conns*” (*UpstreamBadMaxConns*),
1596
            invalid “*max_fails*” (*UpstreamBadMaxFails*),
1597
            invalid “*fail_timeout*” (*UpstreamBadFailTimeout*),
1598
            invalid “*slow_start*” (*UpstreamBadSlowStart*),
1599
            “*service*” is empty (*UpstreamBadService*),
1600
            no resolver defined to resolve (*UpstreamConfNoResolver*),
1601
            upstream “**name**” has no backup (*UpstreamNoBackup*),
1602
            upstream “**name**” memory exhausted (*UpstreamOutOfMemory*),
1603
            reading request body failed *BodyReadError*)
1604
          schema:
1605
            $ref: '#/definitions/NginxError'
1606
        '404':
1607
          description: |
1608
            Unknown version (*UnknownVersion*),
1609
            upstream not found (*UpstreamNotFound*)
1610
          schema:
1611
            $ref: '#/definitions/NginxError'
1612
        '405':
1613
          description: Method disabled (*MethodDisabled*)
1614
          schema:
1615
            $ref: '#/definitions/NginxError'
1616
        '409':
1617
          description: Entry exists (*EntryExists*)
1618
          schema:
1619
            $ref: '#/definitions/NginxError'
1620
        '415':
1621
          description: JSON error (*JsonError*)
1622
          schema:
1623
            $ref: '#/definitions/NginxError'
1624
  '/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}':
1625
    parameters:
1626
      - name: streamUpstreamName
1627
        in: path
1628
        description: The name of the upstream server group.
1629
        required: true
1630
        type: string
1631
      - name: streamUpstreamServerId
1632
        in: path
1633
        description: The ID of the server.
1634
        required: true
1635
        type: string
1636
    get:
1637
      tags:
1638
        - Stream Upstreams
1639
        - Method GET
1640
      summary: Return configuration of a server in a stream upstream server group
1641
      description: Returns configuration of a particular server
1642
        in the stream upstream server group.
1643
      operationId: getStreamUpstreamServer
1644
      produces:
1645
        - application/json
1646
      responses:
1647
        '200':
1648
          description: Success
1649
          schema:
1650
            $ref: '#/definitions/NginxStreamUpstreamConfServer'
1651
        '400':
1652
          description: |
1653
            Upstream is static (*UpstreamStatic*),
1654
            invalid server ID (*UpstreamBadServerId*)
1655
          schema:
1656
            $ref: '#/definitions/NginxError'
1657
        '404':
1658
          description: |
1659
            Unknown version (*UnknownVersion*),
1660
            upstream not found (*UpstreamNotFound*),
1661
            server with ID “**id**” does not exist (*UpstreamServerNotFound*)
1662
          schema:
1663
            $ref: '#/definitions/NginxError'
1664
    patch:
1665
      tags:
1666
        - Stream Upstreams
1667
        - Method PATCH
1668
      summary: Modify a server in a stream upstream server group
1669
      description: Modifies settings of a particular server
1670
        in a stream upstream server group.
1671
        Server parameters are specified in the JSON format.
1672
      operationId: patchStreamUpstreamServer
1673
      produces:
1674
        - application/json
1675
      parameters:
1676
        - in: body
1677
          name: patchStreamUpstreamServer
1678
          description: Server parameters, specified in the JSON format.
1679
            The “*ID*”, “*backup*”, and “*service*” parameters
1680
            cannot be changed.
1681
          required: true
1682
          schema:
1683
            $ref: '#/definitions/NginxStreamUpstreamConfServer'
1684
      responses:
1685
        '200':
1686
          description: Success
1687
          schema:
1688
            $ref: '#/definitions/NginxStreamUpstreamConfServer'
1689
        '400':
1690
          description: |
1691
            Upstream is static (*UpstreamStatic*),
1692
            invalid “**parameter**” value (*UpstreamConfFormatError*),
1693
            unknown parameter “**name**” (*UpstreamConfFormatError*),
1694
            nested object or list (*UpstreamConfFormatError*),
1695
            “*error*” while parsing (*UpstreamBadAddress*),
1696
            invalid “*server*” argument (*UpstreamBadAddress*),
1697
            no port in server “*host*” (*UpstreamBadAddress*),
1698
            invalid server ID (*UpstreamBadServerId*),
1699
            invalid “*weight*” (*UpstreamBadWeight*),
1700
            invalid “*max_conns*” (*UpstreamBadMaxConns*),
1701
            invalid “*max_fails*” (*UpstreamBadMaxFails*),
1702
            invalid “*fail_timeout*” (*UpstreamBadFailTimeout*),
1703
            invalid “*slow_start*” (*UpstreamBadSlowStart*),
1704
            reading request body failed *BodyReadError*),
1705
            “*service*” is empty (*UpstreamBadService*),
1706
            server “**ID**” address is immutable (*UpstreamServerImmutable*),
1707
            server “**ID**” weight is immutable (*UpstreamServerWeightImmutable*),
1708
            upstream “*name*” memory exhausted (*UpstreamOutOfMemory*)
1709
          schema:
1710
            $ref: '#/definitions/NginxError'
1711
        '404':
1712
          description: |
1713
            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1714
            unknown version (*UnknownVersion*),
1715
            upstream not found (*UpstreamNotFound*)
1716
          schema:
1717
            $ref: '#/definitions/NginxError'
1718
        '405':
1719
          description: Method disabled (*MethodDisabled*)
1720
          schema:
1721
            $ref: '#/definitions/NginxError'
1722
        '415':
1723
          description: JSON error (*JsonError*)
1724
          schema:
1725
            $ref: '#/definitions/NginxError'
1726
    delete:
1727
      tags:
1728
        - Stream Upstreams
1729
        - Method DELETE
1730
      summary: Remove a server from a stream upstream server group
1731
      description: Removes a server from a stream server group.
1732
      operationId: deleteStreamUpstreamServer
1733
      produces:
1734
        - application/json
1735
      responses:
1736
        '200':
1737
          description: Success
1738
          schema:
1739
            $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
1740
        '400':
1741
          description: |
1742
            Upstream is static (*UpstreamStatic*),
1743
            invalid server ID (*UpstreamBadServerId*),
1744
            server “**id**” not removable (*UpstreamServerImmutable*)
1745
          schema:
1746
            $ref: '#/definitions/NginxError'
1747
        '404':
1748
          description: |
1749
            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1750
            unknown version (*UnknownVersion*),
1751
            upstream not found (*UpstreamNotFound*)
1752
          schema:
1753
            $ref: '#/definitions/NginxError'
1754
        '405':
1755
          description: Method disabled (*MethodDisabled*)
1756
          schema:
1757
            $ref: '#/definitions/NginxError'
1758
  /stream/keyvals/:
1759
    get:
1760
      tags:
1761
        - Stream Keyvals
1762
        - Method GET
1763
      summary: Return key-value pairs from all stream keyval zones
1764
      description: Returns key-value pairs for each stream keyval shared memory
1765
        [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone).
1766
      operationId: getStreamKeyvalZones
1767
      produces:
1768
        - application/json
1769
      parameters:
1770
        - name: fields
1771
          in: query
1772
          type: string
1773
          description: If the “<literal>fields</literal>” value is empty,
1774
            then only stream keyval zone names will be output.
1775
      responses:
1776
        '200':
1777
          description: Success
1778
          schema:
1779
            $ref: '#/definitions/NginxStreamKeyvalZonesMap'
1780
        '404':
1781
          description: Unknown version (*UnknownVersion*)
1782
          schema:
1783
            $ref: '#/definitions/NginxError'
1784
  '/stream/keyvals/{streamKeyvalZoneName}':
1785
    parameters:
1786
      - name: streamKeyvalZoneName
1787
        in: path
1788
        description: The name of a stream keyval shared memory zone.
1789
        required: true
1790
        type: string
1791
    get:
1792
      tags:
1793
        - Stream Keyvals
1794
        - Method GET
1795
      summary: Return key-value pairs from a stream keyval zone
1796
      description: Returns key-value pairs stored in a particular stream keyval shared memory
1797
        [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone).
1798
      operationId: getStreamKeyvalZoneKeysValues
1799
      produces:
1800
        - application/json
1801
      parameters:
1802
        - name: key
1803
          in: query
1804
          type: string
1805
          description: Get a particular key-value pair from the stream keyval zone.
1806
      responses:
1807
        '200':
1808
          description: Success
1809
          schema:
1810
            $ref: '#/definitions/NginxStreamKeyvalZone'
1811
        '404':
1812
          description: |
1813
            Keyval not found (*KeyvalNotFound*),
1814
            keyval key not found (*KeyvalKeyNotFound*),
1815
            unknown version (*UnknownVersion*)
1816
          schema:
1817
            $ref: '#/definitions/NginxError'
1818
    post:
1819
      tags:
1820
        - Stream Keyvals
1821
        - Method POST
1822
      summary: Add a key-value pair to the stream keyval zone
1823
      description: Adds a new key-value pair to the stream keyval shared memory
1824
        [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone).
1825
        Several key-value pairs can be entered
1826
        if the stream keyval shared memory zone is empty.
1827
      operationId: postStreamKeyvalZoneData
1828
      produces:
1829
        - application/json
1830
      parameters:
1831
        - in: body
1832
          name: Key-value
1833
          description: A key-value pair is specified in the JSON format.
1834
            Several key-value pairs can be entered
1835
            if the stream keyval shared memory zone is empty.
1836
            Expiration time in milliseconds can be specified for a key-value pair
1837
            with the *expire* parameter
1838
            which overrides the [*timeout*](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout)
1839
            parameter of the
1840
            <a href="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</a>
1841
            directive.
1842
          required: true
1843
          schema:
1844
            $ref: '#/definitions/NginxStreamKeyvalZonePostPatch'
1845
      responses:
1846
        '201':
1847
          description: Created
1848
        '400':
1849
          description: |
1850
            Invalid JSON (*KeyvalFormatError*),
1851
            invalid key format (*KeyvalFormatError*),
1852
            key required (*KeyvalFormatError*),
1853
            keyval timeout is not enabled (*KeyvalFormatError*),
1854
            only one key can be added (*KeyvalFormatError*),
1855
            reading request body failed *BodyReadError*)
1856
          schema:
1857
            $ref: '#/definitions/NginxError'
1858
        '404':
1859
          description: |
1860
            Keyval not found (*KeyvalNotFound*),
1861
            unknown version (*UnknownVersion*)
1862
          schema:
1863
            $ref: '#/definitions/NginxError'
1864
        '405':
1865
          description: Method disabled (*MethodDisabled*)
1866
          schema:
1867
            $ref: '#/definitions/NginxError'
1868
        '409':
1869
          description: |
1870
            Entry exists (*EntryExists*),
1871
            key already exists (*KeyvalKeyExists*)
1872
          schema:
1873
            $ref: '#/definitions/NginxError'
1874
        '413':
1875
          description: Request Entity Too Large
1876
          schema:
1877
            $ref: '#/definitions/NginxError'
1878
        '415':
1879
          description: JSON error (*JsonError*)
1880
          schema:
1881
            $ref: '#/definitions/NginxError'
1882
    patch:
1883
      tags:
1884
        - Stream Keyvals
1885
        - Method PATCH
1886
      summary: Modify a key-value or delete a key
1887
      description: Changes the value of the selected key in the key-value pair,
1888
        deletes a key by setting the key value to <literal>null</literal>,
1889
        changes expiration time of a key-value pair.
1890
        If
1891
        <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>
1892
        of keyval zones in a cluster is enabled,
1893
        deletes a key only on a target cluster node.
1894
        Expiration time is specified in milliseconds
1895
        with the *expire* parameter
1896
        which overrides the [*timeout*](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout)
1897
        parameter of the
1898
        <a href="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</a>
1899
        directive.
1900
      operationId: patchStreamKeyvalZoneKeyValue
1901
      produces:
1902
        - application/json
1903
      parameters:
1904
        - in: body
1905
          name: streamKeyvalZoneKeyValue
1906
          description: A new value for the key is specified in the JSON format.
1907
          required: true
1908
          schema:
1909
            $ref: '#/definitions/NginxStreamKeyvalZonePostPatch'
1910
      responses:
1911
        '204':
1912
          description: Success
1913
        '400':
1914
          description: |
1915
            Invalid JSON (*KeyvalFormatError*),
1916
            key required (*KeyvalFormatError*),
1917
            keyval timeout is not enabled (*KeyvalFormatError*),
1918
            only one key can be updated (*KeyvalFormatError*),
1919
            reading request body failed *BodyReadError*)
1920
          schema:
1921
            $ref: '#/definitions/NginxError'
1922
        '404':
1923
          description: |
1924
            Keyval not found (*KeyvalNotFound*),
1925
            keyval key not found (*KeyvalKeyNotFound*),
1926
            unknown version (*UnknownVersion*)
1927
          schema:
1928
            $ref: '#/definitions/NginxError'
1929
        '405':
1930
          description: Method disabled (*MethodDisabled*)
1931
          schema:
1932
            $ref: '#/definitions/NginxError'
1933
        '413':
1934
          description: Request Entity Too Large
1935
          schema:
1936
            $ref: '#/definitions/NginxError'
1937
        '415':
1938
          description: JSON error (*JsonError*)
1939
          schema:
1940
            $ref: '#/definitions/NginxError'
1941
    delete:
1942
      tags:
1943
        - Stream Keyvals
1944
        - Method DELETE
1945
      summary: Empty the stream keyval zone
1946
      description: Deletes all key-value pairs from the stream keyval shared memory
1947
        [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone).
1948
        If
1949
        <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>
1950
        of keyval zones in a cluster is enabled,
1951
        empties the keyval zone only on a target cluster node.
1952
      operationId: deleteStreamKeyvalZoneData
1953
      responses:
1954
        '204':
1955
          description: Success
1956
        '404':
1957
          description: |
1958
            Keyval not found (*KeyvalNotFound*),
1959
            unknown version (*UnknownVersion*)
1960
          schema:
1961
            $ref: '#/definitions/NginxError'
1962
        '405':
1963
          description: Method disabled (*MethodDisabled*)
1964
          schema:
1965
            $ref: '#/definitions/NginxError'
1966
  /stream/zone_sync/:
1967
    get:
1968
      tags:
1969
        - Stream Zone Sync
1970
        - Method GET
1971
      summary: Return sync status of a node
1972
      description: Returns synchronization status of a cluster node.
1973
      operationId: getStreamZoneSync
1974
      produces:
1975
        - application/json
1976
      responses:
1977
        '200':
1978
          description: Success
1979
          schema:
1980
            $ref: '#/definitions/NginxStreamZoneSync'
1981
        '404':
1982
          description: Unknown version (*UnknownVersion*)
1983
          schema:
1984
            $ref: '#/definitions/NginxError'
1985
  /resolvers/:
1986
    get:
1987
      tags:
1988
        - Resolvers
1989
        - Method GET
1990
      summary: Return status for all resolver zones
1991
      description: Returns status information for each
1992
        [resolver zone](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone).
1993
      operationId: getResolverZones
1994
      produces:
1995
        - application/json
1996
      responses:
1997
        '200':
1998
          description: Success
1999
          schema:
2000
            $ref: '#/definitions/NginxResolverZonesMap'
2001
        '404':
2002
          description: Unknown version (*UnknownVersion*)
2003
          schema:
2004
            $ref: '#/definitions/NginxError'
2005
      parameters:
2006
        - in: query
2007
          name: fields
2008
          type: string
2009
          description: Limits which fields of resolvers statistics will be output.
2010
  '/resolvers/{resolverZoneName}':
2011
    parameters:
2012
      - name: resolverZoneName
2013
        in: path
2014
        description: The name of a resolver zone.
2015
        required: true
2016
        type: string
2017
    get:
2018
      tags:
2019
        - Resolvers
2020
        - Method GET
2021
      summary: Return statistics of a resolver zone
2022
      description: Returns statistics stored in a particular resolver
2023
        [zone](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone).
2024
      operationId: getResolverZone
2025
      produces:
2026
        - application/json
2027
      parameters:
2028
        - name: fields
2029
          in: query
2030
          type: string
2031
          description: Limits which fields of the resolver zone will be output
2032
            (requests, responses, or both).
2033
      responses:
2034
        '200':
2035
          description: Success
2036
          schema:
2037
            $ref: '#/definitions/NginxResolverZone'
2038
        '404':
2039
          description: |
2040
            Resolver zone not found (*ResolverZoneNotFound*),
2041
            unknown version (*UnknownVersion*)
2042
          schema:
2043
            $ref: '#/definitions/NginxError'
2044
    delete:
2045
      tags:
2046
        - Resolvers
2047
        - Method DELETE
2048
      summary: Reset statistics for a resolver zone.
2049
      description: Resets statistics in a particular resolver zone.
2050
      operationId: deleteResolverZoneStat
2051
      responses:
2052
        '204':
2053
          description: Success
2054
        '404':
2055
          description: |
2056
            Resolver zone not found (*ResolverZoneNotFound*),
2057
            unknown version (*UnknownVersion*)
2058
          schema:
2059
            $ref: '#/definitions/NginxError'
2060
        '405':
2061
          description: Method disabled (*MethodDisabled*)
2062
          schema:
2063
            $ref: '#/definitions/NginxError'
2064
  /ssl:
2065
    get:
2066
      tags:
2067
        - SSL
2068
        - Method GET
2069
      summary: Return SSL statistics
2070
      description: Returns SSL statistics.
2071
      operationId: getSsl
2072
      produces:
2073
        - application/json
2074
      responses:
2075
        '200':
2076
          description: Success
2077
          schema:
2078
            $ref: '#/definitions/NginxSSLObject'
2079
        '404':
2080
          description: Unknown version (*UnknownVersion*)
2081
          schema:
2082
            $ref: '#/definitions/NginxError'
2083
      parameters:
2084
        - in: query
2085
          name: fields
2086
          type: string
2087
          description: Limits which fields of SSL statistics will be output.
2088
    delete:
2089
      tags:
2090
        - SSL
2091
        - Method DELETE
2092
      summary: Reset SSL statistics
2093
      description: Resets counters of SSL handshakes and session reuses.
2094
      operationId: deleteSslStat
2095
      responses:
2096
        '204':
2097
          description: Success
2098
        '404':
2099
          description: Unknown version (*UnknownVersion*)
2100
          schema:
2101
            $ref: '#/definitions/NginxError'
2102
        '405':
2103
          description: Method disabled (*MethodDisabled*)
2104
          schema:
2105
            $ref: '#/definitions/NginxError'
2106
  /license:
2107
    get:
2108
      tags:
2109
        - License
2110
        - Method GET
2111
      summary: Return license info
2112
      operationId: getLicense
2113
      produces:
2114
        - application/json
2115
      responses:
2116
        '200':
2117
          description: Success
2118
          schema:
2119
            $ref: '#/definitions/NginxLicenseObject'
2120
        '404':
2121
          description: Unknown version (*UnknownVersion*)
2122
          schema:
2123
            $ref: '#/definitions/NginxError'
2124
  /workers/:
2125
    get:
2126
      tags:
2127
        - Workers
2128
        - Method GET
2129
      summary:  Return statistics for all worker processes
2130
      description: Returns statistics for all worker processes such as accepted, dropped, active, idle connections, total and current requests.
2131
      operationId: getWorkers
2132
      produces:
2133
        - application/json
2134
      parameters:
2135
        - in: query
2136
          name: fields
2137
          type: string
2138
          description: Limits which fields of worker process statistics will be output.
2139
      responses:
2140
        '200':
2141
          description: Success
2142
          schema:
2143
            $ref: '#/definitions/NginxWorkersMap'
2144
        '404':
2145
          description: |
2146
            Worker not found (*WorkerNotFound*),
2147
            unknown version (*UnknownVersion*)
2148
          schema:
2149
            $ref: '#/definitions/NginxError'
2150
    delete:
2151
      tags:
2152
        - Workers
2153
        - Method DELETE
2154
      summary: Reset statistics for all worker processes.
2155
      description: |
2156
        Resets statistics for all worker processes such as
2157
        accepted, dropped, active, idle connections, total and current requests.
2158
      operationId: deleteWorkersStat
2159
      produces:
2160
        - application/json
2161
      responses:
2162
        '204':
2163
          description: Success
2164
        '404':
2165
          description: |
2166
            Worker not found (*WorkerNotFound*),
2167
            unknown version (*UnknownVersion*)
2168
          schema:
2169
            $ref: '#/definitions/NginxError'
2170
        '405':
2171
          description: Method disabled (*MethodDisabled*)
2172
          schema:
2173
            $ref: '#/definitions/NginxError'
2174
  '/workers/{workerId}':
2175
    parameters:
2176
      - name: workerId
2177
        in: path
2178
        description: The ID of the worker process.
2179
        required: true
2180
        type: string
2181
    get:
2182
      tags:
2183
        - Workers
2184
        - Method GET
2185
      summary: Return status of a worker process
2186
      description: Returns status of a particular worker process.
2187
      operationId: getWorker
2188
      produces:
2189
        - application/json
2190
      parameters:
2191
        - in: query
2192
          name: fields
2193
          type: string
2194
          description: Limits which fields of worker process statistics will be output.
2195
      responses:
2196
        '200':
2197
          description: Success
2198
          schema:
2199
            $ref: '#/definitions/NginxWorker'
2200
        '404':
2201
          description: |
2202
            Worker not found (*WorkerNotFound*),
2203
            unknown version (*UnknownVersion*)
2204
          schema:
2205
            $ref: '#/definitions/NginxError'
2206
    delete:
2207
      tags:
2208
        - Workers
2209
        - Method DELETE
2210
      summary: Reset statistics for a worker process.
2211
      description: |
2212
        Resets statistics of accepted, dropped, active, idle connections,
2213
        as well as total and current requests.
2214
      operationId: deleteWorkerStat
2215
      produces:
2216
        - application/json
2217
      responses:
2218
        '204':
2219
          description: Success
2220
        '404':
2221
          description: |
2222
            Worker not found (*WorkerNotFound*),
2223
            unknown version (*UnknownVersion*)
2224
          schema:
2225
            $ref: '#/definitions/NginxError'
2226
        '405':
2227
          description: Method disabled (*MethodDisabled*)
2228
          schema:
2229
            $ref: '#/definitions/NginxError'
2230
###
2231
###DEFINITIONS
2232
###
2233
definitions:
2234
  ArrayOfStrings:
2235
    title: Array
2236
    description: |
2237
      An array of strings.
2238
    type: array
2239
    items:
2240
      type: string
2241
  NginxObject:
2242
    title: nginx
2243
    description: |
2244
      General information about nginx:
2245
    type: object
2246
    properties:
2247
      version:
2248
        type: string
2249
        description: Version of nginx.
2250
      build:
2251
        type: string
2252
        description: Name of nginx build.
2253
      address:
2254
        type: string
2255
        description: The address of the server that accepted status request.
2256
      generation:
2257
        type: integer
2258
        description: The total number of configuration
2259
          <a href="https://nginx.org/en/docs/control.html#reconfiguration">reloads</a>.
2260
      load_timestamp:
2261
        type: string
2262
        format: date-time
2263
        description: Time of the last reload of configuration,
2264
          in the ISO 8601 format with millisecond resolution.
2265
      timestamp:
2266
        type: string
2267
        format: date-time
2268
        description: Current time
2269
          in the ISO 8601 format with millisecond resolution.
2270
      pid:
2271
        type: integer
2272
        description: The ID of the worker process that handled status request.
2273
      ppid:
2274
        type: integer
2275
        description: The ID of the master process that started the
2276
          <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>.
2277
    example:
2278
      nginx:
2279
        version: 1.21.6
2280
        build: nginx-plus-r27
2281
        address: 206.251.255.64
2282
        generation: 6
2283
        load_timestamp: 2022-06-28T11:15:44.467Z
2284
        timestamp: 2022-06-28T09:26:07.305Z
2285
        pid: 32212
2286
        ppid: 32210
2287
  NginxProcesses:
2288
    title: Processes
2289
    type: object
2290
    properties:
2291
      respawned:
2292
        type: integer
2293
        description: The total number of abnormally terminated
2294
          and respawned child processes.
2295
    example:
2296
      respawned: 0
2297
  NginxConnections:
2298
    title: Connections
2299
    description: |
2300
      The number of accepted, dropped, active, and idle connections.
2301
    type: object
2302
    properties:
2303
      accepted:
2304
        type: integer
2305
        description: The total number of accepted client connections.
2306
      dropped:
2307
        type: integer
2308
        description: The total number of dropped client connections.
2309
      active:
2310
        type: integer
2311
        description: The current number of active client connections.
2312
      idle:
2313
        type: integer
2314
        description: The current number of idle client connections.
2315
    example:
2316
      accepted: 4968119
2317
      dropped: 0
2318
      active: 5
2319
      idle: 117
2320
  NginxSSLObject:
2321
    title: SSL
2322
    type: object
2323
    properties:
2324
      handshakes:
2325
        type: integer
2326
        description: The total number of successful SSL handshakes.
2327
      handshakes_failed:
2328
        type: integer
2329
        description: The total number of failed SSL handshakes.
2330
      session_reuses:
2331
        type: integer
2332
        description: The total number of session reuses during SSL handshake.
2333
      no_common_protocol:
2334
        type: integer
2335
        description: The number of SSL handshakes failed
2336
          because of no common protocol.
2337
      no_common_cipher:
2338
        type: integer
2339
        description: The number of SSL handshakes failed
2340
          because of no shared cipher.
2341
      handshake_timeout:
2342
        type: integer
2343
        description: The number of SSL handshakes failed
2344
          because of a timeout.
2345
      peer_rejected_cert:
2346
        type: integer
2347
        description: The number of failed SSL handshakes
2348
          when nginx presented the certificate to the client
2349
          but it was rejected with a corresponding alert message.
2350
      verify_failures:
2351
        type: object
2352
        description: SSL certificate verification errors
2353
        properties:
2354
          no_cert:
2355
            type: integer
2356
            description: A client did not provide the required certificate.
2357
          expired_cert:
2358
            type: integer
2359
            description: An expired or not yet valid certificate
2360
              was presented by a client.
2361
          revoked_cert:
2362
            type: integer
2363
            description: A revoked certificate was presented by a client.
2364
          hostname_mismatch:
2365
            type: integer
2366
            description: Server's certificate doesn't match the hostname.
2367
          other:
2368
            type: integer
2369
            description: Other SSL certificate verification errors.
2370
    example:
2371
      handshakes: 79572
2372
      handshakes_failed: 21025
2373
      session_reuses: 15762
2374
      no_common_protocol: 4
2375
      no_common_cipher: 2
2376
      handshake_timeout: 0
2377
      peer_rejected_cert: 0
2378
      verify_failures:
2379
        no_cert: 0
2380
        expired_cert: 2
2381
        revoked_cert: 1
2382
        hostname_mismatch: 2
2383
        other: 1
2384
  NginxSlabZoneMap:
2385
    title: Slab Zones
2386
    description: |
2387
      Status zones that use slab allocator.
2388
    type: object
2389
    additionalProperties:
2390
      $ref: '#/definitions/NginxSlabZone'
2391
    example:
2392
      http_cache:
2393
        pages:
2394
          used: 2
2395
          free: 2452
2396
        slots:
2397
          8:
2398
            used: 0
2399
            free: 0
2400
            reqs: 0
2401
            fails: 0
2402
          16:
2403
            used: 0
2404
            free: 0
2405
            reqs: 0
2406
            fails: 0
2407
          32:
2408
            used: 1
2409
            free: 126
2410
            reqs: 1
2411
            fails: 0
2412
          64:
2413
            used: 2
2414
            free: 62
2415
            reqs: 2
2416
            fails: 0
2417
          128:
2418
            used: 0
2419
            free: 0
2420
            reqs: 0
2421
            fails: 0
2422
      dns-backends:
2423
        pages:
2424
          used: 1143
2425
          free: 2928
2426
        slots:
2427
          8:
2428
            used: 0
2429
            free: 0
2430
            reqs: 0
2431
            fails: 0
2432
          16:
2433
            used: 0
2434
            free: 0
2435
            reqs: 0
2436
            fails: 0
2437
          32:
2438
            used: 0
2439
            free: 0
2440
            reqs: 0
2441
            fails: 0
2442
          64:
2443
            used: 1
2444
            free: 63
2445
            reqs: 1
2446
            fails: 0
2447
          128:
2448
            used: 0
2449
            free: 0
2450
            reqs: 0
2451
            fails: 0
2452
          256:
2453
            used: 18078
2454
            free: 178
2455
            reqs: 1635736
2456
            fails: 0
2457
  NginxSlabZone:
2458
    title: Shared memory zone with slab allocator
2459
    description: |
2460
      Shared memory zone with slab allocator
2461
    type: object
2462
    properties:
2463
      pages:
2464
        type: object
2465
        description: The number of free and used memory pages.
2466
        properties:
2467
          used:
2468
            type: integer
2469
            description: The current number of used memory pages.
2470
          free:
2471
            type: integer
2472
            description: The current number of free memory pages.
2473
      slots:
2474
        type: object
2475
        title: Memory Slots
2476
        description: Status data for memory slots (8, 16, 32, 64, 128, etc.)
2477
        additionalProperties:
2478
          $ref: '#/definitions/NginxSlabZoneSlot'
2479
    example:
2480
      pages:
2481
        used: 1143
2482
        free: 2928
2483
      slots:
2484
        8:
2485
          used: 0
2486
          free: 0
2487
          reqs: 0
2488
          fails: 0
2489
        16:
2490
          used: 0
2491
          free: 0
2492
          reqs: 0
2493
          fails: 0
2494
        32:
2495
          used: 0
2496
          free: 0
2497
          reqs: 0
2498
          fails: 0
2499
        64:
2500
          used: 1
2501
          free: 63
2502
          reqs: 1
2503
          fails: 0
2504
        128:
2505
          used: 0
2506
          free: 0
2507
          reqs: 0
2508
          fails: 0
2509
        256:
2510
          used: 18078
2511
          free: 178
2512
          reqs: 1635736
2513
          fails: 0
2514
  NginxSlabZoneSlot:
2515
    title: Memory Slot
2516
    type: object
2517
    properties:
2518
      used:
2519
        type: integer
2520
        description: The current number of used memory slots.
2521
      free:
2522
        type: integer
2523
        description: The current number of free memory slots.
2524
      reqs:
2525
        type: integer
2526
        description: The total number of attempts
2527
          to allocate memory of specified size.
2528
      fails:
2529
        type: integer
2530
        description: The number of unsuccessful attempts
2531
          to allocate memory of specified size.
2532
  NginxHTTPRequests:
2533
    title: HTTP Requests
2534
    type: object
2535
    properties:
2536
      total:
2537
        type: integer
2538
        description: The total number of client requests.
2539
      current:
2540
        type: integer
2541
        description: The current number of client requests.
2542
    example:
2543
      total: 10624511
2544
      current: 4
2545
  NginxHTTPServerZonesMap:
2546
    title: HTTP Server Zones
2547
    description: |
2548
      Status data for all HTTP
2549
      <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">status zones</a>.
2550
    type: object
2551
    additionalProperties:
2552
      $ref: '#/definitions/NginxHTTPServerZone'
2553
    example:
2554
      site1:
2555
        processing: 2
2556
        requests: 736395
2557
        responses:
2558
          1xx: 0
2559
          2xx: 727290
2560
          3xx: 4614
2561
          4xx: 934
2562
          5xx: 1535
2563
          codes:
2564
            200: 727270
2565
            301: 4614
2566
            404: 930
2567
            503: 1535
2568
          total: 734373
2569
        discarded: 2020
2570
        received: 180157219
2571
        sent: 20183175459
2572
        ssl:
2573
          handshakes: 65432
2574
          handshakes_failed: 421
2575
          session_reuses: 4645
2576
          no_common_protocol: 4
2577
          no_common_cipher: 2
2578
          handshake_timeout: 0
2579
          peer_rejected_cert: 0
2580
          verify_failures:
2581
            no_cert: 0
2582
            expired_cert: 2
2583
            revoked_cert: 1
2584
            hostname_mismatch: 2
2585
            other: 1
2586
      site2:
2587
        processing: 1
2588
        requests: 185307
2589
        responses:
2590
          1xx: 0
2591
          2xx: 112674
2592
          3xx: 45383
2593
          4xx: 2504
2594
          5xx: 4419
2595
          codes:
2596
            200: 112674
2597
            301: 45383
2598
            404: 2504
2599
            503: 4419
2600
          total: 164980
2601
        discarded: 20326
2602
        received: 51575327
2603
        sent: 2983241510
2604
        ssl:
2605
          handshakes: 104303
2606
          handshakes_failed: 1421
2607
          session_reuses: 54645
2608
          no_common_protocol: 4
2609
          no_common_cipher: 2
2610
          handshake_timeout: 0
2611
          peer_rejected_cert: 0
2612
          verify_failures:
2613
            no_cert: 0
2614
            expired_cert: 2
2615
            revoked_cert: 1
2616
            hostname_mismatch: 2
2617
            other: 1
2618
  NginxHTTPServerZone:
2619
    title: HTTP Server Zone
2620
    type: object
2621
    properties:
2622
      processing:
2623
        type: integer
2624
        description: The number of client requests
2625
          that are currently being processed.
2626
      requests:
2627
        type: integer
2628
        description: The total number of client requests received from clients.
2629
      responses:
2630
        description: The total number of responses sent to clients, the
2631
          number of responses with status codes
2632
          “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”,
2633
          “<code>4xx</code>”, and “<code>5xx</code>”, and
2634
          the number of responses per each status code.
2635
        type: object
2636
        readOnly: true
2637
        properties:
2638
          1xx:
2639
            type: integer
2640
            description: The number of responses with “<code>1xx</code>” status codes.
2641
            readOnly: true
2642
          2xx:
2643
            type: integer
2644
            description: The number of responses with “<code>2xx</code>” status codes.
2645
            readOnly: true
2646
          3xx:
2647
           type: integer
2648
           description: The number of responses with “<code>3xx</code>” status codes.
2649
           readOnly: true
2650
          4xx:
2651
            type: integer
2652
            description: The number of responses with “<code>4xx</code>” status codes.
2653
            readOnly: true
2654
          5xx:
2655
            type: integer
2656
            description: The number of responses with “<code>5xx</code>” status codes.
2657
            readOnly: true
2658
          codes:
2659
            type: object
2660
            description: The number of responses per each status code.
2661
            readOnly: true
2662
            properties:
2663
              codeNumber:
2664
                type: integer
2665
                description: The number of responses with this particular status code.
2666
                readOnly: true
2667
          total:
2668
            type: integer
2669
            description: The total number of responses sent to clients.
2670
            readOnly: true
2671
      discarded:
2672
        type: integer
2673
        description: The total number of
2674
          requests completed without sending a response.
2675
      received:
2676
        type: integer
2677
        description: The total number of bytes received from clients.
2678
      sent:
2679
        type: integer
2680
        description: The total number of bytes sent to clients.
2681
      ssl:
2682
        type: object
2683
        readOnly: true
2684
        properties:
2685
          handshakes:
2686
            type: integer
2687
            description: The total number of successful SSL handshakes.
2688
            readOnly: true
2689
          handshakes_failed:
2690
            type: integer
2691
            description: The total number of failed SSL handshakes.
2692
            readOnly: true
2693
          session_reuses:
2694
            type: integer
2695
            description: The total number of session reuses during SSL handshake.
2696
            readOnly: true
2697
          no_common_protocol:
2698
            type: integer
2699
            description: The number of SSL handshakes failed
2700
              because of no common protocol.
2701
          no_common_cipher:
2702
            type: integer
2703
            description: The number of SSL handshakes failed
2704
              because of no shared cipher.
2705
          handshake_timeout:
2706
            type: integer
2707
            description: The number of SSL handshakes failed
2708
              because of a timeout.
2709
          peer_rejected_cert:
2710
            type: integer
2711
            description: The number of failed SSL handshakes
2712
              when nginx presented the certificate to the client
2713
              but it was rejected with a corresponding alert message.
2714
          verify_failures:
2715
            type: object
2716
            description: SSL certificate verification errors
2717
            properties:
2718
              no_cert:
2719
                type: integer
2720
                description: A client did not provide the required certificate.
2721
              expired_cert:
2722
                type: integer
2723
                description: An expired or not yet valid certificate
2724
                  was presented by a client.
2725
              revoked_cert:
2726
                type: integer
2727
                description: A revoked certificate was presented by a client.
2728
              other:
2729
                type: integer
2730
                description: Other SSL certificate verification errors.
2731
    example:
2732
      processing: 1
2733
      requests: 706690
2734
      responses:
2735
        1xx: 0
2736
        2xx: 699482
2737
        3xx: 4522
2738
        4xx: 907
2739
        5xx: 266
2740
        codes:
2741
          200: 699482
2742
          301: 4522
2743
          404: 907
2744
          503: 266
2745
        total: 705177
2746
      discarded: 1513
2747
      received: 172711587
2748
      sent: 19415530115
2749
      ssl:
2750
        handshakes: 104303
2751
        handshakes_failed: 1421
2752
        session_reuses: 54645
2753
        no_common_protocol: 4
2754
        no_common_cipher: 2
2755
        handshake_timeout: 0
2756
        peer_rejected_cert: 0
2757
        verify_failures:
2758
          no_cert: 0
2759
          expired_cert: 2
2760
          revoked_cert: 1
2761
          other: 1
2762
  NginxHTTPLocationZonesMap:
2763
    title: HTTP Location Zones
2764
    description: |
2765
      Status data for all HTTP
2766
      <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">location zones</a>.
2767
    type: object
2768
    additionalProperties:
2769
      $ref: '#/definitions/NginxHTTPLocationZone'
2770
    example:
2771
      site1:
2772
        requests: 736395
2773
        responses:
2774
          1xx: 0
2775
          2xx: 727290
2776
          3xx: 4614
2777
          4xx: 934
2778
          5xx: 1535
2779
          codes:
2780
            200: 727290
2781
            301: 4614
2782
            404: 934
2783
            503: 1535
2784
          total: 734373
2785
        discarded: 2020
2786
        received: 180157219
2787
        sent: 20183175459
2788
      site2:
2789
        requests: 185307
2790
        responses:
2791
          1xx: 0
2792
          2xx: 112674
2793
          3xx: 45383
2794
          4xx: 2504
2795
          5xx: 4419
2796
          codes:
2797
            200: 112674
2798
            301: 45383
2799
            404: 2504
2800
            503: 4419
2801
          total: 164980
2802
        discarded: 20326
2803
        received: 51575327
2804
        sent: 2983241510
2805
  NginxHTTPLocationZone:
2806
    title: HTTP Location Zone
2807
    type: object
2808
    properties:
2809
      requests:
2810
        type: integer
2811
        description: The total number of client requests received from clients.
2812
      responses:
2813
        description: The total number of responses sent to clients, the
2814
          number of responses with status codes
2815
          “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”,
2816
          “<code>4xx</code>”, and “<code>5xx</code>”, and
2817
          the number of responses per each status code.
2818
        type: object
2819
        readOnly: true
2820
        properties:
2821
          1xx:
2822
            type: integer
2823
            description: The number of responses with “<code>1xx</code>” status codes.
2824
            readOnly: true
2825
          2xx:
2826
            type: integer
2827
            description: The number of responses with “<code>2xx</code>” status codes.
2828
            readOnly: true
2829
          3xx:
2830
           type: integer
2831
           description: The number of responses with “<code>3xx</code>” status codes.
2832
           readOnly: true
2833
          4xx:
2834
            type: integer
2835
            description: The number of responses with “<code>4xx</code>” status codes.
2836
            readOnly: true
2837
          5xx:
2838
            type: integer
2839
            description: The number of responses with “<code>5xx</code>” status codes.
2840
            readOnly: true
2841
          codes:
2842
            type: object
2843
            description: The number of responses per each status code.
2844
            readOnly: true
2845
            properties:
2846
              codeNumber:
2847
                type: integer
2848
                description: The number of responses with this particular status code.
2849
                readOnly: true
2850
          total:
2851
            type: integer
2852
            description: The total number of responses sent to clients.
2853
            readOnly: true
2854
      discarded:
2855
        type: integer
2856
        description: The total number of
2857
          requests completed without sending a response.
2858
      received:
2859
        type: integer
2860
        description: The total number of bytes received from clients.
2861
      sent:
2862
        type: integer
2863
        description: The total number of bytes sent to clients.
2864
    example:
2865
      requests: 706690
2866
      responses: 
2867
        1xx: 0
2868
        2xx: 699482
2869
        3xx: 4522
2870
        4xx: 907
2871
        5xx: 266
2872
        codes:
2873
          200: 112674
2874
          301: 4522
2875
          404: 2504
2876
          503: 266
2877
        total: 705177
2878
      discarded: 1513
2879
      received: 172711587
2880
      sent: 19415530115
2881
  NginxHTTPCachesMap:
2882
    title: HTTP Caches
2883
    description: |
2884
      Status information of all HTTP caches configured by 
2885
      <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path">proxy_cache_path</a>
2886
      and other “<code>*_cache_path</code>” directives.
2887
    type: object
2888
    additionalProperties:
2889
      $ref: '#/definitions/NginxHTTPCache'
2890
    example:
2891
      http-cache:
2892
        size: 530915328
2893
        max_size: 536870912
2894
        cold: false
2895
        hit:
2896
          responses: 254032
2897
          bytes: 6685627875
2898
        stale:
2899
          responses: 0
2900
          bytes: 0
2901
        updating:
2902
          responses: 0
2903
          bytes: 0
2904
        revalidated:
2905
          responses: 0
2906
          bytes: 0
2907
        miss:
2908
          responses: 1619201
2909
          bytes: 53841943822
2910
        expired:
2911
          responses: 45859
2912
          bytes: 1656847080
2913
          responses_written: 44992
2914
          bytes_written: 1641825173
2915
        bypass:
2916
          responses: 200187
2917
          bytes: 5510647548
2918
          responses_written: 200173
2919
          bytes_written: 44992
2920
      frontend-cache:
2921
        size: 530915328
2922
        max_size: 536870912
2923
        cold: false
2924
        hit:
2925
          responses: 254032
2926
          bytes: 6685627875
2927
        stale:
2928
          responses: 0
2929
          bytes: 0
2930
        updating:
2931
          responses: 0
2932
          bytes: 0
2933
        revalidated:
2934
          responses: 0
2935
          bytes: 0
2936
        miss:
2937
          responses: 1619201
2938
          bytes: 53841943822
2939
        expired:
2940
          responses: 45859
2941
          bytes: 1656847080
2942
          responses_written: 44992
2943
          bytes_written: 1641825173
2944
        bypass:
2945
          responses: 200187
2946
          bytes: 5510647548
2947
          responses_written: 200173
2948
          bytes_written: 44992
2949
  NginxHTTPCache:
2950
    title: HTTP Cache
2951
    type: object
2952
    properties:
2953
      size:
2954
        type: integer
2955
        description: The current size of the cache.
2956
      max_size:
2957
        type: integer
2958
        description: The limit on the maximum size of the cache
2959
          specified in the configuration.
2960
      cold:
2961
        type: boolean
2962
        description: A boolean value indicating whether the “cache loader” process
2963
          is still loading data from disk into the cache.
2964
      hit:
2965
        type: object
2966
        properties:
2967
          responses:
2968
            type: integer
2969
            description: The total number of
2970
              <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid">valid</a>
2971
               responses read from the cache.
2972
          bytes:
2973
            type: integer
2974
            description: The total number of bytes read from the cache.
2975
      stale:
2976
        type: object
2977
        properties:
2978
          responses:
2979
            type: integer
2980
            description: The total number of expired responses read from the cache (see
2981
              <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale">proxy_cache_use_stale</a>
2982
              and other “<code>*_cache_use_stale</code>” directives).
2983
          bytes:
2984
            type: integer
2985
            description: The total number of bytes read from the cache.
2986
      updating:
2987
        type: object
2988
        properties:
2989
          responses:
2990
            type: integer
2991
            description: The total number of expired responses read from the cache
2992
              while responses were being updated (see
2993
              <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale_updating">proxy_cache_use_stale</a>
2994
              and other “<code>*_cache_use_stale</code>” directives).
2995
          bytes:
2996
            type: integer
2997
            description: The total number of bytes read from the cache.
2998
      revalidated:
2999
        type: object
3000
        properties:
3001
          responses:
3002
            type: integer
3003
            description: The total number of expired and revalidated responses
3004
              read from the cache (see
3005
              <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_revalidate">proxy_cache_revalidate</a>
3006
              and other “<code>*_cache_revalidate</code>” directives.
3007
          bytes:
3008
            type: integer
3009
            description: The total number of bytes read from the cache.
3010
      miss:
3011
        type: object
3012
        properties:
3013
          responses:
3014
            type: integer
3015
            description: The total number of responses not found in the cache.
3016
          bytes:
3017
            type: integer
3018
            description: The total number of bytes read from the proxied server.
3019
          responses_written:
3020
            type: integer
3021
            description: The total number of responses written to the cache.
3022
          bytes_written:
3023
            type: integer
3024
            description: The total number of bytes written to the cache.
3025
      expired:
3026
        type: object
3027
        properties:
3028
          responses:
3029
            type: integer
3030
            description: The total number of expired responses not taken from the cache.
3031
          bytes:
3032
            type: integer
3033
            description: The total number of bytes read from the proxied server.
3034
          responses_written:
3035
            type: integer
3036
            description: The total number of responses written to the cache.
3037
          bytes_written:
3038
            type: integer
3039
            description: The total number of bytes written to the cache.
3040
      bypass:
3041
        type: object
3042
        properties:
3043
          responses:
3044
            type: integer
3045
            description: The total number of responses not looked up in the cache due to the
3046
              <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_bypass">proxy_cache_bypass</a>
3047
              and other “<code>*_cache_bypass</code>” directives.
3048
          bytes:
3049
            type: integer
3050
            description: The total number of bytes read from the proxied server.
3051
          responses_written:
3052
            type: integer
3053
            description: The total number of responses written to the cache.
3054
          bytes_written:
3055
            type: integer
3056
            description: The total number of bytes written to the cache.
3057
    example:
3058
      size: 530915328
3059
      max_size: 536870912
3060
      cold: false
3061
      hit:
3062
        responses: 254032
3063
        bytes: 6685627875
3064
      stale:
3065
        responses: 0
3066
        bytes: 0
3067
      updating:
3068
        responses: 0
3069
        bytes: 0
3070
      revalidated:
3071
        responses: 0
3072
        bytes: 0
3073
      miss:
3074
        responses: 1619201
3075
        bytes: 53841943822
3076
      expired:
3077
        responses: 45859
3078
        bytes: 1656847080
3079
        responses_written: 44992
3080
        bytes_written: 1641825173
3081
      bypass:
3082
        responses: 200187
3083
        bytes: 5510647548
3084
        responses_written: 200173
3085
        bytes_written: 44992
3086
  NginxHTTPLimitConnZonesMap:
3087
    title: HTTP limit_conns
3088
    description: |
3089
      Status data for all HTTP
3090
      <a href="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zones</a>.
3091
    type: object
3092
    additionalProperties:
3093
      $ref: '#/definitions/NginxHTTPLimitConnZone'
3094
  NginxHTTPLimitConnZone:
3095
    title: HTTP Connections Limiting
3096
    type: object
3097
    properties:
3098
      passed:
3099
        type: integer
3100
        description: The total number of connections that were neither limited
3101
          nor accounted as limited.
3102
      rejected:
3103
        type: integer
3104
        description: The total number of connections that were rejected.
3105
      rejected_dry_run:
3106
        type: integer
3107
        description: The total number of connections accounted as rejected in the
3108
          <a href="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_dry_run">dry run</a>
3109
          mode.
3110
    example:
3111
      passed: 15
3112
      rejected: 0
3113
      rejected_dry_run: 2
3114
  NginxHTTPLimitReqZonesMap:
3115
    title: HTTP limit_reqs
3116
    description: |
3117
      Status data for all HTTP
3118
      <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zones</a>.
3119
    type: object
3120
    additionalProperties:
3121
      $ref: '#/definitions/NginxHTTPLimitReqZone'
3122
  NginxHTTPLimitReqZone:
3123
    title: HTTP Requests Rate Limiting
3124
    type: object
3125
    properties:
3126
      passed:
3127
        type: integer
3128
        description: The total number of requests that were neither limited
3129
          nor accounted as limited.
3130
      delayed:
3131
        type: integer
3132
        description: The total number of requests that were delayed.
3133
      rejected:
3134
        type: integer
3135
        description: The total number of requests that were rejected.
3136
      delayed_dry_run:
3137
        type: integer
3138
        description: The total number of requests accounted as delayed in the
3139
          <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</a>
3140
          mode.
3141
      rejected_dry_run:
3142
        type: integer
3143
        description: The total number of requests accounted as rejected in the
3144
          <a href="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</a>
3145
          mode.
3146
    example:
3147
      passed: 15
3148
      delayed: 4
3149
      rejected: 0
3150
      delayed_dry_run: 1
3151
      rejected_dry_run: 2
3152
  NginxHTTPUpstreamMap:
3153
    title: HTTP Upstreams
3154
    description: |
3155
      Status information of all HTTP
3156
      <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">dynamically configurable</a>
3157
      <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream">groups</a>.
3158
    type: object
3159
    additionalProperties:
3160
      $ref: '#/definitions/NginxHTTPUpstream'
3161
    example:
3162
      trac-backend:
3163
        peers:
3164
          - id: 0
3165
            server: 10.0.0.1:8088
3166
            name: 10.0.0.1:8088
3167
            backup: false
3168
            weight: 5
3169
            state: up
3170
            active: 0
3171
            ssl:
3172
              handshakes: 620311
3173
              handshakes_failed: 3432
3174
              session_reuses: 36442
3175
              no_common_protocol: 4
3176
              handshake_timeout: 0
3177
              peer_rejected_cert: 0
3178
              verify_failures:
3179
                expired_cert: 2
3180
                revoked_cert: 1
3181
                hostname_mismatch: 2
3182
                other: 1
3183
            requests: 667231
3184
            header_time: 20
3185
            response_time: 36
3186
            response_time_hist:
3187
              count: 9817
3188
              sum: 57625
3189
              buckets:
3190
                5: 4428
3191
                10: 4755
3192
                25: 350
3193
                50: 235
3194
                75: 54
3195
                100: 47
3196
                250: 1
3197
                500: 0
3198
                750: 0
3199
                1000: 0
3200
                2500: 0
3201
                5000: 0
3202
                7500: 0
3203
                10000: 0
3204
                inf: 0
3205
            responses:
3206
              1xx: 0
3207
              2xx: 666310
3208
              3xx: 0
3209
              4xx: 915
3210
              5xx: 6
3211
              codes:
3212
                200: 666310
3213
                404: 915
3214
                503: 6
3215
              total: 667231
3216
            sent: 251946292
3217
            received: 19222475454
3218
            fails: 0
3219
            unavail: 0
3220
            health_checks:
3221
              checks: 26214
3222
              fails: 0
3223
              unhealthy: 0
3224
              last_passed: true
3225
            downtime: 0
3226
            downstart: 2022-06-28T11:09:21.602Z
3227
            selected: 2022-06-28T15:01:25Z
3228
          - id: 1
3229
            server: 10.0.0.1:8089
3230
            name: 10.0.0.1:8089
3231
            backup: true
3232
            weight: 1
3233
            state: unhealthy
3234
            active: 0
3235
            requests: 0
3236
            responses:
3237
              1xx: 0
3238
              2xx: 0
3239
              3xx: 0
3240
              4xx: 0
3241
              5xx: 0
3242
              codes: {}
3243
              total: 0
3244
            sent: 0
3245
            received: 0
3246
            fails: 0
3247
            unavail: 0
3248
            health_checks:
3249
              checks: 26284
3250
              fails: 26284
3251
              unhealthy: 1
3252
              last_passed: false
3253
            downtime: 262925617
3254
            downstart: 2022-06-28T11:09:21.602Z
3255
            selected: 2022-06-28T15:01:25Z
3256
        keepalive: 0
3257
        zombies: 0
3258
        zone: trac-backend
3259
      hg-backend:
3260
        peers:
3261
          - id: 0
3262
            server: 10.0.0.1:8088
3263
            name: 10.0.0.1:8088
3264
            backup: false
3265
            weight: 5
3266
            state: up
3267
            active: 0
3268
            ssl:
3269
              handshakes: 620311
3270
              handshakes_failed: 3432
3271
              session_reuses: 36442
3272
              no_common_protocol: 4
3273
              handshake_timeout: 0
3274
              peer_rejected_cert: 0
3275
              verify_failures:
3276
                expired_cert: 2
3277
                revoked_cert: 1
3278
                hostname_mismatch: 2
3279
                other: 1
3280
            requests: 667231
3281
            header_time: 20
3282
            response_time: 36
3283
            response_time_hist:
3284
              count: 9817
3285
              sum: 57625
3286
              buckets:
3287
                5: 4428
3288
                10: 4755
3289
                25: 350
3290
                50: 235
3291
                75: 54
3292
                100: 47
3293
                250: 1
3294
                500: 0
3295
                750: 0
3296
                1000: 0
3297
                2500: 0
3298
                5000: 0
3299
                7500: 0
3300
                10000: 0
3301
                inf: 0
3302
            responses:
3303
              1xx: 0
3304
              2xx: 666310
3305
              3xx: 0
3306
              4xx: 915
3307
              5xx: 6
3308
              codes:
3309
                200: 666310
3310
                404: 915
3311
                503: 6
3312
              total: 667231
3313
            sent: 251946292
3314
            received: 19222475454
3315
            fails: 0
3316
            unavail: 0
3317
            health_checks:
3318
              checks: 26214
3319
              fails: 0
3320
              unhealthy: 0
3321
              last_passed: true
3322
            downtime: 0
3323
            downstart: 2022-06-28T11:09:21.602Z
3324
            selected: 2022-06-28T15:01:25Z
3325
          - id: 1
3326
            server: 10.0.0.1:8089
3327
            name: 10.0.0.1:8089
3328
            backup: true
3329
            weight: 1
3330
            state: unhealthy
3331
            active: 0
3332
            requests: 0
3333
            responses:
3334
              1xx: 0
3335
              2xx: 0
3336
              3xx: 0
3337
              4xx: 0
3338
              5xx: 0
3339
              codes: {}
3340
              total: 0
3341
            sent: 0
3342
            received: 0
3343
            fails: 0
3344
            unavail: 0
3345
            health_checks:
3346
              checks: 26284
3347
              fails: 26284
3348
              unhealthy: 1
3349
              last_passed: false
3350
            downtime: 262925617
3351
            downstart: 2022-06-28T11:09:21.602Z
3352
            selected: 2022-06-28T15:01:25Z
3353
        keepalive: 0
3354
        zombies: 0
3355
        zone: hg-backend
3356
  NginxHTTPUpstream:
3357
    title: HTTP Upstream
3358
    type: object
3359
    properties:
3360
      peers:
3361
        $ref: '#/definitions/NginxHTTPUpstreamPeerMap'
3362
      keepalive:
3363
        type: integer
3364
        description: The current number of idle
3365
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive">keepalive</a>
3366
          connections.
3367
      zombies:
3368
        type: integer
3369
        description: The current number of servers removed
3370
          from the group but still processing active client requests.
3371
      zone:
3372
        type: string
3373
        description: The name of the shared memory
3374
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">zone</a>
3375
          that keeps the group’s configuration and run-time state.
3376
      queue:
3377
        type: object
3378
        description: >
3379
          For the requests
3380
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue">queue</a>,
3381
          the following data are provided:
3382
        properties:
3383
          size:
3384
            type: integer
3385
            description: The current number of requests in the queue.
3386
          max_size:
3387
            type: integer
3388
            description: The maximum number of requests that can be in the queue
3389
              at the same time.
3390
          overflows:
3391
            type: integer
3392
            description: The total number of requests rejected due to the queue overflow.
3393
    example:
3394
      upstream_backend:
3395
        peers:
3396
          - id: 0
3397
            server: 10.0.0.1:8088
3398
            name: 10.0.0.1:8088
3399
            backup: false
3400
            weight: 5
3401
            state: up
3402
            active: 0
3403
            ssl:
3404
              handshakes: 620311
3405
              handshakes_failed: 3432
3406
              session_reuses: 36442
3407
              no_common_protocol: 4
3408
              handshake_timeout: 0
3409
              peer_rejected_cert: 0
3410
              verify_failures:
3411
                expired_cert: 2
3412
                revoked_cert: 1
3413
                hostname_mismatch: 2
3414
                other: 1
3415
            max_conns: 20
3416
            requests: 667231
3417
            header_time: 20
3418
            response_time: 36
3419
            response_time_hist:
3420
              count: 9817
3421
              sum: 57625
3422
              buckets:
3423
                5: 4428
3424
                10: 4755
3425
                25: 350
3426
                50: 235
3427
                75: 54
3428
                100: 47
3429
                250: 1
3430
                500: 0
3431
                750: 0
3432
                1000: 0
3433
                2500: 0
3434
                5000: 0
3435
                7500: 0
3436
                10000: 0
3437
                inf: 0
3438
            responses:
3439
              1xx: 0
3440
              2xx: 666310
3441
              3xx: 0
3442
              4xx: 915
3443
              5xx: 6
3444
              codes:
3445
                200: 666310
3446
                404: 915
3447
                503: 6
3448
              total: 667231
3449
            sent: 251946292
3450
            received: 19222475454
3451
            fails: 0
3452
            unavail: 0
3453
            health_checks:
3454
              checks: 26214
3455
              fails: 0
3456
              unhealthy: 0
3457
              last_passed: true
3458
            downtime: 0
3459
            downstart: 2022-06-28T11:09:21.602Z
3460
            selected: 2022-06-28T15:01:25Z
3461
          - id: 1
3462
            server: 10.0.0.1:8089
3463
            name: 10.0.0.1:8089
3464
            backup: true
3465
            weight: 1
3466
            state: unhealthy
3467
            active: 0
3468
            max_conns: 20
3469
            requests: 0
3470
            responses:
3471
              1xx: 0
3472
              2xx: 0
3473
              3xx: 0
3474
              4xx: 0
3475
              5xx: 0
3476
              codes: {}
3477
              total: 0
3478
            sent: 0
3479
            received: 0
3480
            fails: 0
3481
            unavail: 0
3482
            health_checks:
3483
              checks: 26284
3484
              fails: 26284
3485
              unhealthy: 1
3486
              last_passed: false
3487
            downtime: 262925617
3488
            downstart: 2022-06-28T11:09:21.602Z
3489
            selected: 2022-06-28T15:01:25Z
3490
        keepalive: 0
3491
        zombies: 0
3492
        zone: upstream_backend
3493
  NginxHTTPUpstreamPeerMap:
3494
    title: HTTP Upstream Servers
3495
    description: |
3496
      An array of HTTP
3497
      <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream">upstream servers</a>.
3498
    type: array
3499
    items:
3500
      $ref: '#/definitions/NginxHTTPUpstreamPeer'
3501
  NginxHTTPUpstreamPeer:
3502
    title: HTTP Upstream Server
3503
    type: object
3504
    properties:
3505
      id:
3506
        type: integer
3507
        description: The ID of the server.
3508
        readOnly: true
3509
      server:
3510
        type: string
3511
        description: An  <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">address</a>
3512
          of the server.
3513
      service:
3514
        type: string
3515
        description: The
3516
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</a>
3517
          parameter value of the
3518
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>
3519
          directive.
3520
      name:
3521
        type: string
3522
        description: The name of the server specified in the
3523
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>
3524
          directive.
3525
        readOnly: true
3526
      backup:
3527
        type: boolean
3528
        description: A boolean value indicating whether the server is a
3529
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</a>
3530
          server.
3531
      weight:
3532
        type: integer
3533
        description: <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">Weight</a>
3534
          of the server.
3535
      state:
3536
        type: string
3537
        enum:
3538
          - up
3539
          - draining
3540
          - down
3541
          - unavail
3542
          - checking
3543
          - unhealthy
3544
        description: Current state, which may be one of
3545
          “<code>up</code>”, “<code>draining</code>”, “<code>down</code>”,
3546
          “<code>unavail</code>”, “<code>checking</code>”,
3547
          and “<code>unhealthy</code>”.
3548
      active:
3549
        type: integer
3550
        description: The current number of active connections.
3551
        readOnly: true
3552
      ssl:
3553
        type: object
3554
        readOnly: true
3555
        properties:
3556
          handshakes:
3557
            type: integer
3558
            description: The total number of successful SSL handshakes.
3559
            readOnly: true
3560
          handshakes_failed:
3561
            type: integer
3562
            description: The total number of failed SSL handshakes.
3563
            readOnly: true
3564
          session_reuses:
3565
            type: integer
3566
            description: The total number of session reuses during SSL handshake.
3567
            readOnly: true
3568
          no_common_protocol:
3569
            type: integer
3570
            description: The number of SSL handshakes failed
3571
              because of no common protocol.
3572
          handshake_timeout:
3573
            type: integer
3574
            description: The number of SSL handshakes failed
3575
              because of a timeout.
3576
          peer_rejected_cert:
3577
            type: integer
3578
            description: The number of failed SSL handshakes
3579
              when nginx presented the certificate to the upstream server
3580
              but it was rejected with a corresponding alert message.
3581
          verify_failures:
3582
            type: object
3583
            description: SSL certificate verification errors
3584
            properties:
3585
              expired_cert:
3586
                type: integer
3587
                description: An expired or not yet valid certificate
3588
                  was presented by an upstream server.
3589
              revoked_cert:
3590
                type: integer
3591
                description: A revoked certificate was presented by an upstream server.
3592
              hostname_mismatch:
3593
                type: integer
3594
                description: Server's certificate doesn't match the hostname.
3595
              other:
3596
                type: integer
3597
                description: Other SSL certificate verification errors.
3598
      max_conns:
3599
        type: integer
3600
        description: The
3601
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a>
3602
          limit for the server.
3603
      requests:
3604
        type: integer
3605
        description: The total number of client requests forwarded to this server.
3606
        readOnly: true
3607
      responses:
3608
        type: object
3609
        readOnly: true
3610
        properties:
3611
          1xx:
3612
            type: integer
3613
            description: The number of responses with “<code>1xx</code>” status codes.
3614
            readOnly: true
3615
          2xx:
3616
            type: integer
3617
            description: The number of responses with “<code>2xx</code>” status codes.
3618
            readOnly: true
3619
          3xx:
3620
           type: integer
3621
           description: The number of responses with “<code>3xx</code>” status codes.
3622
           readOnly: true
3623
          4xx:
3624
            type: integer
3625
            description: The number of responses with “<code>4xx</code>” status codes.
3626
            readOnly: true
3627
          5xx:
3628
            type: integer
3629
            description: The number of responses with “<code>5xx</code>” status codes.
3630
            readOnly: true
3631
          codes:
3632
            type: object
3633
            description: The number of responses per each status code.
3634
            readOnly: true
3635
            properties:
3636
              codeNumber:
3637
                type: integer
3638
                description: The number of responses with this particular status code.
3639
                readOnly: true
3640
          total:
3641
            type: integer
3642
            description: The total number of responses obtained from this server.
3643
            readOnly: true
3644
      sent:
3645
        type: integer
3646
        description: The total number of bytes sent to this server.
3647
        readOnly: true
3648
      received:
3649
        type: integer
3650
        description: The total number of bytes received from this server.
3651
        readOnly: true
3652
      fails:
3653
        type: integer
3654
        description: The total number of unsuccessful attempts
3655
          to communicate with the server.
3656
        readOnly: true
3657
      unavail:
3658
        type: integer
3659
        description: How many times the server became unavailable for client requests
3660
          (state “<code>unavail</code>”) due to the number of unsuccessful
3661
          attempts reaching the
3662
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</a>
3663
          threshold.
3664
        readOnly: true
3665
      health_checks:
3666
        type: object
3667
        readOnly: true
3668
        properties:
3669
          checks:
3670
            type: integer
3671
            description: The total number of
3672
              <a href="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#health_check">health check</a>
3673
              requests made.
3674
          fails:
3675
            type: integer
3676
            description: The number of failed health checks.
3677
          unhealthy:
3678
            type: integer
3679
            description: How many times the server became unhealthy
3680
              (state “<code>unhealthy</code>”).
3681
          last_passed:
3682
            type: boolean
3683
            description: Boolean indicating if the last health check request was successful
3684
              and passed
3685
              <a href="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#match">tests</a>.
3686
      downtime:
3687
        type: integer
3688
        readOnly: true
3689
        description: Total time the server was in the “<code>unavail</code>”,
3690
          “<code>checking</code>”, and “<code>unhealthy</code>” states.
3691
      downstart:
3692
        type: string
3693
        format: date-time
3694
        readOnly: true
3695
        description: The time when the server became
3696
          “<code>unavail</code>”, “<code>checking</code>”,
3697
          or “<code>unhealthy</code>”,
3698
          in the ISO 8601 format with millisecond resolution.
3699
      selected:
3700
        type: string
3701
        format: date-time
3702
        readOnly: true
3703
        description: The time when the server was last selected to process a request,
3704
          in the ISO 8601 format with millisecond resolution.
3705
      header_time:
3706
        type: integer
3707
        readOnly: true
3708
        description: The average time to get the
3709
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_header_time">response header</a>
3710
          from the server.
3711
      response_time:
3712
        type: integer
3713
        readOnly: true
3714
        description: The average time to get the
3715
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_response_time">full response</a>
3716
          from the server.
3717
      response_time_hist:
3718
        type: object
3719
        description: Histogram of upstream response times collected per upstream server.
3720
        readOnly: true
3721
        properties:
3722
          count:
3723
            type: integer
3724
            description: Total number of recorded responses.
3725
            readOnly: true
3726
          sum:
3727
            type: integer
3728
            description: Sum of all recorded upstream response times, in milliseconds.
3729
            readOnly: true
3730
          buckets:
3731
            title: Histogram bucket counters
3732
            description:  |
3733
              Histogram bucket counters for upstream response times, in milliseconds.
3734
              Each bucket name ("5","10","25","50", etc.) is a time limit in milliseconds.
3735
              Each bucket value is the number of responses within that time bucket.
3736
              The "inf" bucket counts responses greater than 10000 ms.
3737
            type: object
3738
            readOnly: true
3739
            properties:
3740
              "5":
3741
                type: integer
3742
                description: The total number of responses with response time less than or equal to 5 ms.
3743
              "10":
3744
                type: integer
3745
                description: The total number of responses with response time greater than 5 ms and less than or equal to 10 ms.
3746
              "25":
3747
                type: integer
3748
                description: The total number of responses with response time greater than 10 ms and less than or equal to 25 ms.
3749
              "50":
3750
                type: integer
3751
                description: The total number of responses with response time greater than 25 ms and less than or equal to 50 ms.
3752
              "75":
3753
                type: integer
3754
                description: The total number of responses with response time greater than 50 ms and less than or equal to 75 ms.
3755
              "100":
3756
                type: integer
3757
                description: The total number of responses with response time greater than 75 ms and less than or equal to 100 ms.
3758
              "250":
3759
                type: integer
3760
                description: The total number of responses with response time greater than 100 ms and less than or equal to 250 ms.
3761
              "500":
3762
                type: integer
3763
                description: The total number of responses with response time greater than 250 ms and less than or equal to 500 ms.
3764
              "750":
3765
                type: integer
3766
                description: The total number of responses with response time greater than 500 ms and less than or equal to 750 ms.
3767
              "1000":
3768
                type: integer
3769
                description: The total number of responses with response time greater than 750 ms and less than or equal to 1000 ms.
3770
              "2500":
3771
                type: integer
3772
                description: The total number of responses with response time greater than 1000 ms and less than or equal to 2500 ms.
3773
              "5000":
3774
                type: integer
3775
                description: The total number of responses with response time greater than 2500 ms and less than or equal to 5000 ms.
3776
              "7500":
3777
                type: integer
3778
                description: The total number of responses with response time greater than 5000 ms and less than or equal to 7500 ms.
3779
              "10000":
3780
                type: integer
3781
                description: The total number of responses with response time greater than 7500 ms and less than or equal to 10000 ms.
3782
              "inf":
3783
                type: integer
3784
                description: The total number of observations with response time greater than 10000 ms.
3785
  NginxHTTPUpstreamConfServerMap:
3786
    title: HTTP Upstream Servers
3787
    description: An array of HTTP upstream servers for dynamic configuration.
3788
    type: array
3789
    items:
3790
      $ref: '#/definitions/NginxHTTPUpstreamConfServer'
3791
    example:
3792
      - id: 0
3793
        server: 10.0.0.1:8088
3794
        weight: 1
3795
        max_conns: 0
3796
        max_fails: 0
3797
        fail_timeout: 10s
3798
        slow_start: 10s
3799
        route: ''
3800
        backup: false
3801
        down: false
3802
      - id: 1
3803
        server: 10.0.0.1:8089
3804
        weight: 4
3805
        max_conns: 0
3806
        max_fails: 0
3807
        fail_timeout: 10s
3808
        slow_start: 10s
3809
        route: ''
3810
        backup: true
3811
        down: true
3812
  NginxHTTPUpstreamConfServer:
3813
    title: HTTP Upstream Server
3814
    description: |
3815
      Dynamically configurable parameters of an HTTP upstream
3816
      <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>:
3817
    type: object
3818
    properties:
3819
      id:
3820
        type: integer
3821
        description: The ID of the HTTP upstream server.
3822
          The ID is assigned automatically and cannot be changed.
3823
        readOnly: true
3824
      server:
3825
        type: string
3826
        description: Same as the
3827
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">address</a>
3828
          parameter of the HTTP upstream server.
3829
          When adding a server, it is possible to specify it as a domain name.
3830
          In this case, changes of the IP addresses
3831
          that correspond to a domain name will be monitored and automatically
3832
          applied to the upstream configuration
3833
          without the need of restarting nginx.
3834
          This requires the
3835
          <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver">resolver</a>
3836
          directive in the “<code>http</code>” block.
3837
          See also the
3838
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#resolve">resolve</a>
3839
          parameter of the HTTP upstream server.
3840
      service:
3841
        type: string
3842
        description: Same as the
3843
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</a>
3844
          parameter of the HTTP upstream server.
3845
          This parameter cannot be changed.
3846
        readOnly: true
3847
      weight:
3848
        type: integer
3849
        description: Same as the
3850
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">weight</a>
3851
          parameter of the HTTP upstream server.
3852
      max_conns:
3853
        type: integer
3854
        description: Same as the
3855
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a>
3856
          parameter of the HTTP upstream server.
3857
      max_fails:
3858
        type: integer
3859
        description: Same as the
3860
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</a>
3861
          parameter of the HTTP upstream server.
3862
      fail_timeout:
3863
        type: string
3864
        description: Same as the
3865
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#fail_timeout">fail_timeout</a>
3866
          parameter of the HTTP upstream server.
3867
      slow_start:
3868
        type: string
3869
        description: Same as the
3870
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#slow_start">slow_start</a>
3871
          parameter of the HTTP upstream server.
3872
      route:
3873
        type: string
3874
        description: Same as the
3875
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#route">route</a>
3876
          parameter of the HTTP upstream server.
3877
      backup:
3878
        type: boolean
3879
        description: When <code>true</code>, adds a
3880
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</a>
3881
          server.
3882
          This parameter cannot be changed.
3883
        readOnly: true
3884
      down:
3885
        type: boolean
3886
        description: Same as the
3887
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#down">down</a>
3888
          parameter of the HTTP upstream server.
3889
      drain:
3890
        type: boolean
3891
        description: Same as the
3892
          <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#drain">drain</a>
3893
          parameter of the HTTP upstream server.
3894
      parent:
3895
        type: string
3896
        description: Parent server ID of the resolved server.
3897
          The ID is assigned automatically and cannot be changed.
3898
        readOnly: true
3899
      host:
3900
        type: string
3901
        description: Hostname of the resolved server.
3902
          The hostname is assigned automatically and cannot be changed.
3903
        readOnly: true
3904
    example:
3905
      id: 1
3906
      server: 10.0.0.1:8089
3907
      weight: 4
3908
      max_conns: 0
3909
      max_fails: 0
3910
      fail_timeout: 10s
3911
      slow_start: 10s
3912
      route: ''
3913
      backup: true
3914
      down: true
3915
  NginxHTTPKeyvalZonesMap:
3916
    title: HTTP Keyval Shared Memory Zones
3917
    description: |
3918
      Contents of all HTTP keyval shared memory zones.
3919
    type: object
3920
    additionalProperties:
3921
      $ref: '#/definitions/NginxHTTPKeyvalZone'
3922
    example:
3923
      keyval_zone:
3924
        key1: value1
3925
        key2: value2
3926
        key3: value3
3927
      one:
3928
        arg1: value1
3929
        arg2: value2
3930
        arg3: value3
3931
  NginxHTTPKeyvalZone:
3932
    title: HTTP Keyval Shared Memory Zone
3933
    description: |
3934
      Contents of an HTTP keyval shared memory zone
3935
      when using the GET method.
3936
    type: object
3937
    example:
3938
      key1: value1
3939
      key2: value2
3940
      key3: value3
3941
  NginxHTTPKeyvalZonePostPatch:
3942
    title: HTTP Keyval Shared Memory Zone
3943
    description: |
3944
      Contents of an HTTP keyval shared memory zone
3945
      when using the POST or PATCH methods.
3946
    type: object
3947
    example:
3948
      key1: value1
3949
      key2: value2
3950
      key3:
3951
        value: value3
3952
        expire: 30000
3953
  NginxStreamServerZonesMap:
3954
    title: Stream Server Zones
3955
    description: |
3956
      Status information for all stream
3957
      <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">status zones</a>.
3958
    type: object
3959
    additionalProperties:
3960
      $ref: '#/definitions/NginxStreamServerZone'
3961
    example:
3962
      mysql-frontend:
3963
        processing: 2
3964
        connections: 270925
3965
        sessions:
3966
          2xx: 155564
3967
          4xx: 0
3968
          5xx: 0
3969
          total: 270925
3970
        discarded: 0
3971
        received: 28988975
3972
        sent: 3879346317
3973
        ssl:
3974
          handshakes: 76455
3975
          handshakes_failed: 432
3976
          session_reuses: 28770
3977
          no_common_protocol: 4
3978
          no_common_cipher: 2
3979
          handshake_timeout: 0
3980
          peer_rejected_cert: 0
3981
          verify_failures:
3982
            no_cert: 0
3983
            expired_cert: 2
3984
            revoked_cert: 1
3985
            other: 1
3986
      dns:
3987
        processing: 1
3988
        connections: 155569
3989
        sessions:
3990
          2xx: 155564
3991
          4xx: 0
3992
          5xx: 0
3993
          total: 155569
3994
        discarded: 0
3995
        received: 4200363
3996
        sent: 20489184
3997
        ssl:
3998
          handshakes: 2040
3999
          handshakes_failed: 23
4000
          session_reuses: 65
4001
          no_common_protocol: 4
4002
          no_common_cipher: 2
4003
          handshake_timeout: 0
4004
          peer_rejected_cert: 0
4005
          verify_failures:
4006
            no_cert: 0
4007
            expired_cert: 2
4008
            revoked_cert: 1
4009
            other: 1
4010
  NginxStreamServerZone:
4011
    title: Stream Server Zone
4012
    type: object
4013
    properties:
4014
      processing:
4015
        type: integer
4016
        description: The number of client connections
4017
          that are currently being processed.
4018
      connections:
4019
        type: integer
4020
        description: The total number of connections accepted from clients.
4021
      sessions:
4022
        type: object
4023
        description: The total number of completed sessions,
4024
          and the number of sessions completed with status codes
4025
          “<code>2xx</code>”, “<code>4xx</code>”, or “<code>5xx</code>”.
4026
        properties:
4027
          2xx:
4028
            type: integer
4029
            description: The total number of sessions completed with
4030
              <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
4031
              “<code>2xx</code>”.
4032
          4xx:
4033
            type: integer
4034
            description: The total number of sessions completed with
4035
              <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
4036
              “<code>4xx</code>”.
4037
          5xx:
4038
            type: integer
4039
            description: The total number of sessions completed with
4040
              <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
4041
              “<code>5xx</code>”.
4042
          total:
4043
            type: integer
4044
            description: The total number of completed client sessions.
4045
      discarded:
4046
        type: integer
4047
        description: The total number of
4048
          connections completed without creating a session.
4049
      received:
4050
        type: integer
4051
        description: The total number of bytes received from clients.
4052
      sent:
4053
        type: integer
4054
        description: The total number of bytes sent to clients.
4055
      ssl:
4056
        type: object
4057
        readOnly: true
4058
        properties:
4059
          handshakes:
4060
            type: integer
4061
            description: The total number of successful SSL handshakes.
4062
            readOnly: true
4063
          handshakes_failed:
4064
            type: integer
4065
            description: The total number of failed SSL handshakes.
4066
            readOnly: true
4067
          session_reuses:
4068
            type: integer
4069
            description: The total number of session reuses during SSL handshake.
4070
            readOnly: true
4071
          no_common_protocol:
4072
            type: integer
4073
            description: The number of SSL handshakes failed
4074
              because of no common protocol.
4075
          no_common_cipher:
4076
            type: integer
4077
            description: The number of SSL handshakes failed
4078
              because of no shared cipher.
4079
          handshake_timeout:
4080
            type: integer
4081
            description: The number of SSL handshakes failed
4082
              because of a timeout.
4083
          peer_rejected_cert:
4084
            type: integer
4085
            description: The number of failed SSL handshakes
4086
              when nginx presented the certificate to the client
4087
              but it was rejected with a corresponding alert message.
4088
          verify_failures:
4089
            type: object
4090
            description: SSL certificate verification errors
4091
            properties:
4092
              no_cert:
4093
                type: integer
4094
                description: A client did not provide the required certificate.
4095
              expired_cert:
4096
                type: integer
4097
                description: An expired or not yet valid certificate
4098
                  was presented by a client.
4099
              revoked_cert:
4100
                type: integer
4101
                description: A revoked certificate was presented by a client.
4102
              other:
4103
                type: integer
4104
                description: Other SSL certificate verification errors.
4105
    example:
4106
      dns:
4107
        processing: 1
4108
        connections: 155569
4109
        sessions:
4110
          2xx: 155564
4111
          4xx: 0
4112
          5xx: 0
4113
          total: 155569
4114
        discarded: 0
4115
        received: 4200363
4116
        sent: 20489184
4117
        ssl:
4118
          handshakes: 76455
4119
          handshakes_failed: 432
4120
          session_reuses: 28770
4121
          no_common_protocol: 4
4122
          no_common_cipher: 2
4123
          handshake_timeout: 0
4124
          peer_rejected_cert: 0
4125
          verify_failures:
4126
            no_cert: 0
4127
            expired_cert: 2
4128
            revoked_cert: 1
4129
            other: 1
4130
  NginxStreamLimitConnZonesMap:
4131
    title: Stream limit_conns
4132
    description: |
4133
      Status data for all stream
4134
      <a href="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zones</a>.
4135
    type: object
4136
    additionalProperties:
4137
      $ref: '#/definitions/NginxStreamLimitConnZone'
4138
  NginxStreamLimitConnZone:
4139
    title: Stream Connections Limiting
4140
    type: object
4141
    properties:
4142
      passed:
4143
        type: integer
4144
        description: The total number of connections that were neither limited
4145
          nor accounted as limited.
4146
      rejected:
4147
        type: integer
4148
        description: The total number of connections that were rejected.
4149
      rejected_dry_run:
4150
        type: integer
4151
        description: The total number of connections accounted as rejected in the
4152
          <a href="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_dry_run">dry run</a>
4153
          mode.
4154
    example:
4155
      passed: 15
4156
      rejected: 0
4157
      rejected_dry_run: 2
4158
  NginxStreamUpstreamMap:
4159
    title: Stream Upstreams
4160
    description: Status information of stream upstream server groups.
4161
    type: object
4162
    additionalProperties:
4163
      $ref: '#/definitions/NginxStreamUpstream'
4164
    example:
4165
      mysql_backends:
4166
        peers:
4167
          - id: 0
4168
            server: 10.0.0.1:12345
4169
            name: 10.0.0.1:12345
4170
            backup: false
4171
            weight: 5
4172
            state: up
4173
            active: 0
4174
            ssl:
4175
              handshakes: 1045
4176
              handshakes_failed: 89
4177
              session_reuses: 321
4178
              no_common_protocol: 4
4179
              handshake_timeout: 0
4180
              peer_rejected_cert: 0
4181
              verify_failures:
4182
                expired_cert: 2
4183
                revoked_cert: 1
4184
                hostname_mismatch: 2
4185
                other: 1
4186
            max_conns: 30
4187
            connecions: 1231
4188
            sent: 251946292
4189
            received: 19222475454
4190
            fails: 0
4191
            unavail: 0
4192
            health_checks:
4193
              checks: 26214
4194
              fails: 0
4195
              unhealthy: 0
4196
              last_passed: true
4197
            downtime: 0
4198
            downstart: 2022-06-28T11:09:21.602Z
4199
            selected: 2022-06-28T15:01:25Z
4200
          - id: 1
4201
            server: 10.0.0.1:12346
4202
            name: 10.0.0.1:12346
4203
            backup: true
4204
            weight: 1
4205
            state: unhealthy
4206
            active: 0
4207
            max_conns: 30
4208
            connections: 0
4209
            sent: 0
4210
            received: 0
4211
            fails: 0
4212
            unavail: 0
4213
            health_checks:
4214
              checks: 26284
4215
              fails: 26284
4216
              unhealthy: 1
4217
              last_passed: false
4218
            downtime: 262925617
4219
            downstart: 2022-06-28T11:09:21.602Z
4220
            selected: 2022-06-28T15:01:25Z
4221
        zombies: 0
4222
        zone: mysql_backends
4223
      dns:
4224
        peers:
4225
          - id: 0
4226
            server: 10.0.0.1:12347
4227
            name: 10.0.0.1:12347
4228
            backup: false
4229
            weight: 5
4230
            state: up
4231
            active: 0
4232
            ssl:
4233
              handshakes: 5268
4234
              handshakes_failed: 121
4235
              session_reuses: 854
4236
              no_common_protocol: 4
4237
              handshake_timeout: 0
4238
              peer_rejected_cert: 0
4239
              verify_failures:
4240
                expired_cert: 2
4241
                revoked_cert: 1
4242
                hostname_mismatch: 2
4243
                other: 1
4244
            max_conns: 30
4245
            connections: 667231
4246
            sent: 251946292
4247
            received: 19222475454
4248
            fails: 0
4249
            unavail: 0
4250
            health_checks:
4251
              checks: 26214
4252
              fails: 0
4253
              unhealthy: 0
4254
              last_passed: true
4255
            downtime: 0
4256
            downstart: 2022-06-28T11:09:21.602Z
4257
            selected: 2022-06-28T15:01:25Z
4258
          - id: 1
4259
            server: 10.0.0.1:12348
4260
            name: 10.0.0.1:12348
4261
            backup: true
4262
            weight: 1
4263
            state: unhealthy
4264
            active: 0
4265
            connections: 0
4266
            max_conns: 30
4267
            sent: 0
4268
            received: 0
4269
            fails: 0
4270
            unavail: 0
4271
            health_checks:
4272
              checks: 26284
4273
              fails: 26284
4274
              unhealthy: 1
4275
              last_passed: false
4276
            downtime: 262925617
4277
            downstart: 2022-06-28T11:09:21.602Z
4278
            selected: 2022-06-28T15:01:25Z
4279
        zombies: 0
4280
        zone: dns
4281
  NginxStreamUpstream:
4282
    title: Stream Upstream
4283
    type: object
4284
    properties:
4285
      peers:
4286
        $ref: '#/definitions/NginxStreamUpstreamPeerMap'
4287
      zombies:
4288
        type: integer
4289
        description: The current number of servers removed from the group
4290
          but still processing active client connections.
4291
      zone:
4292
        type: string
4293
        description: The name of the shared memory
4294
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#zone">zone</a>
4295
          that keeps the group’s configuration and run-time state.
4296
    example:
4297
      dns:
4298
        peers:
4299
          - id: 0
4300
            server: 10.0.0.1:12347
4301
            name: 10.0.0.1:12347
4302
            backup: false
4303
            weight: 5
4304
            state: up
4305
            active: 0
4306
            ssl:
4307
              handshakes: 200
4308
              handshakes_failed: 4
4309
              session_reuses: 189
4310
              no_common_protocol: 4
4311
              handshake_timeout: 0
4312
              peer_rejected_cert: 0
4313
              verify_failures:
4314
                expired_cert: 2
4315
                revoked_cert: 1
4316
                hostname_mismatch: 2
4317
                other: 1
4318
            max_conns: 50
4319
            connections: 667231
4320
            sent: 251946292
4321
            received: 19222475454
4322
            fails: 0
4323
            unavail: 0
4324
            health_checks:
4325
              checks: 26214
4326
              fails: 0
4327
              unhealthy: 0
4328
              last_passed: true
4329
            downtime: 0
4330
            downstart: 2022-06-28T11:09:21.602Z
4331
            selected: 2022-06-28T15:01:25Z
4332
          - id: 1
4333
            server: 10.0.0.1:12348
4334
            name: 10.0.0.1:12348
4335
            backup: true
4336
            weight: 1
4337
            state: unhealthy
4338
            active: 0
4339
            max_conns: 50
4340
            connections: 0
4341
            sent: 0
4342
            received: 0
4343
            fails: 0
4344
            unavail: 0
4345
            health_checks:
4346
              checks: 26284
4347
              fails: 26284
4348
              unhealthy: 1
4349
              last_passed: false
4350
            downtime: 262925617
4351
            downstart: 2022-06-28T11:09:21.602Z
4352
            selected: 2022-06-28T15:01:25Z
4353
        zombies: 0
4354
        zone: dns
4355
  NginxStreamUpstreamPeerMap:
4356
    title: Stream Upstream Servers
4357
    description: Array of stream upstream servers.
4358
    type: array
4359
    items:
4360
      $ref: '#/definitions/NginxStreamUpstreamPeer'
4361
  NginxStreamUpstreamPeer:
4362
    title: Stream Upstream Server
4363
    type: object
4364
    properties:
4365
      id:
4366
        type: integer
4367
        description: The ID of the server.
4368
        readOnly: true
4369
      server:
4370
        type: string
4371
        description: An
4372
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</a>
4373
          of the server.
4374
      service:
4375
        type: string
4376
        description: The
4377
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</a>
4378
          parameter value of the
4379
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>
4380
          directive.
4381
      name:
4382
        type: string
4383
        format: hostname
4384
        description: The name of the server specified in the
4385
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>
4386
          directive.
4387
        readOnly: true
4388
      backup:
4389
        type: boolean
4390
        description: A boolean value indicating whether the server is a
4391
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</a>
4392
          server.
4393
      weight:
4394
        type: integer
4395
        description: <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">Weight</a>
4396
          of the server.
4397
      state:
4398
        type: string
4399
        readOnly: true
4400
        enum:
4401
          - up
4402
          - down
4403
          - unavail
4404
          - checking
4405
          - unhealthy
4406
        description: Current state, which may be one of
4407
          “<code>up</code>”, “<code>down</code>”, “<code>unavail</code>”,
4408
          “<code>checking</code>”, or “<code>unhealthy</code>”.
4409
      active:
4410
        type: integer
4411
        description: The current number of connections.
4412
        readOnly: true
4413
      ssl:
4414
        type: object
4415
        readOnly: true
4416
        properties:
4417
          handshakes:
4418
            type: integer
4419
            description: The total number of successful SSL handshakes.
4420
            readOnly: true
4421
          handshakes_failed:
4422
            type: integer
4423
            description: The total number of failed SSL handshakes.
4424
            readOnly: true
4425
          session_reuses:
4426
            type: integer
4427
            description: The total number of session reuses during SSL handshake.
4428
            readOnly: true
4429
          no_common_protocol:
4430
            type: integer
4431
            description: The number of SSL handshakes failed
4432
              because of no common protocol.
4433
          handshake_timeout:
4434
            type: integer
4435
            description: The number of SSL handshakes failed
4436
              because of a timeout.
4437
          peer_rejected_cert:
4438
            type: integer
4439
            description: The number of failed SSL handshakes
4440
              when nginx presented the certificate to the upstream server
4441
              but it was rejected with a corresponding alert message.
4442
          verify_failures:
4443
            type: object
4444
            description: SSL certificate verification errors
4445
            properties:
4446
              expired_cert:
4447
                type: integer
4448
                description: An expired or not yet valid certificate
4449
                  was presented by an upstream server.
4450
              revoked_cert:
4451
                type: integer
4452
                description: A revoked certificate was presented by an upstream server.
4453
              hostname_mismatch:
4454
                type: integer
4455
                description: Server's certificate doesn't match the hostname.
4456
              other:
4457
                type: integer
4458
                description: Other SSL certificate verification errors.
4459
      max_conns:
4460
        type: integer
4461
        description: The
4462
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a>
4463
          limit for the server.
4464
      connections:
4465
        type: integer
4466
        description: The total number of client connections forwarded to this server.
4467
        readOnly: true
4468
      connect_time:
4469
        type: integer
4470
        description: The average time to connect to the upstream server.
4471
        readOnly: true
4472
      first_byte_time:
4473
        type: integer
4474
        description: The average time to receive the first byte of data.
4475
        readOnly: true
4476
      response_time:
4477
        type: integer
4478
        description: The average time to receive the last byte of data.
4479
        readOnly: true
4480
      sent:
4481
        type: integer
4482
        description: The total number of bytes sent to this server.
4483
        readOnly: true
4484
      received:
4485
        type: integer
4486
        description: The total number of bytes received from this server.
4487
        readOnly: true
4488
      fails:
4489
        type: integer
4490
        description: The total number of unsuccessful attempts
4491
          to communicate with the server.
4492
        readOnly: true
4493
      unavail:
4494
        type: integer
4495
        description: How many times the server became unavailable for client connections
4496
          (state “<code>unavail</code>”) due to the number of unsuccessful
4497
          attempts reaching the
4498
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</a>
4499
          threshold.
4500
        readOnly: true
4501
      health_checks:
4502
        type: object
4503
        readOnly: true
4504
        properties:
4505
          checks:
4506
            type: integer
4507
            description: The total number of
4508
              <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#health_check">health check</a>
4509
              requests made.
4510
            readOnly: true
4511
          fails:
4512
            type: integer
4513
            description: The number of failed health checks.
4514
            readOnly: true
4515
          unhealthy:
4516
            type: integer
4517
            description: How many times the server became unhealthy
4518
              (state “<code>unhealthy</code>”).
4519
            readOnly: true
4520
          last_passed:
4521
            type: boolean
4522
            description: Boolean indicating whether the last health check request
4523
              was successful and passed
4524
              <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#match">tests</a>.
4525
            readOnly: true
4526
      downtime:
4527
        type: integer
4528
        description: Total time the server was in the
4529
          “<code>unavail</code>”, “<code>checking</code>”,
4530
          and “<code>unhealthy</code>” states.
4531
        readOnly: true
4532
      downstart:
4533
        type: string
4534
        format: date-time
4535
        description: The time when the server became
4536
          “<code>unavail</code>”, “<code>checking</code>”,
4537
          or “<code>unhealthy</code>”,
4538
          in the ISO 8601 format with millisecond resolution.
4539
        readOnly: true
4540
      selected:
4541
        type: string
4542
        format: date-time
4543
        description: The time when the server was last selected
4544
          to process a connection,
4545
          in the ISO 8601 format with millisecond resolution.
4546
        readOnly: true
4547
  NginxStreamUpstreamConfServerMap:
4548
    title: Stream Upstream Servers
4549
    description: |
4550
      An array of stream upstream servers for dynamic configuration.
4551
    type: array
4552
    items:
4553
      $ref: '#/definitions/NginxStreamUpstreamConfServer'
4554
    example:
4555
      - id: 0
4556
        server: 10.0.0.1:12348
4557
        weight: 1
4558
        max_conns: 0
4559
        max_fails: 1
4560
        fail_timeout: 10s
4561
        slow_start: 0
4562
        backup: false
4563
        down: false
4564
      - id: 1
4565
        server: 10.0.0.1:12349
4566
        weight: 1
4567
        max_conns: 0
4568
        max_fails: 1
4569
        fail_timeout: 10s
4570
        slow_start: 0
4571
        backup: false
4572
        down: false
4573
  NginxStreamUpstreamConfServer:
4574
    title: Stream Upstream Server
4575
    description: |
4576
      Dynamically configurable parameters of a stream upstream
4577
      <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>:
4578
    type: object
4579
    properties:
4580
      id:
4581
        type: integer
4582
        description: The ID of the stream upstream server.
4583
          The ID is assigned automatically and cannot be changed.
4584
        readOnly: true
4585
      server:
4586
        type: string
4587
        description: Same as the
4588
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</a>
4589
          parameter of the stream upstream server.
4590
          When adding a server, it is possible to specify it as a domain name.
4591
          In this case, changes of the IP addresses
4592
          that correspond to a domain name will be monitored and automatically
4593
          applied to the upstream configuration
4594
          without the need of restarting nginx.
4595
          This requires the
4596
          <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#resolver">resolver</a>
4597
          directive in the “<code>stream</code>” block.
4598
          See also the
4599
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#resolve">resolve</a>
4600
          parameter of the stream upstream server.
4601
      service:
4602
        type: string
4603
        description: Same as the
4604
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</a>
4605
          parameter of the stream upstream server.
4606
          This parameter cannot be changed.
4607
        readOnly: true
4608
      weight:
4609
        type: integer
4610
        description: Same as the
4611
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">weight</a>
4612
          parameter of the stream upstream server.
4613
      max_conns:
4614
        type: integer
4615
        description: Same as the
4616
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a>
4617
          parameter of the stream upstream server.
4618
      max_fails:
4619
        type: integer
4620
        description: Same as the
4621
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</a>
4622
          parameter of the stream upstream server.
4623
      fail_timeout:
4624
        type: string
4625
        description: Same as the
4626
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#fail_timeout">fail_timeout</a>
4627
          parameter of the stream upstream server.
4628
      slow_start:
4629
        type: string
4630
        description: Same as the
4631
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#slow_start">slow_start</a>
4632
          parameter of the stream upstream server.
4633
      backup:
4634
        type: boolean
4635
        description: When <code>true</code>, adds a
4636
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</a>
4637
          server.
4638
          This parameter cannot be changed.
4639
        readOnly: true
4640
      down:
4641
        type: boolean
4642
        description: Same as the
4643
          <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#down">down</a>
4644
          parameter of the stream upstream server.
4645
      parent:
4646
        type: string
4647
        description: Parent server ID of the resolved server.
4648
          The ID is assigned automatically and cannot be changed.
4649
        readOnly: true
4650
      host:
4651
        type: string
4652
        description: Hostname of the resolved server.
4653
          The hostname is assigned automatically and cannot be changed.
4654
        readOnly: true
4655
    example:
4656
      id: 0
4657
      server: 10.0.0.1:12348
4658
      weight: 1
4659
      max_conns: 0
4660
      max_fails: 1
4661
      fail_timeout: 10s
4662
      slow_start: 0
4663
      backup: false
4664
      down: false
4665
  NginxStreamKeyvalZonesMap:
4666
    title: Stream Keyval Shared Memory Zones
4667
    description: |
4668
      Contents of all stream keyval shared memory zones.
4669
    type: object
4670
    additionalProperties:
4671
      $ref: '#/definitions/NginxStreamKeyvalZone'
4672
    example:
4673
      keyval_zone:
4674
        key1: value1
4675
        key2: value2
4676
        key3: value3
4677
      one:
4678
        arg1: value1
4679
        arg2: value2
4680
        arg3: value3
4681
  NginxStreamKeyvalZone:
4682
    title: Stream Keyval Shared Memory Zone
4683
    description: |
4684
      Contents of a stream keyval shared memory zone when using the GET method.
4685
    type: object
4686
    example:
4687
      key1: value1
4688
      key2: value2
4689
      key3: value3
4690
  NginxStreamKeyvalZonePostPatch:
4691
    title: Stream Keyval Shared Memory Zone
4692
    description: |
4693
      Contents of a stream keyval shared memory zone
4694
      when using the POST or PATCH methods.
4695
    type: object
4696
    example:
4697
      key1: value1
4698
      key2: value2
4699
      key3:
4700
        value: value3
4701
        expire: 30000
4702
  NginxStreamZoneSync:
4703
    title: Stream Zone Sync Node
4704
    type: object
4705
    properties:
4706
      zones:
4707
        type: object
4708
        title: Zone Sync Zones
4709
        description: Synchronization information per each shared memory zone.
4710
        additionalProperties:
4711
          $ref: '#/definitions/NginxStreamZoneSyncZone'
4712
      status:
4713
        type: object
4714
        description: Synchronization information per node in a cluster.
4715
        properties:
4716
          bytes_in:
4717
            type: integer
4718
            description: The number of bytes received by this node.
4719
          msgs_in:
4720
            type: integer
4721
            description: The number of messages received by this node.
4722
          msgs_out:
4723
            type: integer
4724
            description: The number of messages sent by this node.
4725
          bytes_out:
4726
            type: integer
4727
            description: The number of bytes sent by this node.
4728
          nodes_online:
4729
            type: integer
4730
            description: The number of peers this node is connected to.
4731
    example:
4732
      zones:
4733
        zone1:
4734
          records_pending: 2061
4735
          records_total: 260575
4736
        zone2:
4737
          records_pending: 0
4738
          records_total: 14749
4739
      status:
4740
        bytes_in: 1364923761
4741
        msgs_in: 337236
4742
        msgs_out: 346717
4743
        bytes_out: 1402765472
4744
        nodes_online: 15
4745
  NginxStreamZoneSyncZone:
4746
    title: Sync Zone
4747
    description: Synchronization status of a shared memory zone.
4748
    type: object
4749
    properties:
4750
      records_pending:
4751
        type: integer
4752
        description: The number of records that need to be sent to the cluster.
4753
      records_total:
4754
        type: integer
4755
        description: The total number of records stored in the shared memory zone.
4756
  NginxResolverZonesMap:
4757
    title: Resolver Zones
4758
    description: |
4759
      Status data for all
4760
      <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zones</a>.
4761
    type: object
4762
    additionalProperties:
4763
      $ref: '#/definitions/NginxResolverZone'
4764
    example:
4765
      resolver_zone1:
4766
        requests:
4767
          name: 25460
4768
          srv: 130
4769
          addr: 2580
4770
        responses:
4771
          noerror: 26499
4772
          formerr: 0
4773
          servfail: 3
4774
          nxdomain: 0
4775
          notimp: 0
4776
          refused: 0
4777
          timedout: 243
4778
          unknown: 478
4779
      resolver_zone2:
4780
        requests:
4781
          name: 325460
4782
          srv: 1130
4783
          addr: 12580
4784
        responses:
4785
          noerror: 226499
4786
          formerr: 0
4787
          servfail: 283
4788
          nxdomain: 0
4789
          notimp: 0
4790
          refused: 0
4791
          timedout: 743
4792
          unknown: 1478
4793
  NginxResolverZone:
4794
    title: Resolver Zone
4795
    description: |
4796
      Statistics of DNS requests and responses per particular
4797
      <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</a>.
4798
    type: object
4799
    properties:
4800
      requests:
4801
        type: object
4802
        readOnly: true
4803
        properties:
4804
          name:
4805
            type: integer
4806
            description: The total number of requests
4807
              to resolve names to addresses.
4808
            readOnly: true
4809
          srv:
4810
            type: integer
4811
            description: The total number of requests
4812
             to resolve SRV records.
4813
            readOnly: true
4814
          addr:
4815
           type: integer
4816
           description: The total number of requests
4817
             to resolve addresses to names.
4818
           readOnly: true
4819
      responses:
4820
        type: object
4821
        readOnly: true
4822
        properties:
4823
          noerror:
4824
            type: integer
4825
            description: The total number of successful responses.
4826
            readOnly: true
4827
          formerr:
4828
            type: integer
4829
            description: The total number of
4830
              FORMERR (<literal>Format error</literal>) responses.
4831
            readOnly: true
4832
          servfail:
4833
           type: integer
4834
           description: The total number of
4835
             SERVFAIL (<literal>Server failure</literal>) responses.
4836
           readOnly: true
4837
          nxdomain:
4838
           type: integer
4839
           description: The total number of
4840
             NXDOMAIN (<literal>Host not found</literal>) responses.
4841
           readOnly: true
4842
          notimp:
4843
           type: integer
4844
           description: The total number of
4845
             NOTIMP (<literal>Unimplemented</literal>) responses.
4846
           readOnly: true
4847
          refused:
4848
           type: integer
4849
           description: The total number of
4850
             REFUSED (<literal>Operation refused</literal>) responses.
4851
           readOnly: true
4852
          timedout:
4853
           type: integer
4854
           description: The total number of timed out requests.
4855
           readOnly: true
4856
          unknown:
4857
           type: integer
4858
           description: The total number of requests
4859
             completed with an unknown error.
4860
           readOnly: true
4861
    example:
4862
      resolver_zone1:
4863
        requests:
4864
          name: 25460
4865
          srv: 130
4866
          addr: 2580
4867
        responses:
4868
          noerror: 26499
4869
          formerr: 0
4870
          servfail: 3
4871
          nxdomain: 0
4872
          notimp: 0
4873
          refused: 0
4874
          timedout: 243
4875
          unknown: 478
4876
  NginxLicenseObject:
4877
    title: License
4878
    description: |
4879
      License and usage reporting status of NGINX Plus instance.
4880
    properties:
4881
      eval:
4882
        type: boolean
4883
        description: Indicates whether NGINX Plus license is trial.
4884
        readOnly: true
4885
      active_till:
4886
        type: integer
4887
        description: The Unix timestamp of license expiration.
4888
        readOnly: true
4889
      reporting:
4890
        type: object
4891
        properties:
4892
          healthy:
4893
            type: boolean
4894
            description: Indicates whether the reporting state is still considered healthy despite recent failed attempts.
4895
            readOnly: true
4896
          fails:
4897
            type: integer
4898
            description: The number of failed reporting attempts, reset each time the usage report is successfully sent.
4899
            readOnly: true
4900
          grace:
4901
            type: integer
4902
            description: The number of seconds before traffic processing is stopped after unsuccessful report attempt.
4903
            readOnly: true
4904
          uuid:
4905
            type: string
4906
            description: The ID of NGINX Plus instance in the UUID format.
4907
            readOnly: true
4908
    example:
4909
      eval: false
4910
      active_till: 1749268757
4911
      reporting:
4912
        healthy: true
4913
        fails: 2
4914
        grace: 15551961
4915
        uuid: 13754cba-29fb-53e5-c32e-a6cf57c84b01
4916
  NginxWorker:
4917
    title: Worker process
4918
    description: |
4919
      Statistics per each worker process.
4920
    properties:
4921
      id:
4922
        type: integer
4923
        description: The ID of the worker process.
4924
      pid:
4925
        type: integer
4926
        description: The PID identifier of the worker process used by the operating system.
4927
      connections:
4928
        type: object
4929
        description: |
4930
          The number of accepted, dropped, active, and idle connections
4931
          per worker process.
4932
        properties:
4933
          accepted:
4934
            type: integer
4935
            description: |
4936
              The total number of client connections
4937
              accepted by the worker process.
4938
          dropped:
4939
            type: integer
4940
            description: |
4941
              The total number of client connections
4942
              dropped by the worker process.
4943
          active:
4944
            type: integer
4945
            description: |
4946
              The current number of active client connections
4947
              that are currently being handled by the worker process.
4948
          idle:
4949
            type: integer
4950
            description: |
4951
              The number of idle client connections
4952
              that are currently being handled by the worker process.
4953
      http:
4954
        type: object
4955
        properties:
4956
          requests:
4957
            type: object
4958
            description: The total number of client requests handled by the worker process.
4959
            properties:
4960
              total:
4961
                type: integer
4962
                description: The total number of client requests received by the worker process.
4963
              current:
4964
                type: integer
4965
                description: The current number of client requests that are currently being processed by the worker process.
4966
    example:
4967
      id: 0
4968
      pid: 32212
4969
      connections:
4970
        accepted: 1
4971
        dropped: 0
4972
        active: 1
4973
        idle: 0
4974
      http:
4975
        requests:
4976
          total: 15
4977
          current: 1
4978
  NginxWorkersMap:
4979
    title: Worker processes
4980
    description: nginx worker processes object.
4981
    type: object
4982
    additionalProperties:
4983
      $ref: '#/definitions/NginxWorker'
4984
    example:
4985
      - id: 0
4986
        pid: 32212
4987
        connections:
4988
          accepted: 1
4989
          dropped: 0
4990
          active: 1
4991
          idle: 0
4992
        http:
4993
          requests:
4994
            total: 19
4995
            current: 1
4996
      - id: 1
4997
        pid: 32214
4998
        connections:
4999
          accepted: 1
5000
          dropped: 0
5001
          active: 1
5002
          idle: 0
5003
        http:
5004
          requests:
5005
            total: 15
5006
            current: 0
5007
  NginxError:
5008
    title: Error
5009
    description: |
5010
      nginx error object.
5011
    type: object
5012
    properties:
5013
      error:
5014
        type: object
5015
        properties:
5016
          status:
5017
            type: integer
5018
            description: HTTP error code.
5019
          text:
5020
            type: string
5021
            description: Error description.
5022
          code:
5023
            type: string
5024
            description: Internal nginx error code.
5025
      request_id:
5026
        type: string
5027
        description: The ID of the request, equals the value of the
5028
          <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</a>
5029
          variable.
5030
      href:
5031
        type: string
5032
        description: Link to reference documentation.
5033

5034
Product

Resources

Company
