F5 BIG-IQ API¶
Welcome to the F5® BIG-IQ™ API page. The BIG-IQ 7.0.0 API is a well-documented REST API that provides a range of capabilities for scripting BIG-IQ workflows. Many BIG-IQ users may choose to script BIG-IQ workflows using public APIs to help make the deployment and management of applications on the BIG-IP system easier. For example, an application manager can use the BIG-IQ Public API in scripts to monitor, troubleshoot, modify, and largely manage their application throughout its lifecycle.
F5 supports the use of the BIG-IQ APIs as discussed in this documentation and also in the F5 Python SDK. BIG-IQ 7.0.0 includes new APIs to help you deploy, configure, and maintain F5’s BIG-IP. Unless the documentation states otherwise, the APIs introduced in BIG-IQ 6.0.1 and earlier versions, should continue to work with BIG-IQ 7.0.0 as before. Any of the BIG-IQ APIs may change and work differently in the future, unless described explicitly as stable APIs guaranteed not to change in the future.
These APIs follow the Representational State Transfer (REST) model for both public and private consumption. The REST model uses the web architecture of HTTP and the concept of exchanging resource state.
- Alert Forwarding Rules
- Analytics Entities
- AS3 Declare
- AS3 Deploy
- AS3 Force-Delete
- AS3 Move/Merge
- Create BIG-IP VE
- Current DDoS Attacks on BIG-IPs
- Current DDoS Attacks on Protected Objects
- DDoS Attacks List
- DDoS Attacks per BIG-IP
- DDoS Attacks per Protected Object
- Declarative Onboarding
- Delete BIG-IP VE
- Device RMA
- DNS DDoS Attacks
- Dos Attacks Summary
- Events Query
- File Downloads
- File Uploads
- FPS Accounts
- GRE Tunnel Profile
- HA Add Peer
- HA Failover State
- HA Promote
- HA Remove Standby
- HA Reset
- HTTP DDoS Attacks Summary
- HTTP Traffic Query
- Metrics Query
- Network DDoS Attacks Summary
- SSL Object Management
- Service Scaling Group BIG-IP List
- Service Scaling Group List
- SSLO Devices List
- SSLO Devices Summary
- SSLO Overview Summary
- SSLO Per Device Summary
- SSLO Per Service Summary
- SSLO Per Topology Summary
- SSLO Services List
- SSLO Services Summary
- SSLO Topologies List
- SSLO Topologies Summary
- VLAN Group Management
- VLAN Group State
- Alert Rules
- All Applications Analytics and Health
- AS3 Template
- Auth Token by Exchange
- Auth Token by Login
- Cloud Environments
- Device Discovery for Import
- File Downloads
- File Uploads
- License Assign/Revoke
- License Initial Activation
- Purchased Pool Licenses
- Purchased Pool License Members
- RegKey Pool
- RegKey Pool Offerings
- RegKey Pool Members