How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
F5

F5 Configuration API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

F5 Configuration API is one of 51 APIs that F5 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

This API exposes 14 operations across 7 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: /mgmt/shared/appsvcs, https://192.0.2.1:443/mgmt/shared/declarative-onboarding.

14 operations 7 paths 7 schemas 3 DELETE6 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{bigip}/mgmt
Resource Areas
1

Paths & Operations 14

Across 7 paths, the API surfaces 14 operations — 3 DELETE, 6 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Configuration 14
POST
/declare
Apply BIG-IP AS3 configuration
postDeclare 8 params body → 200202422500503
GET
/declare
Read current BIG-IP AS3 configuration
getDeclare 3 params → 200204500
PATCH
/declare
Update current BIG-IP AS3 configuration
patchDeclare 2 params → 200202422500503
DELETE
/declare
Remove current BIG-IP AS3 configuration
deleteDeclare 1 param → 200202500503
POST
/declare/{tenant}
Apply BIG-IP AS3 configuration for a specific tenant or tenants
postDeclareByTenant 9 params body → 200
POST
/declare/{tenant}/applications
Apply BIG-IP AS3 configuration on a per-application basis
postDeclareByTenantApplications 9 params body → 200
GET
/declare/{tenant}/applications
Read all current BIG-IP AS3 application configurations
getDeclareByTenantApplications → 200500503
GET
/declare/{tenant}/applications/{application}
Read current BIG-IP AS3 application configuration
getDeclareByTenantApplicationsByApplication → 200500503
DELETE
/declare/{tenant}/applications/{application}
Delete current BIG-IP AS3 application configuration
deleteDeclareByTenantApplicationsByApplication 10 params → 200
GET
/
Get status of configuration request
getMostRecentTask 2 params → 200500
POST
/
Apply BIG-IP DO configuration
postDeclaration body → 200202422500
GET
/config
Return all original configurations
getAllConfigs → 200500
GET
/config/{machineId}
Return original configuration by machine ID
getConfig 1 param → 200404500
DELETE
/config/{machineId}
Delete the stored original configuration by config ID
deleteConfig 1 param → 200404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are task (8 properties), result (6 properties), result_2 (5 properties), configObject (1 property). Each schema is shown below with its type and property counts.

result
object
6 properties
declaration
object
result_2
object
Standard result object in responses.
5 properties
task
object
The configuration status and associated declaration.
8 properties
device
configObject
object
1 property
config
object
The original configuration of a device.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

f5-configuration-api-openapi.yml Raw ↑

Other APIs F5 publishes across the network.

F5 BIG-IP
AE Profile APIs.io
F5 NGINX
AE Profile APIs.io
F5 Distributed Cloud Services
AE Profile APIs.io
F5 BIG-IP iControl REST (Mgmt)
AE Profile APIs.io
F5 NGINX Management Suite API
AE Profile APIs.io
F5 Essential App Protect API
AE Profile APIs.io
F5 BIG-IQ Centralized Management API
AE Profile APIs.io
F5 BIG-IP Application Services 3 Extension API
AE Profile APIs.io
F5 Declarative Onboarding API
AE Profile APIs.io
F5 Telemetry Streaming API
AE Profile APIs.io
F5 NGINX Plus API
AE Profile APIs.io
F5 NGINX One Console API
AE Profile APIs.io
#Configuration
← Back to F APIs
API Details
ID
f5:f5-configuration-api
Base URL
https://{bigip}/mgmt
Docs
https://clouddocs.f5.com/api/
Provider
F5
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=f5-configuration-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/f5-configuration-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of F5 Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.