NGINX Method GET API
The Method GET API from NGINX — 41 operation(s) for method get.
NGINX Method GET 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 GET. 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 41 operations across 41 paths, and defines 47 schemas. It is described by OpenAPI 3.0.3, at version 0.8.
41 operations
41 paths
47 schemas
41 GET
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 41
Across 41 paths, the API surfaces 41 operations — 41 GET. Each is listed below with its method, path, parameters, and response codes.
Method GET 41
GET
/
NGINX Return List of Root Endpoints
GET
/nginx
NGINX Return Status of NGINX Running Instance
GET
/processes
NGINX Return NGINX Processes Status
GET
/connections
NGINX Return Client Connections Statistics
GET
/slabs/
NGINX Return Status of All Slabs
GET
/slabs/{slabZoneName}
NGINX Return Status of a Slab
GET
/http/
NGINX Return List of HTTP-Related Endpoints
GET
/http/requests
NGINX Return HTTP Requests Statistics
GET
/http/server_zones/
NGINX Return Status of All HTTP Server Zones
GET
/http/server_zones/{httpServerZoneName}
NGINX Return Status of an HTTP Server Zone
GET
/http/location_zones/
NGINX Return Status of All HTTP Location Zones
GET
/http/location_zones/{httpLocationZoneName}
NGINX Return Status of an HTTP Location Zone
GET
/http/caches/
NGINX Return Status of All Caches
GET
/http/caches/{httpCacheZoneName}
NGINX Return Status of a Cache
GET
/http/limit_conns/
NGINX Return Status of All HTTP Limitconn Zones
GET
/http/limit_conns/{httpLimitConnZoneName}
NGINX Return Status of an HTTP Limitconn Zone
GET
/http/limit_reqs/
NGINX Return Status of All HTTP Limitreq Zones
GET
/http/limit_reqs/{httpLimitReqZoneName}
NGINX Return Status of an HTTP Limitreq Zone
GET
/http/upstreams/
NGINX Return Status of All HTTP Upstream Server Groups
GET
/http/upstreams/{httpUpstreamName}/
NGINX Return Status of an HTTP Upstream Server Group
GET
/http/upstreams/{httpUpstreamName}/servers/
NGINX Return Configuration of All Servers in an HTTP Upstream Server Group
GET
/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}
NGINX Return Configuration of a Server in an HTTP Upstream Server Group
GET
/http/keyvals/
NGINX Return Key-Value Pairs from All HTTP Keyval Zones
GET
/http/keyvals/{httpKeyvalZoneName}
NGINX Return Key-Value Pairs from an HTTP Keyval Zone
GET
/stream/server_zones/
NGINX Return Status of All Stream Server Zones
GET
/stream/server_zones/{streamServerZoneName}
NGINX Return Status of a Stream Server Zone
GET
/stream/limit_conns/
NGINX Return Status of All Stream Limitconn Zones
GET
/stream/limit_conns/{streamLimitConnZoneName}
NGINX Return Status of an Stream Limitconn Zone
GET
/stream/upstreams/
NGINX Return Status of All Stream Upstream Server Groups
GET
/stream/upstreams/{streamUpstreamName}/
NGINX Return Status of a Stream Upstream Server Group
GET
/stream/upstreams/{streamUpstreamName}/servers/
NGINX Return Configuration of All Servers in a Stream Upstream Server Group
GET
/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}
NGINX Return Configuration of a Server in a Stream Upstream Server Group
GET
/stream/keyvals/
NGINX Return Key-Value Pairs from All Stream Keyval Zones
GET
/stream/keyvals/{streamKeyvalZoneName}
NGINX Return Key-Value Pairs from a Stream Keyval Zone
GET
/stream/zone_sync/
NGINX Return Sync Status of a Node
GET
/resolvers/
NGINX Return Status for All Resolver Zones
GET
/resolvers/{resolverZoneName}
NGINX Return Statistics of a Resolver Zone
GET
/ssl
NGINX Return SSL Statistics
GET
/license
NGINX Return License Info
GET
/workers/
NGINX Return Statistics for All Worker Processes
GET
/workers/{workerId}
NGINX Return Status of a Worker Process
Schemas 47
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are NginxStreamUpstreamPeer (22 properties), NginxHTTPUpstreamPeer (22 properties), NginxHTTPUpstreamConfServer (14 properties), NginxStreamUpstreamConfServer (12 properties). Each schema is shown below with its type and property counts.
ArrayOfStrings
array
An array of strings.
NginxConnections
object
The number of accepted, dropped, active, and idle connections.
4 properties
NginxSlabZone
object
Shared memory zone with slab allocator
2 properties
NginxHTTPLimitReqZonesMap
object
Status data for all HTTP limitreq zones .
NginxSlabZoneSlot
object
4 properties
NginxLicenseObject
object
License and usage reporting status of NGINX Plus instance.
3 properties
NginxStreamLimitConnZonesMap
object
Status data for all stream limitconn zones .
NginxHTTPCachesMap
object
Status information of all HTTP caches configured by proxycachepath and other “ cachepath ” directives.
NginxSlabZoneMap
object
Status zones that use slab allocator.
NginxStreamUpstreamConfServer
object
Dynamically configurable parameters of a stream upstream server :
12 properties
NginxHTTPLocationZonesMap
object
Status data for all HTTP location zones .
NginxStreamZoneSync
object
2 properties
NginxHTTPRequests
object
2 properties
NginxHTTPLimitReqZone
object
5 properties
NginxStreamServerZone
object
7 properties
NginxSSLObject
object
8 properties
NginxProcesses
object
1 property
NginxObject
object
General information about nginx:
8 properties
NginxStreamUpstreamPeerMap
array
Array of stream upstream servers.
NginxHTTPServerZone
object
7 properties
NginxHTTPServerZonesMap
object
Status data for all HTTP status zones .
NginxHTTPKeyvalZonesMap
object
Contents of all HTTP keyval shared memory zones.
NginxHTTPUpstreamConfServerMap
array
An array of HTTP upstream servers for dynamic configuration.
NginxStreamUpstream
object
3 properties
NginxStreamKeyvalZonesMap
object
Contents of all stream keyval shared memory zones.
NginxHTTPUpstreamPeerMap
array
An array of HTTP upstream servers .
NginxStreamZoneSyncZone
object
Synchronization status of a shared memory zone.
2 properties
NginxStreamKeyvalZone
object
Contents of a stream keyval shared memory zone when using the GET method.
NginxStreamUpstreamMap
object
Status information of stream upstream server groups.
NginxError
object
nginx error object.
3 properties
NginxResolverZone
object
Statistics of DNS requests and responses per particular resolver zone .
2 properties
NginxStreamUpstreamConfServerMap
array
An array of stream upstream servers for dynamic configuration.
NginxHTTPCache
object
10 properties
NginxStreamUpstreamPeer
object
22 properties
NginxWorker
object
Statistics per each worker process.
4 properties
NginxWorkersMap
object
nginx worker processes object.
NginxHTTPLimitConnZone
object
3 properties
NginxStreamServerZonesMap
object
Status information for all stream status zones .
NginxResolverZonesMap
object
Status data for all resolver zones .
NginxHTTPUpstreamConfServer
object
Dynamically configurable parameters of an HTTP upstream server :
14 properties
NginxStreamLimitConnZone
object
3 properties
NginxHTTPLimitConnZonesMap
object
Status data for all HTTP limitconn zones .
NginxHTTPLocationZone
object
5 properties
NginxHTTPKeyvalZone
object
Contents of an HTTP keyval shared memory zone when using the GET method.
NginxHTTPUpstreamMap
object
Status information of all HTTP dynamically configurable groups .
NginxHTTPUpstreamPeer
object
22 properties
NginxHTTPUpstream
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NGINX 12
Other APIs NGINX publishes across the network.
NGINX
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
#Method GET