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

F5 Mgmt API

The Mgmt API from F5 — 10 operation(s) for mgmt.

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

Tagged areas include Mgmt. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 21 operations across 10 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://{bigip}.

21 operations 10 paths 2 schemas 3 DELETE9 GET2 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://{bigip}
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

F5 Mgmt API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). An API key is passed in the header as X-F5-Auth-Token (Token). By default, every request must be authenticated.

  • Basic — HTTP Basic auth using a BIG-IP administrative user.
  • Token — Token obtained from /mgmt/shared/authn/login.

Paths & Operations 21

Across 10 paths, the API surfaces 21 operations — 3 DELETE, 9 GET, 2 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Mgmt 21
POST
/mgmt/shared/authn/login
Obtain an authentication token
login body → 200
GET
/mgmt/tm/ltm/virtual
List virtual servers
listVirtuals → 200
POST
/mgmt/tm/ltm/virtual
Create a virtual server
createVirtual body → 200
GET
/mgmt/tm/ltm/virtual/{name}
Get a virtual server
getVirtual 1 param → 200
PUT
/mgmt/tm/ltm/virtual/{name}
Replace a virtual server
replaceVirtual 1 param body → 200
PATCH
/mgmt/tm/ltm/virtual/{name}
Partially update a virtual server
patchVirtual 1 param body → 200
DELETE
/mgmt/tm/ltm/virtual/{name}
Delete a virtual server
deleteVirtual 1 param → 200
GET
/mgmt/tm/ltm/pool
List pools
listPools → 200
POST
/mgmt/tm/ltm/pool
Create a pool
createPool body → 200
GET
/mgmt/tm/ltm/pool/{name}
Get a pool
getPool 1 param → 200
PUT
/mgmt/tm/ltm/pool/{name}
Replace a pool
replacePool 1 param body → 200
PATCH
/mgmt/tm/ltm/pool/{name}
Partially update a pool
patchPool 1 param body → 200
DELETE
/mgmt/tm/ltm/pool/{name}
Delete a pool
deletePool 1 param → 200
GET
/mgmt/tm/ltm/pool/{name}/members
List members of a pool
listPoolMembers 1 param → 200
POST
/mgmt/tm/ltm/pool/{name}/members
Add a member to a pool
addPoolMember 1 param body → 200
GET
/mgmt/tm/ltm/node
List nodes
listNodes → 200
POST
/mgmt/tm/ltm/node
Create a node
createNode body → 200
GET
/mgmt/tm/ltm/node/{name}
Get a node
getNode 1 param → 200
DELETE
/mgmt/tm/ltm/node/{name}
Delete a node
deleteNode 1 param → 200
GET
/mgmt/tm/ltm/profile/http
List HTTP profiles
listHttpProfiles → 200
GET
/mgmt/tm/sys/version
Get system software version
getSystemVersion → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Virtual (6 properties), Pool (5 properties). Each schema is shown below with its type and property counts.

Virtual
object
6 properties
Pool
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

f5-mgmt-api-openapi.yml Raw ↑

Other APIs F5 publishes across the network.

F5 BIG-IP
F5 NGINX
F5 Distributed Cloud Services
Where this information came from

This is an independent, third-party profile of F5 Mgmt 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.