Stream Server Zone

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-schema/plus-http-api-nginx-stream-server-zone-schema.json",
  "title": "Stream Server Zone",
  "description": "NginxStreamServerZone schema from NGINX Plus REST API",
  "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 \u201c<code>2xx</code>\u201d, \u201c<code>4xx</code>\u201d, or \u201c<code>5xx</code>\u201d.",
      "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> \u201c<code>2xx</code>\u201d.",
          "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> \u201c<code>4xx</code>\u201d.",
          "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> \u201c<code>5xx</code>\u201d.",
          "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
        }
      }
    }
  }
}