NGINX Plus HTTP API

swagger: '2.0'
info:
  version: '9.0'
  title: NGINX Plus REST API
  description: NGINX Plus REST [API](https://nginx.org/en/docs/http/ngx_http_api_module.html) provides access to NGINX Plus status information, on-the-fly configuration of upstream servers and key-value pairs management for [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html).
basePath: /api/9
tags:
- name: General Info
- name: Processes
- name: Connections
- name: Workers
- name: Slabs
- name: Resolvers
- name: SSL
- name: HTTP
- name: HTTP Requests
- name: HTTP Server Zones
- name: HTTP Location Zones
- name: HTTP Caches
- name: HTTP Limit Conns
- name: HTTP Limit Reqs
- name: HTTP Keyvals
- name: HTTP Upstreams
- name: License
- name: Stream
- name: Stream Server Zones
- name: Stream Limit Conns
- name: Stream Keyvals
- name: Stream Upstreams
- name: Stream Zone Sync
- name: Method GET
- name: Method POST
- name: Method PATCH
- name: Method DELETE
schemes:
- http
- https
paths:
  /:
    get:
      tags:
      - General Info
      - Method GET
      summary: NGINX Return List of Root Endpoints
      description: Returns a list of root endpoints.
      operationId: getAPIEndpoints
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ArrayOfStrings'
          examples:
            application/json:
            - nginx
            - processes
            - connections
            - slabs
            - http
            - stream
            - ssl
          x-microcks-refs:
          - name: getAPIEndpoints200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id001 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getAPIEndpoints404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /nginx:
    get:
      tags:
      - General Info
      - Method GET
      summary: NGINX Return Status of NGINX Running Instance
      description: Returns nginx version, build name, address, number of configuration reloads, IDs of master and worker processes.
      operationId: getNginx
      produces:
      - application/json
      parameters:
      - in: query
        name: fields
        type: string
        description: Limits which fields of nginx running instance will be output.
        x-example: ''
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxObject'
          examples:
            application/json: &id006
              nginx:
                version: 1.21.6
                build: nginx-plus-r27
                address: 206.251.255.64
                generation: 6
                load_timestamp: 2022-06-28T11:15:44.467000Z
                timestamp: 2022-06-28T09:26:07.305000Z
                pid: 32212
                ppid: 32210
          x-microcks-refs:
          - name: getNginx200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getNginx404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /processes:
    get:
      tags:
      - Processes
      - Method GET
      summary: NGINX Return NGINX Processes Status
      description: Returns the number of abnormally terminated and respawned child processes.
      operationId: getProcesses
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxProcesses'
          examples:
            application/json: &id007
              respawned: 0
          x-microcks-refs:
          - name: getProcesses200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getProcesses404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Processes
      - Method DELETE
      summary: NGINX Reset NGINX Processes Statistics
      description: Resets counters of abnormally terminated and respawned child processes.
      operationId: deleteProcesses
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteProcesses404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteProcesses405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /connections:
    get:
      tags:
      - Connections
      - Method GET
      summary: NGINX Return Client Connections Statistics
      description: Returns statistics of client connections.
      operationId: getConnections
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxConnections'
          examples:
            application/json: &id008
              accepted: 4968119
              dropped: 0
              active: 5
              idle: 117
          x-microcks-refs:
          - name: getConnections200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getConnections404Example
            x-microcks-default: true
      parameters:
      - in: query
        name: fields
        type: string
        description: Limits which fields of the connections statistics will be output.
        x-example: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Connections
      - Method DELETE
      summary: NGINX Reset Client Connections Statistics
      description: Resets statistics of accepted and dropped client connections.
      operationId: deleteConnections
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteConnections404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteConnections405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /slabs/:
    get:
      tags:
      - Slabs
      - Method GET
      summary: NGINX Return Status of All Slabs
      description: Returns status of slabs for each shared memory zone with slab allocator.
      operationId: getSlabs
      produces:
      - application/json
      parameters:
      - in: query
        name: fields
        type: string
        description: Limits which fields of slab zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.
        x-example: ''
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxSlabZoneMap'
          examples:
            application/json: &id010
              http_cache:
                pages:
                  used: 2
                  free: 2452
                slots:
                  8:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  16:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  32:
                    used: 1
                    free: 126
                    reqs: 1
                    fails: 0
                  64:
                    used: 2
                    free: 62
                    reqs: 2
                    fails: 0
                  128:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
              dns-backends:
                pages:
                  used: 1143
                  free: 2928
                slots:
                  8:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  16:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  32:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  64:
                    used: 1
                    free: 63
                    reqs: 1
                    fails: 0
                  128:
                    used: 0
                    free: 0
                    reqs: 0
                    fails: 0
                  256:
                    used: 18078
                    free: 178
                    reqs: 1635736
                    fails: 0
          x-microcks-refs:
          - name: getSlabs200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getSlabs404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  '/slabs/{slabZoneName}':
    parameters:
    - name: slabZoneName
      in: path
      description: The name of the shared memory zone with slab allocator.
      required: true
      type: string
      x-example: example_slabZoneName
    get:
      tags:
      - Slabs
      - Method GET
      summary: NGINX Return Status of a Slab
      description: Returns status of slabs for a particular shared memory zone with slab allocator.
      operationId: getSlabZone
      produces:
      - application/json
      parameters:
      - in: query
        name: fields
        type: string
        description: Limits which fields of the slab zone will be output.
        x-example: ''
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxSlabZone'
          examples:
            application/json: &id011
              pages:
                used: 1143
                free: 2928
              slots:
                8:
                  used: 0
                  free: 0
                  reqs: 0
                  fails: 0
                16:
                  used: 0
                  free: 0
                  reqs: 0
                  fails: 0
                32:
                  used: 0
                  free: 0
                  reqs: 0
                  fails: 0
                64:
                  used: 1
                  free: 63
                  reqs: 1
                  fails: 0
                128:
                  used: 0
                  free: 0
                  reqs: 0
                  fails: 0
                256:
                  used: 18078
                  free: 178
                  reqs: 1635736
                  fails: 0
          x-microcks-refs:
          - name: getSlabZone200Example
            x-microcks-default: true
        '404':
          description: |
            Slab not found (*SlabNotFound*),
            unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getSlabZone404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Slabs
      - Method DELETE
      summary: NGINX Reset Slab Statistics
      description: Resets the “<literal>reqs</literal>” and “<literal>fails</literal>” metrics for each memory slot.
      operationId: deleteSlabZoneStats
      responses:
        '204':
          description: Success
        '404':
          description: |
            Slab not found (*SlabNotFound*),
            unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteSlabZoneStats404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteSlabZoneStats405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/:
    get:
      tags:
      - HTTP
      - Method GET
      summary: NGINX Return List of HTTP-Related Endpoints
      description: Returns a list of first level HTTP endpoints.
      operationId: getHttp
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ArrayOfStrings'
          examples:
            application/json:
            - nginx
            - processes
            - connections
            - slabs
            - http
            - stream
            - ssl
          x-microcks-refs:
          - name: getHttp200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getHttp404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/requests:
    get:
      tags:
      - HTTP Requests
      - Method GET
      summary: NGINX Return HTTP Requests Statistics
      description: Returns status of client HTTP requests.
      operationId: getHttpRequests
      produces:
      - application/json
      parameters:
      - in: query
        name: fields
        type: string
        description: Limits which fields of client HTTP requests statistics will be output.
        x-example: ''
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxHTTPRequests'
          examples:
            application/json: &id012
              total: 10624511
              current: 4
          x-microcks-refs:
          - name: getHttpRequests200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getHttpRequests404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - HTTP Requests
      - Method DELETE
      summary: NGINX Reset HTTP Requests Statistics
      description: Resets the number of total client HTTP requests.
      operationId: deleteHttpRequests
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpRequests404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpRequests405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/server_zones/:
    get:
      tags:
      - HTTP Server Zones
      - Method GET
      summary: NGINX Return Status of All HTTP Server Zones
      description: Returns status information for each HTTP [server zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone).
      operationId: getHttpServerZones
      produces:
      - application/json
      parameters:
      - in: query
        name: fields
        type: string
        description: Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.
        x-example: ''
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxHTTPServerZonesMap'
          examples:
            application/json: &id013
              site1:
                processing: 2
                requests: 736395
                responses:
                  1xx: 0
                  2xx: 727290
                  3xx: 4614
                  4xx: 934
                  5xx: 1535
                  codes:
                    200: 727270
                    301: 4614
                    404: 930
                    503: 1535
                  total: 734373
                discarded: 2020
                received: 180157219
                sent: 20183175459
                ssl:
                  handshakes: 65432
                  handshakes_failed: 421
                  session_reuses: 4645
                  no_common_protocol: 4
                  no_common_cipher: 2
                  handshake_timeout: 0
                  peer_rejected_cert: 0
                  verify_failures:
                    no_cert: 0
                    expired_cert: 2
                    revoked_cert: 1
                    hostname_mismatch: 2
                    other: 1
              site2:
                processing: 1
                requests: 185307
                responses:
                  1xx: 0
                  2xx: 112674
                  3xx: 45383
                  4xx: 2504
                  5xx: 4419
                  codes:
                    200: 112674
                    301: 45383
                    404: 2504
                    503: 4419
                  total: 164980
                discarded: 20326
                received: 51575327
                sent: 2983241510
                ssl:
                  handshakes: 104303
                  handshakes_failed: 1421
                  session_reuses: 54645
                  no_common_protocol: 4
                  no_common_cipher: 2
                  handshake_timeout: 0
                  peer_rejected_cert: 0
                  verify_failures:
                    no_cert: 0
                    expired_cert: 2
                    revoked_cert: 1
                    hostname_mismatch: 2
                    other: 1
          x-microcks-refs:
          - name: getHttpServerZones200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getHttpServerZones404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  '/http/server_zones/{httpServerZoneName}':
    parameters:
    - name: httpServerZoneName
      in: path
      description: The name of an HTTP server zone.
      type: string
      required: true
      x-example: example_httpServerZoneName
    get:
      tags:
      - HTTP Server Zones
      - Method GET
      summary: NGINX Return Status of an HTTP Server Zone
      description: Returns status of a particular HTTP server zone.
      operationId: getHttpServerZone
      produces:
      - application/json
      parameters:
      - name: fields
        in: query
        type: string
        description: Limits which fields of the server zone will be output.
        x-example: ''
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxHTTPServerZone'
          examples:
            application/json: &id014
              processing: 1
              requests: 706690
              responses:
                1xx: 0
                2xx: 699482
                3xx: 4522
                4xx: 907
                5xx: 266
                codes:
                  200: 699482
                  301: 4522
                  404: 907
                  503: 266
                total: 705177
              discarded: 1513
              received: 172711587
              sent: 19415530115
              ssl:
                handshakes: 104303
                handshakes_failed: 1421
                session_reuses: 54645
                no_common_protocol: 4
                no_common_cipher: 2
                handshake_timeout: 0
                peer_rejected_cert: 0
                verify_failures:
                  no_cert: 0
                  expired_cert: 2
                  revoked_cert: 1
                  other: 1
          x-microcks-refs:
          - name: getHttpServerZone200Example
            x-microcks-default: true
        '404':
          description: |
            Server zone not found (*ServerZoneNotFound*),
            unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getHttpServerZone404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - HTTP Server Zones
      - Method DELETE
      summary: NGINX Reset Statistics for an HTTP Server Zone
      description: Resets statistics of accepted and discarded requests, responses, received and sent bytes, counters of SSL handshakes and session reuses in a particular HTTP server zone.
      operationId: deleteHttpServerZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: |
            Server zone not found (*ServerZoneNotFound*),
            unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpServerZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpServerZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/location_zones/:
    get:
      tags:
      - HTTP Location Zones
      - Method GET
      summary: NGINX Return Status of All HTTP Location Zones
      description: Returns status information for each HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
      operationId: getHttpLocationZones
      produces:
      - application/json
      parameters:
      - in: query
        name: fields
        type: string
        description: Limits which fields of location zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.
        x-example: ''
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxHTTPLocationZonesMap'
          examples:
            application/json: &id015
              site1:
                requests: 736395
                responses:
                  1xx: 0
                  2xx: 727290
                  3xx: 4614
                  4xx: 934
                  5xx: 1535
                  codes:
                    200: 727290
                    301: 4614
                    404: 934
                    503: 1535
                  total: 734373
                discarded: 2020
                received: 180157219
                sent: 20183175459
              site2:
                requests: 185307
                responses:
                  1xx: 0
                  2xx: 112674
                  3xx: 45383
                  4xx: 2504
                  5xx: 4419
                  codes:
                    200: 112674
                    301: 45383
                    404: 2504
                    503: 4419
                  total: 164980
                discarded: 20326
                received: 51575327
                sent: 2983241510
          x-microcks-refs:
          - name: getHttpLocationZones200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getHttpLocationZones404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  '/http/location_zones/{httpLocationZoneName}':
    parameters:
    - name: httpLocationZoneName
      in: path
      description: The name of an HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
      type: string
      required: true
      x-example: example_httpLocationZoneName
    get:
      tags:
      - HTTP Location Zones
      - Method GET
      summary: NGINX Return Status of an HTTP Location Zone
      description: Returns status of a particular HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
      operationId: getHttpLocationZone
      produces:
      - application/json
      parameters:
      - name: fields
        in: query
        type: string
        description: Limits which fields of the location zone will be output.
        x-example: ''
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxHTTPLocationZone'
          examples:
            application/json: &id016
              requests: 706690
              responses:
                1xx: 0
                2xx: 699482
                3xx: 4522
                4xx: 907
                5xx: 266
                codes:
                  200: 112674
                  301: 4522
                  404: 2504
                  503: 266
                total: 705177
              discarded: 1513
              received: 172711587
              sent: 19415530115
          x-microcks-refs:
          - name: getHttpLocationZone200Example
            x-microcks-default: true
        '404':
          description: |
            Location zone not found (*LocationZoneNotFound*),
            unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getHttpLocationZone404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - HTTP Location Zones
      - Method DELETE
      summary: NGINX Reset Statistics for a Location Zone
      description: Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular location zone.
      operationId: deleteHttpLocationZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: |
            Location zone not found (*LocationZoneNotFound*),
            unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpLocationZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpLocationZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/caches/:
    get:
      tags:
      - HTTP Caches
      - Method GET
      summary: NGINX Return Status of All Caches
      description: Returns status of each cache configured by [proxy_cache_path](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path) and other “<literal>*_cache_path</literal>” directives.
      operationId: getHttpCaches
      produces:
      - application/json
      parameters:
      - name: fields
        in: query
        type: string
        description: Limits which fields of cache zones will be output. If the “<l

# --- truncated at 32 KB (220 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/openapi/nginx-plus-http-api-openapi.yaml