NGINX

NGINX SSL API

The SSL API from NGINX — 1 operation(s) for ssl.

GitHub OpenAPI

Operations 2

GET /ssl NGINX Return SSL Statistics #
DELETE /ssl NGINX Reset SSL Statistics #

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-ssl-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-ssl-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-ssl-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '9.0'
  title: NGINX Plus REST SSL 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: SSL
paths:
  /ssl:
    get:
      tags:
      - SSL
      summary: NGINX Return SSL Statistics
      description: Returns SSL statistics.
      operationId: getSsl
      responses:
        '200':
          description: Success
          x-microcks-refs:
          - name: getSsl200Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxSSLObject'
              example:
                handshakes: 79572
                handshakes_failed: 21025
                session_reuses: 15762
                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
        '404':
          description: Unknown version (*UnknownVersion*)
          x-microcks-refs:
          - name: getSsl404Example
            x-microcks-default: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
              example:
                error: {}
                request_id: example-request_id
                href: example-href
      parameters:
      - in: query
        name: fields
        description: Limits which fields of SSL statistics will be output.
        x-example: ''
        schema:
          type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - SSL
      summary: NGINX Reset SSL Statistics
      description: Resets counters of SSL handshakes and session reuses.
      operationId: deleteSslStat
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          x-microcks-refs:
          - name: deleteSslStat404Example
            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: deleteSslStat405Example
            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:
    NginxSSLObject:
      title: SSL
      type: object
      properties:
        handshakes:
          type: integer
          description: The total number of successful SSL handshakes.
          example: 79572
        handshakes_failed:
          type: integer
          description: The total number of failed SSL handshakes.
          example: 21025
        session_reuses:
          type: integer
          description: The total number of session reuses during SSL handshake.
          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
            hostname_mismatch:
              type: integer
              description: Server's certificate doesn't match the hostname.
              example: 2
            other:
              type: integer
              description: Other SSL certificate verification errors.
              example: 1
          example: {}
      example:
        handshakes: 79572
        handshakes_failed: 21025
        session_reuses: 15762
        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.
              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