NGINX

NGINX Stream Upstreams API

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

GitHub OpenAPI

Operations 8

GET /stream/upstreams/ NGINX Return Status of All Stream Upstream Server Groups #
GET /stream/upstreams/{streamUpstreamName}/ NGINX Return Status of a Stream Upstream Server Group #
DELETE /stream/upstreams/{streamUpstreamName}/ NGINX Reset Statistics of a Stream Upstream Server Group #
GET /stream/upstreams/{streamUpstreamName}/servers/ NGINX Return Configuration of All Servers in a Stream Upstream Server Group #
POST /stream/upstreams/{streamUpstreamName}/servers/ NGINX Add a Server to a Stream Upstream Server Group #
GET /stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId} NGINX Return Configuration of a Server in a Stream Upstream Server Group #
PATCH /stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId} NGINX Modify a Server in a Stream Upstream Server Group #
DELETE /stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId} NGINX Remove a Server from a Stream Upstream Server Group #

Documentation

📖
Documentation
https://nginx.org/en/docs/http/ngx_http_api_module.html
📖
APIReference
https://nginx.org/en/docs/http/ngx_http_api_module.html#api
📖
Documentation
https://nginx.org/en/docs/http/ngx_http_stub_status_module.html
📖
Documentation
https://nginx.org/en/docs/njs/
📖
APIReference
https://nginx.org/en/docs/njs/reference.html
📖
GettingStarted
https://nginx.org/en/docs/njs/install.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/openapi/nginx-stream-upstreams-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/nginx/njs

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-ld/nginx-plus-http-api-context.jsonld
🔗
SDKs
https://github.com/nginx/nginx-plus-go-client
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-ld/nginx-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nginx-stream-upstreams-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

nginx-stream-upstreams-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '9.0'
  title: NGINX Plus REST Stream Upstreams API
  description: NGINX Plus REST API provides access to NGINX Plus status information, on-the-fly configuration of upstream servers and key-value pairs management for http and stream.
servers:
- url: /api/9
tags:


# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/openapi/nginx-stream-upstreams-api-openapi.yml