API Reference

The following APIs are supported and can be used with BIG-IQ 8.0.0.

NOTE: Before calling an API that depends upon deviceReference to reference a BIG-IP, first use the Device Reference Helper API to get the correct deviceReference value.

Access APIs

• Access Deploy Configuration Task
• Access Policy
• Access Profile
• Access Simplified Workflow
• Access Simplified Workflow Container
• Active Directory Server
• BIG-IQ APM OAuth Token Revocation on BIG-IP
• Client Rate Classes
• Client Traffic Classifiers
• Connectivity Profile
• CRLDP Server
• Device Discovery for Import
• HTTP Server
• IPV4 Lease Pools
• IPV6 Lease Pools
• Kerberos Key Tab File
• Kerberos Server
• Kill Active Access Sessions
• LDAP Server
• Network Access
• Network Access Optimized App Properties
• Ping Access Profile
• Profile Server SSL
• Radius Server
• Rewrite Profile
• SAML Artifact Resolution Services
• SecurID Config File
• SecurID Server
• SNAT Pools
• TACACS+ Server
• User Defined ACL
• VDI Profile
• Virtual Server
• Virtual Server Profile

ADC APIs

• Device Discovery for LTM/ADC Management
• GRE Tunnel Profile
• LTM/ADC Pool Member Management
• LTM/ADC Self-Service Task (enable/disable pool member)
• LTM Application Server Node
• LTM Profile Client-SSL
• LTM Profile Server-SSL
• LTM Virtual Server
• SSL Certificates
• SSL Certificate Revocation Lists
• SSL Certificate Signing Requests
• SSL Keys
• SSL Object Management
• VLAN Group Management
• VLAN Group State

Analytics APIs

• All Security List
• Analytics Entities
• Analytics Reports
• Applications Analytics and Health
• Application Services Analytics and Health
• Application Services Summary
• Applications Summary
• Current DDoS Attacks on BIG-IPs
• DDoS Attacks List
• DDoS Attacks per BIG-IP
• DDoS Protected Objects
• DDoS Protection Summary
• DNS Application Service Summary
• DNS DDoS Attack Summary
• Events Query
• HTTP Application Service Summary
• HTTP DDoS Attack Summary
• HTTP Traffic Query
• Metrics Query
• Network DDoS Attack Summary
• Service Scaling Group BIG-IP List
• Service Scaling Group List
• TCP Application Service Summary
• Virtual Server DDoS Attacks List
• Virtual Server Dos Protection Summary

Application APIs

• Application Deploy
• Application Device Resolver
• Application Force-Delete
• Application Move/Merge
• AS3 Declare
• AS3 Template
• Legacy Application Service

ASM APIs

• ASM Policies
• ASM Policy Analyzer
• ASM Policy Analyzer Rules
• ASM Policy Analyzer Suggestions
• ASM Policy Difference
• ASM Signatures
• Discovery for Web Application Security (ASM) Management

Authentication Token APIs

• Auth Token by Exchange
• Auth Token by Login
• User
• User Role

Certificate Authority APIs

• CA Configuration
• CA Provider List
• Let’s Encrypt Authenticate
• Let’s Encrypt Challenge Content
• Let’s Encrypt Directory
• Let’s Encrypt Domain Configuration
• Let’s Encrypt Request Certificate
• Venafi Authenticate
• Venafi Configuration
• Venafi Generate CSR
• Venafi Policy Data
• Venafi Request Certificate
• Venafi Sync Certificate

Cloud Edition APIs

• Alert Rules
• Applications
• Apply Template
• Cloud Environments
• Cloud Providers
• Create BIG-IP VE
• Declarative Onboarding
• Delete BIG-IP VE
• Service Catalog Template
• Service Scaling Groups
• Workflow Rules

Configuration APIs

• Auto Conflict Policy
• Certificate Expiration Alerts
• Configuration Deployment
• Configuration Import
• Configuration Restore
• Configuration Snapshot
• File Downloads
• File Uploads

Device APIs

• IP Pools
• Device Discovery
• Device Establish Trust
• Device Import
• Device Reference Helper
• Device RMA
• Device Remove Trust
• Device Templates
• Device Trust
• MachineId Resolver

DNS APIs

• DNS Data Center
• DNS iRule
• DNS Pool A
• DNS Pool AAAA
• DNS Pool CNAME
• DNS Pool Member A
• DNS Pool Member AAAA
• DNS Pool Member CNAME
• DNS Pool Member MX
• DNS Pool Member NAPR
• DNS Pool Member SRV
• DNS Pool MX
• DNS Pool NAPTR
• DNS Pool SRV
• DNS Region
• DNS Self Service
• DNS Server
• DNS Server Device
• DNS Topology
• DNS Virtual Server
• DNS Wide IP A
• DNS Wide IP AAAA
• DNS Wide IP CNAME
• DNS Wide IP MX
• DNS Wide IP NAPTR
• DNS Wide IP SRV

Firewall APIs

• Centralized Management Firewall Rule Order
• Discovery for Firewall Management
• Firewall Contexts
• Firewall Deploy Configuration Task
• Firewall Policy

FPS APIs

• Alert Transform Rules
• FPS Accounts
• Alert Forwarding Rules

GeoIP APIs

• GeoIP Config
• GeoIP DB File
• GeoIP Register Update
• GeoIP Update Manager

HA APIs

• HA Add Peer
• HA Failover State
• HA Promote
• HA Remove Standby
• HA Reset

License APIs

• License Assign/Revoke
• License Initial Activation
• Purchased Pool Licenses
• Purchased Pool License Members
• RegKey Pool
• RegKey Pool Offerings
• RegKey Pool Members
• Skip Licensing
• Utility Billing Report Task

SSLO APIs

• SSLO Unified
• 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