NGINX

NGINX Stream Server Zones API

The Stream Server Zones API from NGINX — 2 operation(s) for stream server zones.

GitHub OpenAPI

Operations 3

GET /stream/server_zones/ NGINX Return Status of All Stream Server Zones #
GET /stream/server_zones/{streamServerZoneName} NGINX Return Status of a Stream Server Zone #
DELETE /stream/server_zones/{streamServerZoneName} NGINX Reset Statistics for a Stream Server Zone #

Documentation

📖
Documentation
https://nginx.org/en/docs/http/ngx_http_api_module.html
📖
APIReference
https://nginx.org/en/docs/http/ngx_http_api_module.html#api
📖
Documentation
https://nginx.org/en/docs/http/ngx_http_stub_status_module.html
📖
Documentation
https://nginx.org/en/docs/njs/
📖
APIReference
https://nginx.org/en/docs/njs/reference.html
📖
GettingStarted
https://nginx.org/en/docs/njs/install.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/openapi/nginx-stream-server-zones-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/nginx/njs

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-ld/nginx-plus-http-api-context.jsonld
🔗
SDKs
https://github.com/nginx/nginx-plus-go-client
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-ld/nginx-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nginx-stream-server-zones-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nginx-stream-server-zones-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '9.0'
  title: NGINX Plus REST Stream Server Zones 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).
servers:
- url: /api/9
tags:
- name: Stream Server Zones
paths:
  /stream/server_zones/:
    get:
      tags:
      - Stream Server Zones
      summary: NGINX Return Status of All Stream Server Zones
      description: Returns status information for each stream [server zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone).
      operationId: getStreamServerZones
      parameters:
      - name: fields
        in: query
        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: ''
        schema:
          type: string
      responses:
        '200':
          description: Success
          x-microcks-refs:
          - name: getStreamServerZones200Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxStreamServerZonesMap'
              example:
                mysql-frontend:
                  processing: 2
                  connections: 270925
                  sessions:
                    2xx: 155564
                    4xx: 0
                    5xx: 0
                    total: 270925
                  discarded: 0
                  received: 28988975
                  sent: 3879346317
                  ssl:
                    handshakes: 76455
                    handshakes_failed: 432
                    session_reuses: 28770
                    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
                dns:
                  processing: 1
                  connections: 155569
                  sessions:
                    2xx: 155564
                    4xx: 0
                    5xx: 0
                    total: 155569
                  discarded: 0
                  received: 4200363
                  sent: 20489184
                  ssl:
                    handshakes: 2040
                    handshakes_failed: 23
                    session_reuses: 65
                    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
        '404':
          description: Unknown version (*UnknownVersion*)
          x-microcks-refs:
          - name: getStreamServerZones404Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /stream/server_zones/{streamServerZoneName}:
    parameters:
    - name: streamServerZoneName
      in: path
      description: The name of a stream server zone.
      required: true
      x-example: example_streamServerZoneName
      schema:
        type: string
    get:
      tags:
      - Stream Server Zones
      summary: NGINX Return Status of a Stream Server Zone
      description: Returns status of a particular stream server zone.
      operationId: getStreamServerZone
      parameters:
      - name: fields
        in: query
        description: Limits which fields of the server zone will be output.
        x-example: ''
        schema:
          type: string
      responses:
        '200':
          description: Success
          x-microcks-refs:
          - name: getStreamServerZone200Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxStreamServerZone'
              example:
                dns:
                  processing: 1
                  connections: 155569
                  sessions:
                    2xx: 155564
                    4xx: 0
                    5xx: 0
                    total: 155569
                  discarded: 0
                  received: 4200363
                  sent: 20489184
                  ssl:
                    handshakes: 76455
                    handshakes_failed: 432
                    session_reuses: 28770
                    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
        '404':
          description: 'Server zone not found (*ServerZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          x-microcks-refs:
          - name: getStreamServerZone404Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Stream Server Zones
      summary: NGINX Reset Statistics for a Stream Server Zone
      description: Resets statistics of accepted and discarded connections, sessions, received and sent bytes, counters of SSL handshakes and session reuses in a particular stream server zone.
      operationId: deleteStreamServerZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'Server zone not found (*ServerZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          x-microcks-refs:
          - name: deleteStreamServerZoneStat404Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
        '405':
          description: Method disabled (*MethodDisabled*)
          x-microcks-refs:
          - name: deleteStreamServerZoneStat405Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    NginxStreamServerZone:
      title: Stream Server Zone
      type: object
      properties:
        processing:
          type: integer
          description: The number of client connections that are currently being processed.
          example: 1
        connections:
          type: integer
          description: The total number of connections accepted from clients.
          example: 0
        sessions:
          type: object
          description: The total number of completed sessions, and the number of sessions completed with status codes “<code>2xx</code>”, “<code>4xx</code>”, or “<code>5xx</code>”.
          properties:
            2xx:
              type: integer
              description: The total number of sessions completed with <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a> “<code>2xx</code>”.
              example: 0
            4xx:
              type: integer
              description: The total number of sessions completed with <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a> “<code>4xx</code>”.
              example: 0
            5xx:
              type: integer
              description: The total number of sessions completed with <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a> “<code>5xx</code>”.
              example: 0
            total:
              type: integer
              description: The total number of completed client sessions.
              example: 98765
          example: {}
        discarded:
          type: integer
          description: The total number of connections completed without creating a session.
          example: 0
        received:
          type: integer
          description: The total number of bytes received from clients.
          example: 180157219
        sent:
          type: integer
          description: The total number of bytes sent to clients.
          example: 20183175459
        ssl:
          type: object
          readOnly: true
          properties:
            handshakes:
              type: integer
              description: The total number of successful SSL handshakes.
              readOnly: true
              example: 79572
            handshakes_failed:
              type: integer
              description: The total number of failed SSL handshakes.
              readOnly: true
              example: 21025
            session_reuses:
              type: integer
              description: The total number of session reuses during SSL handshake.
              readOnly: true
              example: 15762
            no_common_protocol:
              type: integer
              description: The number of SSL handshakes failed because of no common protocol.
              example: 4
            no_common_cipher:
              type: integer
              description: The number of SSL handshakes failed because of no shared cipher.
              example: 2
            handshake_timeout:
              type: integer
              description: The number of SSL handshakes failed because of a timeout.
              example: 0
            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.
              example: 0
            verify_failures:
              type: object
              description: SSL certificate verification errors
              properties:
                no_cert:
                  type: integer
                  description: A client did not provide the required certificate.
                  example: 0
                expired_cert:
                  type: integer
                  description: An expired or not yet valid certificate was presented by a client.
                  example: 2
                revoked_cert:
                  type: integer
                  description: A revoked certificate was presented by a client.
                  example: 1
                other:
                  type: integer
                  description: Other SSL certificate verification errors.
                  example: 1
              example: {}
          example: {}
      example:
        dns:
          processing: 1
          connections: 155569
          sessions:
            2xx: 155564
            4xx: 0
            5xx: 0
            total: 155569
          discarded: 0
          received: 4200363
          sent: 20489184
          ssl:
            handshakes: 76455
            handshakes_failed: 432
            session_reuses: 28770
            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
    NginxError:
      title: Error
      description: 'nginx error object.

        '
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              description: HTTP error code.
              example: 200
            text:
              type: string
              description: Error description.
              example: example-text
            code:
              type: string
              description: Internal nginx error code.
              example: 200
          example: {}
        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.
          example: example-request_id
        href:
          type: string
          description: Link to reference documentation.
          example: example-href
    NginxStreamServerZonesMap:
      title: Stream Server Zones
      description: 'Status information for all stream

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

        '
      type: object
      additionalProperties:
        $ref: '#/components/schemas/NginxStreamServerZone'
      example:
        mysql-frontend:
          processing: 2
          connections: 270925
          sessions:
            2xx: 155564
            4xx: 0
            5xx: 0
            total: 270925
          discarded: 0
          received: 28988975
          sent: 3879346317
          ssl:
            handshakes: 76455
            handshakes_failed: 432
            session_reuses: 28770
            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
        dns:
          processing: 1
          connections: 155569
          sessions:
            2xx: 155564
            4xx: 0
            5xx: 0
            total: 155569
          discarded: 0
          received: 4200363
          sent: 20489184
          ssl:
            handshakes: 2040
            handshakes_failed: 23
            session_reuses: 65
            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