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 Stream Keyvals API

The Stream Keyvals API from NGINX — 2 operation(s) for stream keyvals.

NGINX Stream Keyvals 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 Keyvals. 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 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 0.8.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST

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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Stream Keyvals 5
GET
/stream/keyvals/
NGINX Return Key-Value Pairs from All Stream Keyval Zones
getStreamKeyvalZones 1 param → 200404
GET
/stream/keyvals/{streamKeyvalZoneName}
NGINX Return Key-Value Pairs from a Stream Keyval Zone
getStreamKeyvalZoneKeysValues 2 params → 200404
POST
/stream/keyvals/{streamKeyvalZoneName}
NGINX Add a Key-Value Pair to the Stream Keyval Zone
postStreamKeyvalZoneData 2 params → 201400404405409413415
PATCH
/stream/keyvals/{streamKeyvalZoneName}
NGINX Modify a Key-Value or Delete a Key
patchStreamKeyvalZoneKeyValue 2 params → 204400404405413415
DELETE
/stream/keyvals/{streamKeyvalZoneName}
NGINX Empty the Stream Keyval Zone
deleteStreamKeyvalZoneData 1 param → 204404405

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed is NginxError (3 properties). Each schema is shown below with its type and property counts.

NginxStreamKeyvalZone
object
Contents of a stream keyval shared memory zone when using the GET method.
NginxStreamKeyvalZonesMap
object
Contents of all stream keyval shared memory zones.
NginxStreamKeyvalZonePostPatch
object
Contents of a stream 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-stream-keyvals-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