NGINX Docs
    • DevCentral

      Connect & learn in our hosted community

    • MyF5

      Your key to everything F5, including support, registration keys, and subscriptions

    • NGINX

      Learn more about NGINX Open Source and read the community blog

  1. Home
  2. F5 NGINX Controller
  3. API Reference
  4. Platform API

NGINX ONE

  • NGINX One Console
  • NGINX Plus
  • NGINX Instance Manager
  • NGINX Ingress Controller
  • NGINX Gateway Fabric
  • NGINX Open Source
  • Subscription Licensing & Solutions
  • NGINX Agent

NGINX APP PROTECT

  • NGINX App Protect WAF
  • NGINX App Protect DoS

NGINX AS A SERVICE

  • NGINX as a Service for Azure

NGINX OTHER

  • NGINX Unit
      • NGINX Controller Tech Specs
      • Download the NGINX Plus Cert and Key Bundle
      • Trial NGINX Controller with NGINX Plus
      • Trial NGINX Controller with App Security
      • Install NGINX Controller
      • Install NGINX Controller Agent
      • Install NGINX Controller on RHEL 8 (experimental)
      • Update NGINX Controller Settings with helper.sh
      • Install NGINX Controller Agent for Non-root Users
      • Manage the NGINX Controller Agent Service
      • Deploy NGINX Controller as a Resilient Cluster on a Private Cloud
      • Deploy NGINX Controller as a Resilient Cluster on AWS
      • Using NGINX App Protect WAF with NGINX Controller
      • Get to Know the F5 NGINX Controller Agent
      • Configure the NGINX Controller Agent
      • Set up Metrics Collection
      • Use the NGINX Controller Agent with Docker
      • Back Up & Restore Cluster Config and Encryption Keys
      • Back Up & Restore an Embedded Config Database
      • Back Up & Restore an External Config Database
      • Back Up & Restore the Analytics Database
      • About Alerts
      • Manage Alerts
      • Manage Registered Email Addresses
      • ServiceNow Alerts Integration
      • Analytics Overview
      • Create Custom Dashboards
      • Understanding the Application Health Score
      • How To Use the Data Explorer
      • Forward Analytics Data to Datadog
      • Forward Analytics Data to Splunk
      • Forward Analytics Events to Syslog
      • Forward Analytics Metrics to OpenTelemetry Collector
      • View Events
      • Overview: Metrics and Metadata
      • Using the Metrics API
      • Overview: Traffic Metrics
      • View Traffic Metrics
      • NGINX Controller Dimensions Catalog
      • NGINX Controller Metrics Catalog
    • View App Security Analytics
      • Manage Your NGINX Instances
      • Manage Containerized Instances
      • Add an NGINX App Protect Instance
      • Add an AWS NGINX Instance
      • Add a vSphere NGINX Instance
      • Add an Azure NGINX Instance
      • Set Up Data Plane High Availability
      • Manage Your Instance Templates
      • View Performance Reports for Your Instances
      • View System Metrics Graphs
    • Manage Locations
    • Get to Know NGINX Controller
    • License NGINX Controller
    • Look Up Version Information
      • Configure Active Directory Integration
      • Manage Users
      • Manage Roles and Role Groups
    • Manage Your Cluster
      • AWS Integration
      • BIG-IP Integration
      • Datadog Integration
      • OTLP Integration
      • Syslog Integration
      • Splunk Integration
      • Changing the IP address
    • Set Up NGINX Controller Services
    • Manage Environments
    • Manage Certs
    • Manage Gateways
    • Learn About Policies
    • Manage Identity Providers
    • About Application Delivery
        • About App Security
        • Default WAF Policy
        • Bring Your Own WAF Policy
        • App Security Metrics
        • Extend App Security with Snippets
        • Manage App Security
        • Set Up App Security Monitor Mode
        • Manage WAF Tuning for App Components
        • Using RBAC with the App Security Add-On
        • View App Security Analytics
    • About Caching
    • About Snippets
    • Manage Apps & Components
    • Deploy a Simple Application
    • Manage Your APIs
    • Manage Developer Portals
    • API Overview
    • Analytics API
    • ADC API
    • APIM API
    • Platform API
    • Where to Go for Support
    • Troubleshoot NGINX Controller and the Controller Agent
    • Troubleshoot Data Forwarders
    • NGINX Controller v3.0.0–3.18.3
      • Release Notes 3.22.9
      • Release Notes 3.22.8
      • Release Notes 3.22.7
      • Release Notes 3.22.6
      • Release Notes 3.22.5
      • Release Notes 3.22.4
      • Release Notes 3.22.3
      • Release Notes 3.22.2
      • Release Notes 3.22.1
      • Release Notes 3.22.0
      • Release Notes 3.21.0
      • Release Notes 3.20.1
      • Release Notes 3.20.0
      • Release Notes 3.19.6
      • Release Notes 3.19.5
      • Release Notes 3.19.4
      • Release Notes 3.19.3
      • Release Notes 3.19.2
      • Release Notes 3.19.1
      • Release Notes 3.19.0
      • Release Notes 3.18.1
      • Release Notes 3.18.0

F5 NGINX Controller F5 NGINX Controller

  • Admin Guides
    • Installation
    • NGINX Controller Tech Specs
    • Download the NGINX Plus Cert and Key Bundle
    • Trial NGINX Controller with NGINX Plus
    • Trial NGINX Controller with App Security
    • Install NGINX Controller
    • Install NGINX Controller Agent
    • Install NGINX Controller on RHEL 8 (experimental)
    • Update NGINX Controller Settings with helper.sh
    • Install NGINX Controller Agent for Non-root Users
    • Manage the NGINX Controller Agent Service
    • Deploy NGINX Controller as a Resilient Cluster on a Private Cloud
    • Deploy NGINX Controller as a Resilient Cluster on AWS
    • Using NGINX App Protect WAF with NGINX Controller
    • Configure NGINX Controller Agent
    • Get to Know the F5 NGINX Controller Agent
    • Configure the NGINX Controller Agent
    • Set up Metrics Collection
    • Use the NGINX Controller Agent with Docker
    • Back Up & Restore
    • Back Up & Restore Cluster Config and Encryption Keys
    • Back Up & Restore an Embedded Config Database
    • Back Up & Restore an External Config Database
    • Back Up & Restore the Analytics Database
  • Analytics
    • Alerts
    • About Alerts
    • Manage Alerts
    • Manage Registered Email Addresses
    • ServiceNow Alerts Integration
    • Dashboards
    • Analytics Overview
    • Create Custom Dashboards
    • Understanding the Application Health Score
    • Data Explorer
    • How To Use the Data Explorer
    • Data Forwarders
    • Forward Analytics Data to Datadog
    • Forward Analytics Data to Splunk
    • Forward Analytics Events to Syslog
    • Forward Analytics Metrics to OpenTelemetry Collector
    • Events
    • View Events
    • Metrics
    • Overview: Metrics and Metadata
    • Using the Metrics API
    • Overview: Traffic Metrics
    • View Traffic Metrics
    • Catalogs Reference
    • NGINX Controller Dimensions Catalog
    • NGINX Controller Metrics Catalog
      • View App Security Analytics
  • Infrastructure
    • Instance Management
    • Manage Your NGINX Instances
    • Manage Containerized Instances
    • Add an NGINX App Protect Instance
    • Add an AWS NGINX Instance
    • Add a vSphere NGINX Instance
    • Add an Azure NGINX Instance
    • Set Up Data Plane High Availability
    • Manage Your Instance Templates
    • View Performance Reports for Your Instances
    • View System Metrics Graphs
      • Manage Locations
  • Platform
      • Get to Know NGINX Controller
      • License NGINX Controller
      • Look Up Version Information
    • Access Management
    • Configure Active Directory Integration
    • Manage Users
    • Manage Roles and Role Groups
      • Manage Your Cluster
    • Integrations
    • AWS Integration
    • BIG-IP Integration
    • Datadog Integration
    • OTLP Integration
    • Syslog Integration
    • Splunk Integration
    • Maintenance
    • Changing the IP address
  • Services
      • Set Up NGINX Controller Services
      • Manage Environments
      • Manage Certs
      • Manage Gateways
      • Learn About Policies
      • Manage Identity Providers
  • Application Delivery
      • About Application Delivery
    • App Security
    • Learn About App Security
    • About App Security
    • Default WAF Policy
    • Bring Your Own WAF Policy
    • App Security Metrics
    • Extend App Security with Snippets
    • Manage App Security
    • Manage App Security
    • Set Up App Security Monitor Mode
    • Manage WAF Tuning for App Components
    • Using RBAC with the App Security Add-On
    • View App Security Analytics
      • About Caching
      • About Snippets
      • Manage Apps & Components
      • Deploy a Simple Application
  • API Management
      • Manage Your APIs
      • Manage Developer Portals
  • API Reference
      • API Overview
      • Analytics API
      • ADC API
      • APIM API
      • Platform API
  • Support
      • Where to Go for Support
      • Troubleshoot NGINX Controller and the Controller Agent
      • Troubleshoot Data Forwarders
  • Releases
      • NGINX Controller v3.0.0–3.18.3
    • NGINX Controller Application Delivery Module
    • Release Notes 3.22.9
    • Release Notes 3.22.8
    • Release Notes 3.22.7
    • Release Notes 3.22.6
    • Release Notes 3.22.5
    • Release Notes 3.22.4
    • Release Notes 3.22.3
    • Release Notes 3.22.2
    • Release Notes 3.22.1
    • Release Notes 3.22.0
    • Release Notes 3.21.0
    • Release Notes 3.20.1
    • Release Notes 3.20.0
    • NGINX Controller API Management Module
    • Release Notes 3.19.6
    • Release Notes 3.19.5
    • Release Notes 3.19.4
    • Release Notes 3.19.3
    • Release Notes 3.19.2
    • Release Notes 3.19.1
    • Release Notes 3.19.0
    • Release Notes 3.18.1
    • Release Notes 3.18.0
  1. Home
  2. F5 NGINX Controller
  3. API Reference
  4. Platform API
Company
  • About F5 NGINX
  • Events

Resources
  • Blog
  • FAQ
  • Professional Services
  • Training
Products
  • F5 NGINX One
  • F5 NGINX Plus
  • F5 NGINX App Protect
  • F5 NGINX Instance Manager
  • F5 NGINX Ingress Controller
  • F5 NGINX Gateway Fabric
  • F5 NGINXaaS for Azure
NGINX on GitHub
  • NGINX Open Source
  • NGINX Unit
  • NGINX Amplify
  • NGINX Agent
  • NGINX Kubernetes Ingress Controller
  • NGINX Gateway Fabric
Social

F5 logo ©2025 F5, Inc. All rights reserved.

Trademarks Policies Open Source Components Privacy California Privacy Do Not Sell My Personal Information

F5 logo

©2025 F5, Inc. All rights reserved. NGINX is a registered trademark of F5, Inc.

Trademarks Policies Privacy California Privacy Do Not Sell My Personal Information