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

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

NGINX Stream Keyvals 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 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.2.0, at version 9.0.

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

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.2.0
API Version
9.0
Server
/api/9
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 1 param body → 201400404405409413415
PATCH
/stream/keyvals/{streamKeyvalZoneName}
NGINX Modify a Key-Value or Delete a Key
patchStreamKeyvalZoneKeyValue 1 param body → 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.
NginxStreamKeyvalZonePostPatch
object
Contents of a stream keyval shared memory zone when using the POST or PATCH methods.
NginxStreamKeyvalZonesMap
object
Contents of all stream keyval shared memory zones.
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
Where this information came from

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