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 Workers API

The Workers API from NGINX — 2 operation(s) for workers.

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

Tagged areas include Workers. 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 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 0.8.

4 operations 2 paths 3 schemas 2 DELETE2 GET

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 2 paths, the API surfaces 4 operations — 2 DELETE, 2 GET. Each is listed below with its method, path, parameters, and response codes.

Workers 4
GET
/workers/
NGINX Return Statistics for All Worker Processes
getWorkers 1 param → 200404
DELETE
/workers/
NGINX Reset Statistics for All Worker Processes
deleteWorkersStat → 204404405
GET
/workers/{workerId}
NGINX Return Status of a Worker Process
getWorker 2 params → 200404
DELETE
/workers/{workerId}
NGINX Reset Statistics for a Worker Process
deleteWorkerStat 1 param → 204404405

Schemas 3

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

NginxWorkersMap
object
nginx worker processes object.
NginxWorker
object
Statistics per each worker process.
4 properties
NginxError
object
nginx error object.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nginx-workers-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