NGINX HTTP Upstreams API is one of 32 APIs that NGINX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include HTTP Upstreams. 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
8 operations
across 4 paths,
and defines 7 schemas.
It is described by OpenAPI 3.0.3, at version 0.8.
8 operations4 paths7 schemas2 DELETE4 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Across 4 paths, the API surfaces 8 operations — 2 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
HTTP Upstreams 8
GET
/http/upstreams/
NGINX Return Status of All HTTP Upstream Server Groups
getHttpUpstreams1 param→ 200404
GET
/http/upstreams/{httpUpstreamName}/
NGINX Return Status of an HTTP Upstream Server Group
getHttpUpstreamName2 params→ 200400404
DELETE
/http/upstreams/{httpUpstreamName}/
NGINX Reset Statistics of an HTTP Upstream Server Group
deleteHttpUpstreamStat1 param→ 204400404405
GET
/http/upstreams/{httpUpstreamName}/servers/
NGINX Return Configuration of All Servers in an HTTP Upstream Server Group
getHttpUpstreamServers1 param→ 200400404
POST
/http/upstreams/{httpUpstreamName}/servers/
NGINX Add a Server to an HTTP Upstream Server Group
NGINX Remove a Server from an HTTP Upstream Server Group
deleteHttpUpstreamServer2 params→ 200400404405
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are NginxHTTPUpstreamPeer (22 properties), NginxHTTPUpstreamConfServer (14 properties), NginxHTTPUpstream (5 properties), NginxError (3 properties). Each schema is shown below with its type and property counts.
NginxHTTPUpstreamConfServerMap
array
An array of HTTP upstream servers for dynamic configuration.
NginxHTTPUpstreamPeerMap
array
An array of HTTP upstream servers .
NginxHTTPUpstreamConfServer
object
Dynamically configurable parameters of an HTTP upstream server :
14 properties
NginxError
object
nginx error object.
3 properties
NginxHTTPUpstreamMap
object
Status information of all HTTP dynamically configurable groups .
NginxHTTPUpstreamPeer
object
22 properties
NginxHTTPUpstream
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
