API Reference
Explore the F5 Distributed Cloud API with interactive documentation powered by Scalar. Each domain includes a Try It console for testing API calls directly from your browser.
Security
Section titled βSecurityβ π Api Interface definitions, schema validation, and grouping. β 45 paths, 303 schemas, advanced
π Blindfold Secret encryption, key policies, and audit trails. β 27 paths, 178 schemas, moderate
π¦ Bot And Threat Defense Bot detection, threat categories, and defense instances. β 19 paths, 79 schemas, moderate
π Certificates SSL/TLS chains, trusted CAs, and revocation lists. β 16 paths, 80 schemas, moderate
π Data And Privacy Security PII detection, data types, and regional compliance. β 11 paths, 71 schemas, simple
π Ddos Volumetric attack mitigation and traffic scrubbing. β 60 paths, 257 schemas, advanced
π Network Security NAT policies, firewalls, and segment connections. β 61 paths, 402 schemas, advanced
π¨ Secops And Incident Response Threat detection, user risk scoring, and automated blocking. β 4 paths, 33 schemas, simple
π Shape Bot defense, fraud prevention, and client integrity. β 271 paths, 841 schemas, advanced
β οΈ Threat Campaign Attack detection, tracking, and mitigation rules. β 1 paths, 178 schemas, moderate
Networking
Section titled βNetworkingβ π Cdn Content delivery and edge caching networks. β 29 paths, 634 schemas, advanced
π Dns Authoritative zones and record management. β 45 paths, 251 schemas, advanced
π Network BGP peering, IPsec tunnels, and segment policies. β 81 paths, 485 schemas, advanced
β±οΈ Rate Limiting Request throttling, quotas, and policer rules. β 12 paths, 73 schemas, simple
βοΈ Virtual HTTP, TCP, UDP load balancing with origin pools. β 133 paths, 978 schemas, advanced
Infrastructure
Section titled βInfrastructureβ π§ Ce Management Network interfaces, fleets, and site registration. β 28 paths, 240 schemas, advanced
βοΈ Cloud Infrastructure AWS, Azure, GCP connectors and VPC attachments. β 31 paths, 231 schemas, advanced
π¦ Container Services Containerized workloads and virtual Kubernetes clusters. β 13 paths, 166 schemas, moderate
βοΈ Managed Kubernetes Cluster RBAC, pod security, and container registries. β 20 paths, 104 schemas, moderate
πΈοΈ Service Mesh Microservice routing and sidecar configuration. β 38 paths, 283 schemas, advanced
π Sites Cloud and edge node deployments. β 133 paths, 1093 schemas, advanced
Platform
Section titled βPlatformβ π₯οΈ Admin Console And Ui Static UI components and console assets. β 2 paths, 16 schemas, simple
π Authentication Identity provider and access policy configuration. β 14 paths, 42 schemas, simple
π’ Bigip iRules, data groups, and APM integration. β 29 paths, 267 schemas, advanced
π³ Billing And Usage Subscription plans, payment methods, and quotas. β 25 paths, 108 schemas, moderate
πͺ Marketplace Add-on services, connectors, and TPM policies. β 36 paths, 200 schemas, moderate
π’ Nginx One NGINX Plus instances and dataplane servers. β 13 paths, 63 schemas, simple
ποΈ Object Storage Mobile SDK assets, versioned binaries, and app shield files. β 9 paths, 18 schemas, simple
πͺͺ Tenant And Identity User profiles, sessions, and OTP settings. β 178 paths, 522 schemas, advanced
π₯ Users Account tokens, labels, and cloud-init config. β 13 paths, 56 schemas, simple
π₯οΈ Vpm And Node Management Node lifecycle, fleet grouping, and orchestration. β 1 paths, 2 schemas, simple
Operations
Section titled βOperationsβ π§ Data Intelligence Classification, insights, and policy management. β 15 paths, 77 schemas, moderate
π Observability Synthetic health checks and DNS resolution validation. β 56 paths, 224 schemas, advanced
π Statistics Alerts, logs, flow analytics, and reporting. β 77 paths, 627 schemas, advanced
π« Support Tickets, escalations, and network diagnostics. β 53 paths, 171 schemas, moderate
π Telemetry And Insights Metrics collection, analysis, and visualization. β 27 paths, 187 schemas, moderate
π€ Ai Services (Preview) AI assistant queries and feedback collection. β 11 paths, 66 schemas, simple
π Other Other β 10 paths, 89 schemas, moderate