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 General Info API

The General Info API from NGINX — 2 operation(s) for general info.

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

Tagged areas include General Info. 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 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 0.8.

2 operations 2 paths 3 schemas 2 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 2

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

General Info 2
GET
/
NGINX Return List of Root Endpoints
getAPIEndpoints → 200404
GET
/nginx
NGINX Return Status of NGINX Running Instance
getNginx 1 param → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are NginxObject (8 properties), NginxError (3 properties). Each schema is shown below with its type and property counts.

NginxObject
object
General information about nginx:
8 properties
ArrayOfStrings
array
An array of strings.
NginxError
object
nginx error object.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nginx-general-info-api-openapi.yml Raw ↑

Other APIs NGINX publishes across the network.

NGINX Ingress Controller
NGINX Gateway Fabric
NGINX Agent
NGINX Connections 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
NGINX HTTP Requests API