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

NGINX HTTP Upstreams API

The HTTP Upstreams API from NGINX — 4 operation(s) for http upstreams.

NGINX HTTP 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 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.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.

HTTP Upstreams 8
GET
/http/upstreams/
NGINX Return Status of All HTTP Upstream Server Groups
getHttpUpstreams 1 param → 200404
GET
/http/upstreams/{httpUpstreamName}/
NGINX Return Status of an HTTP Upstream Server Group
getHttpUpstreamName 2 params → 200400404
DELETE
/http/upstreams/{httpUpstreamName}/
NGINX Reset Statistics of an HTTP Upstream Server Group
deleteHttpUpstreamStat 1 param → 204400404405
GET
/http/upstreams/{httpUpstreamName}/servers/
NGINX Return Configuration of All Servers in an HTTP Upstream Server Group
getHttpUpstreamServers 1 param → 200400404
POST
/http/upstreams/{httpUpstreamName}/servers/
NGINX Add a Server to an HTTP Upstream Server Group
postHttpUpstreamServer 1 param body → 201400404405409415
GET
/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}
NGINX Return Configuration of a Server in an HTTP Upstream Server Group
getHttpUpstreamPeer 2 params → 200400404
PATCH
/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}
NGINX Modify a Server in an HTTP Upstream Server Group
patchHttpUpstreamPeer 2 params body → 200400404405415
DELETE
/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}
NGINX Remove a Server from an HTTP Upstream Server Group
deleteHttpUpstreamServer 2 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.
NginxHTTPUpstream
object
5 properties
NginxHTTPUpstreamConfServer
object
Dynamically configurable parameters of an HTTP upstream server :
14 properties
NginxHTTPUpstreamPeerMap
array
An array of HTTP upstream servers .
NginxHTTPUpstreamPeer
object
22 properties
NginxError
object
nginx error object.
3 properties
NginxHTTPUpstreamMap
object
Status information of all HTTP dynamically configurable groups .

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs NGINX publishes across the network.

NGINX Ingress Controller
NGINX Gateway Fabric
NGINX Agent
NGINX Connections API
NGINX General Info 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
Where this information came from

This is an independent, third-party profile of NGINX HTTP 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.