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

The Connections API from NGINX — 1 operation(s) for connections.

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

Tagged areas include Connections. 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 2 operations across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 0.8.

2 operations 1 paths 2 schemas 1 DELETE1 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 2

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

Connections 2
GET
/connections
NGINX Return Client Connections Statistics
getConnections 1 param → 200404
DELETE
/connections
NGINX Reset Client Connections Statistics
deleteConnections → 204404405

Schemas 2

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

NginxConnections
object
The number of accepted, dropped, active, and idle connections.
4 properties
NginxError
object
nginx error object.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nginx-connections-api-openapi.yml Raw ↑

Other APIs NGINX publishes across the network.

NGINX Ingress Controller
NGINX Gateway Fabric
NGINX Agent
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
NGINX HTTP Requests API