How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NGINX

NGINX Stream Upstreams API

The Stream Upstreams API from NGINX — 4 operation(s) for stream upstreams.

Documentation Provider Profile APIs.io OpenAPI GitHub

NGINX Stream Upstreams API is one of 28 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.2.0, at version 9.0.

Requests are made against a single base URL, /api/9.

8 operations 4 paths 7 schemas 2 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
9.0
Server
/api/9
Resource Areas
1

Paths & Operations 8

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
getStreamUpstreams 1 param → 200404
GET
/stream/upstreams/{streamUpstreamName}/
NGINX Return Status of a Stream Upstream Server Group
getStreamUpstream 2 params → 200400404
DELETE
/stream/upstreams/{streamUpstreamName}/
NGINX Reset Statistics of a Stream Upstream Server Group
deleteStreamUpstreamStat 1 param → 204400404405
GET
/stream/upstreams/{streamUpstreamName}/servers/
NGINX Return Configuration of All Servers in a Stream Upstream Server Group
getStreamUpstreamServers 1 param → 200400404
POST
/stream/upstreams/{streamUpstreamName}/servers/
NGINX Add a Server to a Stream Upstream Server Group
postStreamUpstreamServer 1 param body → 201400404405409415
GET
/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}
NGINX Return Configuration of a Server in a Stream Upstream Server Group
getStreamUpstreamServer 2 params → 200400404
PATCH
/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}
NGINX Modify a Server in a Stream Upstream Server Group
patchStreamUpstreamServer 2 params body → 200400404405415
DELETE
/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}
NGINX Remove a Server from a Stream Upstream Server Group
deleteStreamUpstreamServer 2 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.

NginxStreamUpstream
object
3 properties
NginxStreamUpstreamMap
object
Status information of stream upstream server groups.
NginxStreamUpstreamPeer
object
22 properties
NginxStreamUpstreamConfServer
object
Dynamically configurable parameters of a stream upstream server :
12 properties
NginxStreamUpstreamPeerMap
array
Array of stream upstream servers.
NginxStreamUpstreamConfServerMap
array
An array of stream upstream servers for dynamic configuration.
NginxError
object
nginx error object.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nginx-stream-upstreams-api-openapi.yml Raw ↑

Other APIs NGINX publishes across the network.

NGINX
AE Profile APIs.io
NGINX Ingress Controller
AE Profile APIs.io
NGINX Gateway Fabric
AE Profile APIs.io
NGINX Agent
AE Profile APIs.io
NGINX Connections API
AE Profile APIs.io
NGINX General Info API
AE Profile APIs.io
NGINX HTTP API
AE Profile APIs.io
NGINX HTTP Caches API
AE Profile APIs.io
NGINX HTTP Keyvals API
AE Profile APIs.io
NGINX HTTP Limit Conns API
AE Profile APIs.io
NGINX HTTP Limit Reqs API
AE Profile APIs.io
NGINX HTTP Location Zones API
AE Profile APIs.io
#Stream Upstreams
← Back to N APIs
API Details
ID
nginx:nginx-stream-upstreams-api
Server
/api/9
Docs
https://nginx.org/
Provider
NGINX
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=nginx-stream-upstreams-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/nginx-stream-upstreams-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NGINX Stream Upstreams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.