NGINX

NGINX Status API

The Status API from NGINX — 1 operation(s) for status.

GitHub OpenAPI

Operations 1

GET /stub_status NGINX Retrieve Stub Status Metrics #

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-status-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-status-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-status-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NGINX Stub Status API
  description: Provides access to basic NGINX status information via the ngx_http_stub_status_module. The module must be compiled with --with-http_stub_status_module and enabled in the server or location context with the stub_status directive.
  version: '1.0'
  x-generated-from: documentation
servers:
- url: http://localhost
  description: Local NGINX instance
tags:
- name: Status
paths:
  /stub_status:
    get:
      operationId: getStubStatus
      summary: NGINX Retrieve Stub Status Metrics
      description: Returns plain-text status information including active connections, cumulative accepts/handled/requests counters, and current reading/writing/waiting connection counts.
      tags:
      - Status
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Plain-text status output
          content:
            text/plain:
              schema:
                type: string
                description: 'Multi-line plain text. Line 1: "Active connections: <n>". Line 2: header "server accepts handled requests". Line 3: three space-separated integers (accepts, handled, requests). Line 4: "Reading: <n> Writing: <n> Waiting: <n>".'
                example: "Active connections: 291\nserver accepts handled requests\n 16630948 16630948 31070465\nReading: 6 Writing: 179 Waiting: 106"
              examples:
                getStubStatus200Example:
                  value: "Active connections: 291\nserver accepts handled requests\n 16630948 16630948 31070465\nReading: 6 Writing: 179 Waiting: 106"
                  x-microcks-default: true