F5

F5 Configuration API

The Configuration API from F5 — 7 operation(s) for configuration.

GitHub OpenAPI

Operations 14

POST /declare Apply BIG-IP AS3 configuration #
GET /declare Read current BIG-IP AS3 configuration #
PATCH /declare Update current BIG-IP AS3 configuration #
DELETE /declare Remove current BIG-IP AS3 configuration #
POST /declare/{tenant} Apply BIG-IP AS3 configuration for a specific tenant or tenants #
POST /declare/{tenant}/applications Apply BIG-IP AS3 configuration on a per-application basis #
GET /declare/{tenant}/applications Read all current BIG-IP AS3 application configurations #
GET /declare/{tenant}/applications/{application} Read current BIG-IP AS3 application configuration #
DELETE /declare/{tenant}/applications/{application} Delete current BIG-IP AS3 application configuration #
GET / Get status of configuration request #
POST / Apply BIG-IP DO configuration #
GET /config Return all original configurations #
GET /config/{machineId} Return original configuration by machine ID #
DELETE /config/{machineId} Delete the stored original configuration by config ID #

Documentation

📖
Documentation
https://nginx.org/en/docs/http/ngx_http_api_module.html
📖
APIReference
https://demo.nginx.com/swagger-ui/
📖
Documentation
https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
📖
Documentation
https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
📖
Documentation
https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/f5/refs/heads/main/openapi/f5-configuration-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
🔗
SourceCode
https://github.com/F5Networks/f5-appsvcs-extension
🔗
ChangeLog
https://github.com/F5Networks/f5-appsvcs-extension/releases
🔗
SourceCode
https://github.com/F5Networks/f5-appsvcs-templates
🔗
ChangeLog
https://github.com/F5Networks/f5-appsvcs-templates/releases
🔗
SourceCode
https://github.com/F5Networks/f5-declarative-onboarding
🔗
ChangeLog
https://github.com/F5Networks/f5-declarative-onboarding/releases

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/f5-configuration-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

f5-configuration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: F5 Configuration API
  version: '1.0'
  description: 'Operations tagged Configuration across 2 of this provider''s published API definitions: f5-big-ip-as3-openapi.yml, f5-big-ip-declarative-onboarding-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /mgmt/shared/appsvcs
- url: https://192.0.2.1:443/mgmt/shared/declarative-onboarding
tags:


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/f5/refs/heads/main/openapi/f5-configuration-api-openapi.yml