F5 is a global company that specializes in application delivery and security solutions for businesses. They provide products and services that help organizations efficiently and securely deliver applications to users across any network or cloud environment. F5's solutions are designed to optimize the performance, availability, and security of applications, ensuring a seamless user experience. The F5 portfolio includes BIG-IP for high-performance app and API delivery, NGINX for cloud-native delivery and security across modern apps and Kubernetes, and F5 Distributed Cloud Services for SaaS-based delivery, security, and networking across multicloud environments.
F5 publishes 51 API contracts indexed on the APIs.io network, including BIG-IP iControl REST (Mgmt), Networks Nodes API, Networks Pool Members API, and 48 more. Tagged areas include Application, Security, Load Balancing, API Gateway, and WAF.
The F5 catalog on APIs.io includes 1 event-driven AsyncAPI specification, 2 JSON-LD contexts, and 1 Spectral governance ruleset.
F5’s developer surface includes signup flow, YouTube channel, authentication, GitHub presence, engineering blog, support, CLI, and 54 more developer resources.
Regulatory Posture applies to this provider. Its tags matched the
Horizontal (data, software, accessibility, platform) regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/f5/"><img src="https://apis.io/badge/f5/card.svg" alt="F5 on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
MCP Server+12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
A2A Agent Card+8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Documented Reversibility+6 pts — a reversal operation in the contract, graded up when a window is documented too
Pagination+5 pts — share of collection GETs (an array, or one wrapped in data/items/results ...) that declare a page/limit/offset/cursor parameter, a Link header or a next/cursor field; na with no collection GETs
Protected Resource Metadata+5 pts — a served /.well-known/oauth-protected-resource carrying `resource` (documented), and naming its authorization_servers (verified)
Agentic Commerce Well-Known Document+5 pts — a parsing /.well-known/ucp.json or acp.json declaring a version and at least one service, OR (0.27) a live x402 payment challenge from _data/x402-adoption.json — `self` when its endpoints are on the provider's own domain, `platform` when they are on a vendor's
3 more unmet checks in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
The Kin Score Market layer reads a provider inside its market:
its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted:
not part of the Kin Score or agent readiness.
Registered MCP server and declares compatibility are report only — not weighted.
Undeclared means we found nothing we can read, so there is no number: we never infer integrations.
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
BIG-IP delivers high-performance application and API delivery with load balancing, API gateway, DNS, and security services. The platform exposes programmable APIs including iCon...
NGINX provides cloud-native delivery and security for modern applications, Kubernetes, and APIs. The NGINX product line includes NGINX Plus, NGINX One, NGINX Ingress Controller,...
F5 Distributed Cloud Services delivers SaaS-based application delivery, security, and networking across multicloud and edge environments. The platform exposes a comprehensive RE...
A partial contract for the BIG-IP iControl REST management tree — 10 paths under /mgmt/tm/ and /mgmt/shared/ covering token login, virtual servers, pools, pool members, nodes, H...
REST API for BIG-IQ Centralized Management providing programmatic control over BIG-IP device management, licensing, monitoring, and analytics across your F5 infrastructure.
Declarative API for automating layer 4-7 application services on BIG-IP using JSON declarations. AS3 enables infrastructure-as-code for application delivery configuration.
Declarative API for automating layer 1-3 BIG-IP onboarding and initial device configuration using JSON declarations, making BIG-IP available on the network and ready for applica...
Declarative API for aggregating, normalizing, and forwarding BIG-IP statistics and events to third-party analytics consumers including Splunk, Azure Log Analytics, AWS CloudWatc...
REST API for NGINX Plus providing real-time live activity monitoring, dynamic upstream configuration, key-value store management, and server health statistics without requiring ...
API for managing and monitoring NGINX instances across environments from a single console, including configuration management, performance metrics, security vulnerability tracki...
Kubernetes Ingress Controller implementation for NGINX and NGINX Plus providing load balancing, SSL/TLS termination, content-based routing, and advanced traffic management for c...
Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.
aid: f5
name: F5
description: F5 is a global company that specializes in application delivery and security solutions for businesses. They provide
products and services that help organizations efficiently and securely deliver applications to users across any network
or cloud environment. F5's solutions are designed to optimize the performance, availability, and security of applications,
ensuring a seamless user experience. The F5 portfolio includes BIG-IP for high-performance app and API delivery, NGINX for
cloud-native delivery and security across modern apps and Kubernetes, and F5 Distributed Cloud Services for SaaS-based delivery,
security, and networking across multicloud environments.
deliveryModel:
model: saas
license_evidence:
not_product:
- f5networks/f5-appsvcs-extension
- f5networks/f5-appsvcs-templates
- f5networks/f5-declarative-onboarding
- f5networks/f5-telemetry-streaming
- nginx/kubernetes-ingress
open_source: unknown
commercial: true
callable_host: false
label: Hosted service · you call their endpoint
confidence: low
source:
- openapi
- pricing
- repository-not-product
generated: '2026-09-25'
method: derived
accessModel:
pricing: freemium
onboarding: self-serve
trial: true
try_now: true
public: false
gated: none
gated_source:
- onboarding
label: Freemium (free trial) · Self-serve signup
confidence: high
source:
- plans
- authentication
- rate-limits
- security
generated: '2026-11-06'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/f5.png
url: https://raw.githubusercontent.com/api-evangelist/f5/refs/heads/main/apis.yml
created: '2025-02-12'
modified: '2026-09-07'
specificationVersion: '0.23'
type: Index
position: Consuming
access: 3rd-Party
tags:
- Application
- Security
- Load Balancing
- API Gateway
- WAF
tags_raw:
- Applications
- Security
- Load Balancing
- API Gateway
- WAF
apis:
- aid: f5:f5-big-ip
name: F5 BIG-IP
description: BIG-IP delivers high-performance application and API delivery with load balancing, API gateway, DNS, and security
services. The platform exposes programmable APIs including iControlREST for configuration and service management, iControl
SOAP for legacy automation, iRules and iRulesLX for data-plane traffic manipulation, and TMSH scripting for control-plane
automation. BIG-IQ provides centralized management for BIG-IP devices through its own well-documented REST API.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- Application
- Security
- Load Balancing
- BIG-IP
tags_raw:
- Applications
- Security
- Load Balancing
- BIG-IP
properties:
- type: Documentation
url: https://clouddocs.f5.com/api/
- type: APIReference
url: https://clouddocs.f5.com/api/icontrol-rest/
- type: Documentation
url: https://clouddocs.f5.com/products/big-iq/mgmt-api/v0.0/
- type: Documentation
url: https://clouddocs.f5.com/api/irules/
- type: GettingStarted
url: https://clouddocs.f5.com/api/iapps/
- aid: f5:f5-nginx
name: F5 NGINX
description: NGINX provides cloud-native delivery and security for modern applications, Kubernetes, and APIs. The NGINX
product line includes NGINX Plus, NGINX One, NGINX Ingress Controller, and NGINX App Protect, with management and automation
capabilities exposed through REST APIs for instance management, configuration, and observability across distributed deployments.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://docs.nginx.com/
baseURL: https://{tenant}.console.ves.volterra.io/api/nginx/one
tags:
- Application
- Kubernetes
- Cloud-Native
- NGINX
tags_raw:
- Applications
- Kubernetes
- Cloud Native
- NGINX
properties:
- type: Documentation
url: https://docs.nginx.com/
- type: APIReference
url: https://docs.nginx.com/nginx/admin-guide/monitoring/live-activity-monitoring/
- type: Documentation
url: https://docs.nginx.com/nginx-one/
- type: GettingStarted
url: https://docs.nginx.com/nginx-instance-manager/
- aid: f5:f5-distributed-cloud
name: F5 Distributed Cloud Services
description: F5 Distributed Cloud Services delivers SaaS-based application delivery, security, and networking across multicloud
and edge environments. The platform exposes a comprehensive REST API for managing tenants, virtual sites, load balancers,
WAF policies, bot defense, API security, DDoS protection, and CDN configurations from a single control plane.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://docs.cloud.f5.com/docs-v2/api/
baseURL: https://{tenant}.console.ves.volterra.io/api
tags:
- Multi-Cloud
- Edge
- Security
- Software-as-a-Service
tags_raw:
- Multicloud
- Edge
- Security
- SaaS
properties:
- type: Documentation
url: https://docs.cloud.f5.com/docs-v2/api/
- type: APIReference
url: https://docs.cloud.f5.com/docs-v2/api
- type: GettingStarted
url: https://docs.cloud.f5.com/docs-v2/platform/concepts
- aid: f5:f5-mgmt-api
name: F5 BIG-IP iControl REST (Mgmt)
description: A partial contract for the BIG-IP iControl REST management tree — 10 paths under /mgmt/tm/ and /mgmt/shared/
covering token login, virtual servers, pools, pool members, nodes, HTTP profiles and system version. iControl REST addresses
the whole TMSH-addressable configuration tree, so this covers a small fraction of the real surface; F5 publishes no complete
OpenAPI for it.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://clouddocs.f5.com/api/icontrol-rest/
baseURL: https://{bigip}/mgmt
tags:
- Mgmt
- BIG-IP
properties:
- type: OpenAPI
url: openapi/f5-mgmt-api-openapi.yml
- type: Documentation
url: https://clouddocs.f5.com/api/icontrol-rest/
- name: F5 NGINX Management Suite API
description: REST API for managing NGINX instances, monitoring performance, and configuring application delivery through
NGINX Management Suite.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://docs.nginx.com/nginx-management-suite/
baseURL: https://{{nms-host}}/api
tags:
- API Gateway
- Application Delivery
- Configuration Management
- Monitoring
- NGINX
properties:
- type: Documentation
url: https://docs.nginx.com/nginx-management-suite/admin-guides/api/
- type: APIReference
url: https://docs.nginx.com/nginx-management-suite/api-reference/
- type: GettingStarted
url: https://docs.nginx.com/nginx-management-suite/getting-started/
contact:
- FN: NGINX Support
email: nginx-support@f5.com
- name: F5 Essential App Protect API
description: API for managing F5's application security services including WAF policies, bot defense, and API protection.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://docs.f5.com/en-us/app-protect
baseURL: https://api.f5.com/app-protect
tags:
- API Protection
- Bot Defense
- DDoS Protection
- Security
- WAF
properties:
- type: Documentation
url: https://docs.f5.com/en-us/app-protect/api-reference
- type: Security
url: https://docs.f5.com/en-us/app-protect/security-policies
- name: F5 BIG-IQ Centralized Management API
description: REST API for BIG-IQ Centralized Management providing programmatic control over BIG-IP device management, licensing,
monitoring, and analytics across your F5 infrastructure.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://clouddocs.f5.com/products/big-iq/mgmt-api/v0.0/
baseURL: https://{{bigiq_host}}/mgmt
tags:
- Analytics
- Centralized Management
- Device Management
- Licensing
- Monitoring
properties:
- type: Documentation
url: https://clouddocs.f5.com/products/big-iq/mgmt-api/v0.0/
- type: APIReference
url: https://clouddocs.f5.com/products/big-iq/mgmt-api/v0.0/ApiReferences/bigiq_public_api_ref/r_public_api_references.html
- type: GettingStarted
url: https://clouddocs.f5.com/products/big-iq/mgmt-api/v0.0/HowToSamples/bigiq_public_api_wf/t_bigiq_public_api_workflows.html
contact:
- FN: F5 Support
email: support@f5.com
- name: F5 BIG-IP Application Services 3 Extension API
description: Declarative API for automating layer 4-7 application services on BIG-IP using JSON declarations. AS3 enables
infrastructure-as-code for application delivery configuration.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
baseURL: https://{{bigip_host}}/mgmt/shared/appsvcs
tags:
- Application Delivery
- Application Services
- Automation
- Declarative
- Infrastructure as Code
properties:
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: APIReference
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/refguide/as3-api.html
- type: GettingStarted
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/userguide/
- type: GitHubRepository
url: https://github.com/F5Networks/f5-appsvcs-extension
contact:
- FN: F5 Support
email: support@f5.com
- name: F5 Declarative Onboarding API
description: Declarative API for automating layer 1-3 BIG-IP onboarding and initial device configuration using JSON declarations,
making BIG-IP available on the network and ready for application services.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
baseURL: https://{{bigip_host}}/mgmt/shared/declarative-onboarding
tags:
- Automation
- Declarative
- Device Configuration
- Infrastructure as Code
- Onboarding
properties:
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- type: APIReference
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/apidocs.html
- type: GettingStarted
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/using-do.html
contact:
- FN: F5 Support
email: support@f5.com
- name: F5 Telemetry Streaming API
description: Declarative API for aggregating, normalizing, and forwarding BIG-IP statistics and events to third-party analytics
consumers including Splunk, Azure Log Analytics, AWS CloudWatch, and more.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/
baseURL: https://{{bigip_host}}/mgmt/shared/telemetry
tags:
- Analytics
- Monitoring
- Observability
- Streaming
- Telemetry
properties:
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/
- type: APIReference
url: https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/rest-api-endpoints.html
- type: GitHubRepository
url: https://github.com/F5Networks/f5-telemetry-streaming
contact:
- FN: F5 Support
email: support@f5.com
- name: F5 NGINX Plus API
description: REST API for NGINX Plus providing real-time live activity monitoring, dynamic upstream configuration, key-value
store management, and server health statistics without requiring configuration reloads.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://docs.nginx.com/nginx/
baseURL: https://{{nginx_host}}/api
tags:
- Dynamic Configuration
- Load Balancing
- Monitoring
- NGINX
- Reverse Proxy
properties:
- type: Documentation
url: https://docs.nginx.com/nginx/
- type: APIReference
url: https://docs.nginx.com/nginx/admin-guide/monitoring/live-activity-monitoring/
- type: GettingStarted
url: https://docs.nginx.com/nginx/admin-guide/load-balancer/dynamic-configuration-api/
contact:
- FN: NGINX Support
email: nginx-support@f5.com
- name: F5 NGINX One Console API
description: API for managing and monitoring NGINX instances across environments from a single console, including configuration
management, performance metrics, security vulnerability tracking, and SSL certificate management.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://docs.nginx.com/nginx-one-console/
baseURL: https://{{nginx-one-host}}/api
tags:
- Configuration Management
- Fleet Management
- Monitoring
- NGINX
- Security
properties:
- type: Documentation
url: https://docs.nginx.com/nginx-one-console/
- type: APIReference
url: https://docs.nginx.com/nginx-one-console/api/api-reference-guide/
- type: Authentication
url: https://docs.nginx.com/nginx-one-console/api/authentication/
contact:
- FN: NGINX Support
email: nginx-support@f5.com
- name: F5 NGINX Ingress Controller API
description: Kubernetes Ingress Controller implementation for NGINX and NGINX Plus providing load balancing, SSL/TLS termination,
content-based routing, and advanced traffic management for containerized applications.
image: https://www.f5.com/content/dam/f5-com/global-assets/images/f5-logo.svg
humanURL: https://docs.nginx.com/nginx-ingress-controller/
baseURL: https://{{kubernetes_host}}
tags:
- Containers
- Ingress Controller
- Kubernetes
- Load Balancing
- NGINX
properties:
- type: Documentation
url: https://docs.nginx.com/nginx-ingress-controller/
- type: GitHubRepository
url: https://github.com/nginx/kubernetes-ingress
contact:
- FN: NGINX Support
email: nginx-support@f5.com
- aid: f5-networks:f5-networks-nodes-api
name: F5 Networks Nodes API
description: Manage nodes representing individual backend servers by IP address or FQDN.
humanURL: https://www.f5.com/services/resources/api
baseURL: https://{{bigip_host}}/mgmt/tm
tags:
- Node
tags_raw:
- Nodes
properties:
- type: OpenAPI
url: openapi/f5-nodes-api-openapi.yml
- type: Documentation
url: https://clouddocs.f5.com/api/icontrol-rest/
- type: JSONSchema
url: json-schema/f5-virtual-server-schema.json
- type: JSONLD
url: json-ld/f5-context.jsonld
- type: JSONLD
url: json-ld/bigip-icontrol-rest-context.jsonld
- type: Authentication
url: https://clouddocs.f5.com/api/icontrol-rest/Authentication.html
- type: APIReference
url: https://clouddocs.f5.com/api/icontrol-rest/APIRef.html
- type: GettingStarted
url: https://clouddocs.f5.com/api/
- type: SDKs
url: https://github.com/F5Networks/f5-icontrol-rest-python
- type: SDKs
url: https://f5-sdk.readthedocs.io/
- type: Documentation
url: https://docs.cloud.f5.com/docs/api
- type: Console
url: https://console.ves.volterra.io/
- type: GettingStarted
url: https://docs.cloud.f5.com/docs/how-to/api-how-to
- type: APIReference
url: https://docs.cloud.f5.com/docs-v2/reference/api-ref
- type: Authentication
url: https://docs.cloud.f5.com/docs-v2/api/authentication
- type: ChangeLog
url: https://docs.cloud.f5.com/docs-v2/platform/changelogs/saas-release-notes
- aid: f5-networks:f5-networks-pool-members-api
name: F5 Networks Pool Members API
description: Manage individual members within a pool, including their health status, session state, and load balancing weight.
humanURL: https://www.f5.com/services/resources/api
baseURL: https://{{bigip_host}}/mgmt/tm
tags:
- Pool Members
properties:
- type: OpenAPI
url: openapi/f5-pool-members-api-openapi.yml
- type: Documentation
url: https://clouddocs.f5.com/api/icontrol-rest/
- type: JSONSchema
url: json-schema/f5-virtual-server-schema.json
- type: JSONLD
url: json-ld/f5-context.jsonld
- type: JSONLD
url: json-ld/bigip-icontrol-rest-context.jsonld
- type: Authentication
url: https://clouddocs.f5.com/api/icontrol-rest/Authentication.html
- type: APIReference
url: https://clouddocs.f5.com/api/icontrol-rest/APIRef.html
- type: GettingStarted
url: https://clouddocs.f5.com/api/
- type: SDKs
url: https://github.com/F5Networks/f5-icontrol-rest-python
- type: SDKs
url: https://f5-sdk.readthedocs.io/
- type: Documentation
url: https://docs.cloud.f5.com/docs/api
- type: Console
url: https://console.ves.volterra.io/
- type: GettingStarted
url: https://docs.cloud.f5.com/docs/how-to/api-how-to
- type: APIReference
url: https://docs.cloud.f5.com/docs-v2/reference/api-ref
- type: Authentication
url: https://docs.cloud.f5.com/docs-v2/api/authentication
- type: ChangeLog
url: https://docs.cloud.f5.com/docs-v2/platform/changelogs/saas-release-notes
- aid: f5-networks:f5-networks-pools-api
name: F5 Networks Pools API
description: Manage pools of backend servers for load distribution and health monitoring.
humanURL: https://www.f5.com/services/resources/api
baseURL: https://{{bigip_host}}/mgmt/tm
tags:
- Pools
properties:
- type: OpenAPI
url: openapi/f5-pools-api-openapi.yml
- type: Documentation
url: https://clouddocs.f5.com/api/icontrol-rest/
- type: JSONSchema
url: json-schema/f5-virtual-server-schema.json
- type: JSONLD
url: json-ld/f5-context.jsonld
- type: JSONLD
url: json-ld/bigip-icontrol-rest-context.jsonld
- type: Authentication
url: https://clouddocs.f5.com/api/icontrol-rest/Authentication.html
- type: APIReference
url: https://clouddocs.f5.com/api/icontrol-rest/APIRef.html
- type: GettingStarted
url: https://clouddocs.f5.com/api/
- type: SDKs
url: https://github.com/F5Networks/f5-icontrol-rest-python
- type: SDKs
url: https://f5-sdk.readthedocs.io/
- type: Documentation
url: https://docs.cloud.f5.com/docs/api
- type: Console
url: https://console.ves.volterra.io/
- type: GettingStarted
url: https://docs.cloud.f5.com/docs/how-to/api-how-to
- type: APIReference
url: https://docs.cloud.f5.com/docs-v2/reference/api-ref
- type: Authentication
url: https://docs.cloud.f5.com/docs-v2/api/authentication
- type: ChangeLog
url: https://docs.cloud.f5.com/docs-v2/platform/changelogs/saas-release-notes
- aid: f5-networks:f5-networks-profiles-api
name: F5 Networks Profiles API
description: Manage profiles that define traffic handling behavior for virtual servers, including HTTP, TCP, UDP, client
SSL, and persistence profiles.
humanURL: https://www.f5.com/services/resources/api
baseURL: https://{{bigip_host}}/mgmt/tm
tags:
- Profiles
properties:
- type: OpenAPI
url: openapi/f5-profiles-api-openapi.yml
- type: Documentation
url: https://clouddocs.f5.com/api/icontrol-rest/
- type: JSONSchema
url: json-schema/f5-virtual-server-schema.json
- type: JSONLD
url: json-ld/f5-context.jsonld
- type: JSONLD
url: json-ld/bigip-icontrol-rest-context.jsonld
- type: Authentication
url: https://clouddocs.f5.com/api/icontrol-rest/Authentication.html
- type: APIReference
url: https://clouddocs.f5.com/api/icontrol-rest/APIRef.html
- type: GettingStarted
url: https://clouddocs.f5.com/api/
- type: SDKs
url: https://github.com/F5Networks/f5-icontrol-rest-python
- type: SDKs
url: https://f5-sdk.readthedocs.io/
- type: Documentation
url: https://docs.cloud.f5.com/docs/api
- type: Console
url: https://console.ves.volterra.io/
- type: GettingStarted
url: https://docs.cloud.f5.com/docs/how-to/api-how-to
- type: APIReference
url: https://docs.cloud.f5.com/docs-v2/reference/api-ref
- type: Authentication
url: https://docs.cloud.f5.com/docs-v2/api/authentication
- type: ChangeLog
url: https://docs.cloud.f5.com/docs-v2/platform/changelogs/saas-release-notes
- aid: f5-networks:f5-networks-virtual-servers-api
name: F5 Networks Virtual Servers API
description: Manage virtual servers that direct client traffic to appropriate server pools based on configured rules and
profiles.
humanURL: https://www.f5.com/services/resources/api
baseURL: https://{{bigip_host}}/mgmt/tm
tags:
- Virtual Servers
properties:
- type: OpenAPI
url: openapi/f5-virtual-servers-api-openapi.yml
- type: Documentation
url: https://clouddocs.f5.com/api/icontrol-rest/
- type: JSONSchema
url: json-schema/f5-virtual-server-schema.json
- type: JSONLD
url: json-ld/f5-context.jsonld
- type: JSONLD
url: json-ld/bigip-icontrol-rest-context.jsonld
- type: Authentication
url: https://clouddocs.f5.com/api/icontrol-rest/Authentication.html
- type: APIReference
url: https://clouddocs.f5.com/api/icontrol-rest/APIRef.html
- type: GettingStarted
url: https://clouddocs.f5.com/api/
- type: SDKs
url: https://github.com/F5Networks/f5-icontrol-rest-python
- type: SDKs
url: https://f5-sdk.readthedocs.io/
- type: Documentation
url: https://docs.cloud.f5.com/docs/api
- type: Console
url: https://console.ves.volterra.io/
- type: GettingStarted
url: https://docs.cloud.f5.com/docs/how-to/api-how-to
- type: APIReference
url: https://docs.cloud.f5.com/docs-v2/reference/api-ref
- type: Authentication
url: https://docs.cloud.f5.com/docs-v2/api/authentication
- type: ChangeLog
url: https://docs.cloud.f5.com/docs-v2/platform/changelogs/saas-release-notes
- aid: f5:f5-application-management-api
name: F5 Application Management API
description: The Application Management API from F5 — 3 operation(s) for application management.
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- Application Management
properties:
- type: OpenAPI
url: openapi/f5-application-management-api-openapi.yml
- type: Documentation
url: https://nginx.org/en/docs/http/ngx_http_api_module.html
- type: APIReference
url: https://demo.nginx.com/swagger-ui/
- type: SourceCode
url: https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-extension
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-extension/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-templates
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-templates/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-declarative-onboarding
- type: ChangeLog
url: https://github.com/F5Networks/f5-declarative-onboarding/releases
- aid: f5:f5-configuration-api
name: F5 Configuration API
description: The Configuration API from F5 — 7 operation(s) for configuration.
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- Configuration
properties:
- type: OpenAPI
url: openapi/f5-configuration-api-openapi.yml
- type: Documentation
url: https://nginx.org/en/docs/http/ngx_http_api_module.html
- type: APIReference
url: https://demo.nginx.com/swagger-ui/
- type: SourceCode
url: https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-extension
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-extension/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-templates
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-templates/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-declarative-onboarding
- type: ChangeLog
url: https://github.com/F5Networks/f5-declarative-onboarding/releases
- aid: f5:f5-connections-api
name: F5 Connections API
description: The Connections API from F5 — 1 operation(s) for connections.
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- Connections
properties:
- type: OpenAPI
url: openapi/f5-connections-api-openapi.yml
- type: Documentation
url: https://nginx.org/en/docs/http/ngx_http_api_module.html
- type: APIReference
url: https://demo.nginx.com/swagger-ui/
- type: SourceCode
url: https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-extension
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-extension/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-templates
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-templates/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-declarative-onboarding
- type: ChangeLog
url: https://github.com/F5Networks/f5-declarative-onboarding/releases
- aid: f5:f5-fast-extension-api
name: F5 FAST Extension API
description: The FAST Extension API from F5 — 3 operation(s) for fast extension.
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- FAST Extension
properties:
- type: OpenAPI
url: openapi/f5-fast-extension-api-openapi.yml
- type: Documentation
url: https://nginx.org/en/docs/http/ngx_http_api_module.html
- type: APIReference
url: https://demo.nginx.com/swagger-ui/
- type: SourceCode
url: https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-extension
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-extension/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-templates
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-templates/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-declarative-onboarding
- type: ChangeLog
url: https://github.com/F5Networks/f5-declarative-onboarding/releases
- aid: f5:f5-general-info-api
name: F5 General Info API
description: The General Info API from F5 — 2 operation(s) for general info.
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- General Info
properties:
- type: OpenAPI
url: openapi/f5-general-info-api-openapi.yml
- type: Documentation
url: https://nginx.org/en/docs/http/ngx_http_api_module.html
- type: APIReference
url: https://demo.nginx.com/swagger-ui/
- type: SourceCode
url: https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-extension
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-extension/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-templates
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-templates/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-declarative-onboarding
- type: ChangeLog
url: https://github.com/F5Networks/f5-declarative-onboarding/releases
- aid: f5:f5-http-api
name: F5 HTTP API
description: The HTTP API from F5 — 1 operation(s) for http.
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- HTTP
properties:
- type: OpenAPI
url: openapi/f5-http-api-openapi.yml
- type: Documentation
url: https://nginx.org/en/docs/http/ngx_http_api_module.html
- type: APIReference
url: https://demo.nginx.com/swagger-ui/
- type: SourceCode
url: https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-extension
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-extension/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-templates
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-templates/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-declarative-onboarding
- type: ChangeLog
url: https://github.com/F5Networks/f5-declarative-onboarding/releases
- aid: f5:f5-http-caches-api
name: F5 HTTP Caches API
description: The HTTP Caches API from F5 — 2 operation(s) for http caches.
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- HTTP Caches
properties:
- type: OpenAPI
url: openapi/f5-http-caches-api-openapi.yml
- type: Documentation
url: https://nginx.org/en/docs/http/ngx_http_api_module.html
- type: APIReference
url: https://demo.nginx.com/swagger-ui/
- type: SourceCode
url: https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-extension
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-extension/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-templates
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-templates/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-declarative-onboarding
- type: ChangeLog
url: https://github.com/F5Networks/f5-declarative-onboarding/releases
- aid: f5:f5-http-keyvals-api
name: F5 HTTP Keyvals API
description: The HTTP Keyvals API from F5 — 2 operation(s) for http keyvals.
humanURL: https://clouddocs.f5.com/api/
baseURL: https://{bigip}/mgmt
tags:
- HTTP Keyvals
properties:
- type: OpenAPI
url: openapi/f5-http-keyvals-api-openapi.yml
- type: Documentation
url: https://nginx.org/en/docs/http/ngx_http_api_module.html
- type: APIReference
url: https://demo.nginx.com/swagger-ui/
- type: SourceCode
url: https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-extension
- type: ChangeLog
url: https://github.com/F5Networks/f5-appsvcs-extension/releases
- type: Documentation
url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
- type: SourceCode
url: https://github.com/F5Networks/f5-appsvcs-templates
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://artifacts.apis.io/f5/apis.yml
F5 API — frequently asked questions
Does F5 have an API?
Yes. APIs.io lists 51 APIs from F5, including F5 BIG-IP, F5 NGINX and F5 Distributed Cloud Services, and 48 more.
Is there an OpenAPI specification for the F5 API?
Yes. APIs.io indexes 39 OpenAPI specifications for F5, each linked for download from this page.
How do I authenticate with the F5 API?
F5 documents its authentication (http/apiKey/mutualTLS/none · 5 schemes). The details are profiled on APIs.io as F5 Authentication.
How much does the F5 API cost?
F5 publishes its prices; its Subscriptions plan is Get a subscription › as of 2026-10-28. APIs.io lists 4 pricing plans for F5, with each plan's price, limits and inclusions under Pricing on this page.
Is the F5 API ready for AI agents?
F5 has a Kin Score of 73.1 out of 100 (exemplar) and an Agent Readiness score of 47.4 (agent-ready), scored by API Evangelist on 2026-11-06.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
Kin Score
How this is scored →
It updates itself when the score changes. Paste this where you link to your API docs: