Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NGINX Method PATCH API

The Method PATCH API from NGINX — 4 operation(s) for method patch.

NGINX Method PATCH API is one of 32 APIs that NGINX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Method PATCH. 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 4 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 0.8.

4 operations 4 paths 5 schemas 4 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.8
Contact
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 PATCH. Each is listed below with its method, path, parameters, and response codes.

Method PATCH 4
PATCH
/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}
NGINX Modify a Server in an HTTP Upstream Server Group
patchHttpUpstreamPeer 3 params → 200400404405415
PATCH
/http/keyvals/{httpKeyvalZoneName}
NGINX Modify a Key-Value or Delete a Key
patchHttpKeyvalZoneKeyValue 2 params → 204400404405413415
PATCH
/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}
NGINX Modify a Server in a Stream Upstream Server Group
patchStreamUpstreamServer 3 params → 200400404405415
PATCH
/stream/keyvals/{streamKeyvalZoneName}
NGINX Modify a Key-Value or Delete a Key
patchStreamKeyvalZoneKeyValue 2 params → 204400404405413415

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are NginxHTTPUpstreamConfServer (14 properties), NginxStreamUpstreamConfServer (12 properties), NginxError (3 properties). Each schema is shown below with its type and property counts.

NginxStreamKeyvalZonePostPatch
object
Contents of a stream keyval shared memory zone when using the POST or PATCH methods.
NginxHTTPUpstreamConfServer
object
Dynamically configurable parameters of an HTTP upstream server :
14 properties
NginxStreamUpstreamConfServer
object
Dynamically configurable parameters of a stream upstream server :
12 properties
NginxHTTPKeyvalZonePostPatch
object
Contents of an HTTP keyval shared memory zone when using the POST or PATCH methods.
NginxError
object
nginx error object.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nginx-method-patch-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