Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NGINX Status API

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

NGINX Status API is one of 32 APIs that NGINX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Status. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, a getting-started guide, and a GitHub repository.

This API exposes 1 operation across 1 path. It is described by OpenAPI 3.0.3, at version 0.8.

1 operations 1 paths 0 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.8
Contact
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Status 1
GET
/stub_status
NGINX Retrieve Stub Status Metrics
getStubStatus → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nginx-status-api-openapi.yml Raw ↑

Other APIs NGINX publishes across the network.

NGINX Ingress Controller
NGINX Gateway Fabric
NGINX Agent
NGINX Connections API
NGINX General Info API
NGINX HTTP API
NGINX HTTP Caches API
NGINX HTTP Keyvals API
NGINX HTTP Limit Conns API
NGINX HTTP Limit Reqs API
NGINX HTTP Location Zones API