# F5 NGINX Plus API

**Canonical:** https://apis.io/apis/f5/f5-nginx-plus-api/  
**Provider:** F5 — https://apis.io/providers/f5/  
**Base URL:** https://{{nginx_host}}/api  
**Documentation:** https://docs.nginx.com/nginx/

F5 NGINX Plus API is one of 22 APIs that [F5](https://apis.io/providers/f5/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Dynamic Configuration, Load Balancing, Monitoring, NGINX, and Reverse Proxy. The published artifact set on APIs.io includes API documentation, an API reference, and a getting-started guide.

REST API for NGINX Plus providing real-time live activity monitoring, dynamic upstream configuration, key-value store management, and server health statistics without requiring configuration reloads.

## Operations (60 of 71)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | Return list of root endpoints |
| GET | `/nginx` | Return status of nginx running instance |
| GET | `/processes` | Return nginx processes status |
| DELETE | `/processes` | Reset nginx processes statistics |
| GET | `/connections` | Return client connections statistics |
| DELETE | `/connections` | Reset client connections statistics |
| GET | `/slabs/` | Return status of all slabs |
| GET | `/slabs/{slabZoneName}` | Return status of a slab |
| DELETE | `/slabs/{slabZoneName}` | Reset slab statistics |
| GET | `/http/` | Return list of HTTP-related endpoints |
| GET | `/http/requests` | Return HTTP requests statistics |
| DELETE | `/http/requests` | Reset HTTP requests statistics |
| GET | `/http/server_zones/` | Return status of all HTTP server zones |
| GET | `/http/server_zones/{httpServerZoneName}` | Return status of an HTTP server zone |
| DELETE | `/http/server_zones/{httpServerZoneName}` | Reset statistics for an HTTP server zone |
| GET | `/http/location_zones/` | Return status of all HTTP location zones |
| GET | `/http/location_zones/{httpLocationZoneName}` | Return status of an HTTP location zone |
| DELETE | `/http/location_zones/{httpLocationZoneName}` | Reset statistics for a location zone. |
| GET | `/http/caches/` | Return status of all caches |
| GET | `/http/caches/{httpCacheZoneName}` | Return status of a cache |
| DELETE | `/http/caches/{httpCacheZoneName}` | Reset cache statistics |
| GET | `/http/limit_conns/` | Return status of all HTTP limit_conn zones |
| GET | `/http/limit_conns/{httpLimitConnZoneName}` | Return status of an HTTP limit_conn zone |
| DELETE | `/http/limit_conns/{httpLimitConnZoneName}` | Reset statistics for an HTTP limit_conn zone |
| GET | `/http/limit_reqs/` | Return status of all HTTP limit_req zones |
| GET | `/http/limit_reqs/{httpLimitReqZoneName}` | Return status of an HTTP limit_req zone |
| DELETE | `/http/limit_reqs/{httpLimitReqZoneName}` | Reset statistics for an HTTP limit_req zone |
| GET | `/http/upstreams/` | Return status of all HTTP upstream server groups |
| GET | `/http/upstreams/{httpUpstreamName}/` | Return status of an HTTP upstream server group |
| DELETE | `/http/upstreams/{httpUpstreamName}/` | Reset statistics of an HTTP upstream server group |
| GET | `/http/upstreams/{httpUpstreamName}/servers/` | Return configuration of all servers in an HTTP upstream server group |
| POST | `/http/upstreams/{httpUpstreamName}/servers/` | Add a server to an HTTP upstream server group |
| GET | `/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}` | Return configuration of a server in an HTTP upstream server group |
| PATCH | `/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}` | Modify a server in an HTTP upstream server group |
| DELETE | `/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}` | Remove a server from an HTTP upstream server group |
| GET | `/http/keyvals/` | Return key-value pairs from all HTTP keyval zones |
| GET | `/http/keyvals/{httpKeyvalZoneName}` | Return key-value pairs from an HTTP keyval zone |
| POST | `/http/keyvals/{httpKeyvalZoneName}` | Add a key-value pair to the HTTP keyval zone |
| PATCH | `/http/keyvals/{httpKeyvalZoneName}` | Modify a key-value or delete a key |
| DELETE | `/http/keyvals/{httpKeyvalZoneName}` | Empty the HTTP keyval zone |
| GET | `/stream/` | Return list of stream-related endpoints |
| GET | `/stream/server_zones/` | Return status of all stream server zones |
| GET | `/stream/server_zones/{streamServerZoneName}` | Return status of a stream server zone |
| DELETE | `/stream/server_zones/{streamServerZoneName}` | Reset statistics for a stream server zone |
| GET | `/stream/limit_conns/` | Return status of all stream limit_conn zones |
| GET | `/stream/limit_conns/{streamLimitConnZoneName}` | Return status of an stream limit_conn zone |
| DELETE | `/stream/limit_conns/{streamLimitConnZoneName}` | Reset statistics for a stream limit_conn zone |
| GET | `/stream/upstreams/` | Return status of all stream upstream server groups |
| GET | `/stream/upstreams/{streamUpstreamName}/` | Return status of a stream upstream server group |
| DELETE | `/stream/upstreams/{streamUpstreamName}/` | Reset statistics of a stream upstream server group |
| GET | `/stream/upstreams/{streamUpstreamName}/servers/` | Return configuration of all servers in a stream upstream server group |
| POST | `/stream/upstreams/{streamUpstreamName}/servers/` | Add a server to a stream upstream server group |
| GET | `/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}` | Return configuration of a server in a stream upstream server group |
| PATCH | `/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}` | Modify a server in a stream upstream server group |
| DELETE | `/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}` | Remove a server from a stream upstream server group |
| GET | `/stream/keyvals/` | Return key-value pairs from all stream keyval zones |
| GET | `/stream/keyvals/{streamKeyvalZoneName}` | Return key-value pairs from a stream keyval zone |
| POST | `/stream/keyvals/{streamKeyvalZoneName}` | Add a key-value pair to the stream keyval zone |
| PATCH | `/stream/keyvals/{streamKeyvalZoneName}` | Modify a key-value or delete a key |
| DELETE | `/stream/keyvals/{streamKeyvalZoneName}` | Empty the stream keyval zone |

…and 11 more operations. They are listed in full on the page.

## Machine-readable artifacts (3)

- **Documentation** — https://docs.nginx.com/nginx/
- **APIReference** — https://docs.nginx.com/nginx/admin-guide/monitoring/live-activity-monitoring/
- **GettingStarted** — https://docs.nginx.com/nginx/admin-guide/load-balancer/dynamic-configuration-api/

## Other F5 APIs (12)

- [F5 BIG-IP](https://apis.io/apis/f5/f5-big-ip/)
- [F5 NGINX](https://apis.io/apis/f5/f5-nginx/)
- [F5 Distributed Cloud Services](https://apis.io/apis/f5/f5-distributed-cloud/)
- [F5 BIG-IP iControl REST (Mgmt)](https://apis.io/apis/f5/f5-mgmt-api/)
- [F5 BIG-IP AS3 (Application Services 3 Extension)](https://apis.io/apis/f5/f5-big-ip-as3/)
- [F5 BIG-IP Application Services Templates (FAST)](https://apis.io/apis/f5/f5-big-ip-fast/)
- [F5 BIG-IP Declarative Onboarding](https://apis.io/apis/f5/f5-big-ip-declarative-onboarding/)
- [F5 NGINX Management Suite API](https://apis.io/apis/f5/f5-nginx-management-suite-api/)
- [F5 Essential App Protect API](https://apis.io/apis/f5/f5-essential-app-protect-api/)
- [F5 BIG-IQ Centralized Management API](https://apis.io/apis/f5/f5-big-iq-centralized-management-api/)
- [F5 BIG-IP Application Services 3 Extension API](https://apis.io/apis/f5/f5-big-ip-application-services-3-extension-api/)
- [F5 Declarative Onboarding API](https://apis.io/apis/f5/f5-declarative-onboarding-api/)

## Tags

Dynamic Configuration, Load Balancing, Monitoring, NGINX, Reverse Proxy

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/f5/f5-nginx-plus-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/f5/.