openapi: 3.2.0
info:
  version: '9.0'
  title: NGINX Plus REST HTTP Server Zones API
  description: NGINX Plus REST API provides access to NGINX Plus status information, on-the-fly configuration of upstream servers and key-value pairs management for http and stream.
servers:
- url: /api/9
tags:
- name: HTTP Server Zones
paths:
  /http/server_zones/:
    get:
      tags:
      - HTTP Server Zones
      summary: Return status of all HTTP server zones
      description: Returns status information for each HTTP server zone.
      operationId: getHttpServerZones
      parameters:
      - in: query
        name: fields
        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.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxHTTPServerZonesMap'
        '404':
          description: Unknown version (*UnknownVersion*)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
  /http/server_zones/{httpServerZoneName}:
    parameters:
    - name: httpServerZoneName
      in: path
      description: The name of an HTTP server zone.
      required: true
      schema:
        type: string
    get:
      tags:
      - HTTP Server Zones
      summary: Return status of an HTTP server zone
      description: Returns status of a particular HTTP server zone.
      operationId: getHttpServerZone
      parameters:
      - name: fields
        in: query
        description: Limits which fields of the server zone will be output.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxHTTPServerZone'
        '404':
          description: 'Server zone not found (*ServerZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
    delete:
      tags:
      - HTTP Server Zones
      summary: 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*)

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
        '405':
          description: Method disabled (*MethodDisabled*)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
components:
  schemas:
    NginxHTTPServerZone:
      title: HTTP Server Zone
      type: object
      properties:
        processing:
          type: integer
          description: The number of client requests that are currently being processed.
        requests:
          type: integer
          description: The total number of client requests received from clients.
        responses:
          description: The total number of responses sent to clients, the number of responses with status codes “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”, “<code>4xx</code>”, and “<code>5xx</code>”, and the number of responses per each status code.
          type: object
          readOnly: true
          properties:
            1xx:
              type: integer
              description: The number of responses with “<code>1xx</code>” status codes.
              readOnly: true
            2xx:
              type: integer
              description: The number of responses with “<code>2xx</code>” status codes.
              readOnly: true
            3xx:
              type: integer
              description: The number of responses with “<code>3xx</code>” status codes.
              readOnly: true
            4xx:
              type: integer
              description: The number of responses with “<code>4xx</code>” status codes.
              readOnly: true
            5xx:
              type: integer
              description: The number of responses with “<code>5xx</code>” status codes.
              readOnly: true
            codes:
              type: object
              description: The number of responses per each status code.
              readOnly: true
              properties:
                codeNumber:
                  type: integer
                  description: The number of responses with this particular status code.
                  readOnly: true
            total:
              type: integer
              description: The total number of responses sent to clients.
              readOnly: true
        discarded:
          type: integer
          description: The total number of requests completed without sending a response.
        received:
          type: integer
          description: The total number of bytes received from clients.
        sent:
          type: integer
          description: The total number of bytes sent to clients.
        ssl:
          type: object
          readOnly: true
          properties:
            handshakes:
              type: integer
              description: The total number of successful SSL handshakes.
              readOnly: true
            handshakes_failed:
              type: integer
              description: The total number of failed SSL handshakes.
              readOnly: true
            session_reuses:
              type: integer
              description: The total number of session reuses during SSL handshake.
              readOnly: true
            no_common_protocol:
              type: integer
              description: The number of SSL handshakes failed because of no common protocol.
            no_common_cipher:
              type: integer
              description: The number of SSL handshakes failed because of no shared cipher.
            handshake_timeout:
              type: integer
              description: The number of SSL handshakes failed because of a timeout.
            peer_rejected_cert:
              type: integer
              description: The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message.
            verify_failures:
              type: object
              description: SSL certificate verification errors
              properties:
                no_cert:
                  type: integer
                  description: A client did not provide the required certificate.
                expired_cert:
                  type: integer
                  description: An expired or not yet valid certificate was presented by a client.
                revoked_cert:
                  type: integer
                  description: A revoked certificate was presented by a client.
                other:
                  type: integer
                  description: Other SSL certificate verification errors.
      example:
        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
    NginxHTTPServerZonesMap:
      title: HTTP Server Zones
      description: 'Status data for all HTTP

        <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">status zones</a>.

        '
      type: object
      additionalProperties:
        $ref: '#/components/schemas/NginxHTTPServerZone'
      example:
        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
    NginxError:
      title: Error
      description: 'nginx error object.

        '
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              description: HTTP error code.
            text:
              type: string
              description: Error description.
            code:
              type: string
              description: Internal nginx error code.
        request_id:
          type: string
          description: The ID of the request, equals the value of the <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</a> variable.
        href:
          type: string
          description: Link to reference documentation.