🟢 Nginx One API
Instance discovery, WAF integration, and service mesh connectivity. Subscription lifecycle and configuration synchronization.
- Category: Platform
- Complexity: simple
- Paths: 13 | Schemas: 59
- Tier: Advanced
- Related domains:
marketplace
Use Cases
Section titled “Use Cases”- Manage NGINX One platform integrations
- Configure NGINX Plus instances
- Integrate NGINX configuration management
Primary Resources
Section titled “Primary Resources”- nginx_config: NGINX configuration for proxy settings
- nginx_upstream: NGINX upstream for backend server pools
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| GET | /api/config/namespaces/{namespace}/nginx_csgs | List NGINX One CSG Object configuration. |
| GET | /api/config/namespaces/{namespace}/nginx_csgs/{name} | GET Request. |
| GET | /api/config/namespaces/{namespace}/nginx_instances | List NGINX One Instance Object configuration. |
| GET | /api/config/namespaces/{namespace}/nginx_instances/{name} | GET Request. |
| POST | /api/config/namespaces/{namespace}/nginx_dataplane_servers | GET NGINX One Dataplane Servers. |
| GET | /api/config/namespaces/{namespace}/nginx_servers | List NGINX One Server APIs. |
| GET | /api/config/namespaces/{namespace}/nginx_servers/{name} | GET Request. |
| POST | /api/nginx/one/namespaces/system/n1/subscribe | Subscribe to NGINX One. |
| POST | /api/nginx/one/namespaces/system/n1/unsubscribe | Unsubscribe to NGINX One. |
| POST | /api/config/namespaces/{metadata.namespace}/nginx_service_discoverys | Create NGINX Service Discovery. |
| PUT | /api/config/namespaces/{metadata.namespace}/nginx_service_discoverys/{metadata.name} | Replace NGINX Service Discovery. |
| GET | /api/config/namespaces/{namespace}/nginx_service_discoverys | List NGINX Service Discovery. |
| GET | /api/config/namespaces/{namespace}/nginx_service_discoverys/{name} | GET NGINX Service Discovery. |
| DELETE | /api/config/namespaces/{namespace}/nginx_service_discoverys/{name} | DELETE NGINX Service Discovery. |