NGINX Stream 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 Stream 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.
Stream Upstreams 8
GET
/stream/upstreams/
NGINX Return Status of All Stream Upstream Server Groups
getStreamUpstreams1 param→ 200404
GET
/stream/upstreams/{streamUpstreamName}/
NGINX Return Status of a Stream Upstream Server Group
getStreamUpstream2 params→ 200400404
DELETE
/stream/upstreams/{streamUpstreamName}/
NGINX Reset Statistics of a Stream Upstream Server Group
deleteStreamUpstreamStat1 param→ 204400404405
GET
/stream/upstreams/{streamUpstreamName}/servers/
NGINX Return Configuration of All Servers in a Stream Upstream Server Group
getStreamUpstreamServers1 param→ 200400404
POST
/stream/upstreams/{streamUpstreamName}/servers/
NGINX Add a Server to a Stream Upstream Server Group
NGINX Remove a Server from a Stream Upstream Server Group
deleteStreamUpstreamServer2 params→ 200400404405
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are NginxStreamUpstreamPeer (22 properties), NginxStreamUpstreamConfServer (12 properties), NginxError (3 properties), NginxStreamUpstream (3 properties). Each schema is shown below with its type and property counts.
NginxStreamUpstreamPeer
object
22 properties
NginxStreamUpstream
object
3 properties
NginxStreamUpstreamConfServer
object
Dynamically configurable parameters of a stream upstream server :
12 properties
NginxStreamUpstreamMap
object
Status information of stream upstream server groups.
NginxError
object
nginx error object.
3 properties
NginxStreamUpstreamPeerMap
array
Array of stream upstream servers.
NginxStreamUpstreamConfServerMap
array
An array of stream upstream servers for dynamic configuration.
Specification
The full machine-readable OpenAPI contract behind this narrative.
