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 Networks Pools API

Manage pools of backend servers for load distribution and health monitoring.

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

This API exposes 1 JSON Schema definition.

Tagged areas include Pools. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, an API reference, a getting-started guide, and 1 JSON Schema.

This API exposes 6 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 15.1.0.

Requests are made against a single base URL, https://{bigip_host}/mgmt/tm.

6 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
15.1.0
Base URL
https://{{bigip_host}}/mgmt/tm
Authentication
HTTP Basic, API Key
Contact
Resource Areas
1

Authentication & Security 2

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

  • basicAuth — HTTP Basic authentication using BIG-IP admin credentials. The username and password are sent base64-encoded in the Authorization header.
  • tokenAuth — Token-based authentication. Obtain a token by POSTing credentials to /mgmt/shared/authn/login, then pass the token value in the X-F5-Auth-Token header for subs…

Paths & Operations 6

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

Pools 6

Manage pools of backend servers for load distribution and health monitoring.

GET
/ltm/pool
List All Pools
listPools 5 params → 200401500
POST
/ltm/pool
Create a Pool
createPool body → 200400401409500
GET
/ltm/pool/{poolName}
Get a Pool
getPool 2 params → 200401404500
PUT
/ltm/pool/{poolName}
Update a Pool
updatePool 1 param body → 200400401404500
PATCH
/ltm/pool/{poolName}
Patch a Pool
patchPool 1 param body → 200400401404500
DELETE
/ltm/pool/{poolName}
Delete a Pool
deletePool 1 param → 200401404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Pool (27 properties), PoolCreate (10 properties), PoolUpdate (8 properties), ErrorResponse (4 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Standard error response from the iControl REST API.
4 properties
PoolCreate
object
Request body for creating a new pool.
10 properties 1 required
Pool
object
A pool resource that contains a group of backend server members used for load balancing traffic from virtual servers.
27 properties
PoolUpdate
object
Request body for updating a pool.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

f5-networks-pools-api-openapi.yml Raw ↑

Other APIs F5 Networks publishes across the network.

F5 NGINX Management Suite API
F5 Essential App Protect API
F5 BIG-IQ Centralized Management API
F5 BIG-IP Application Services 3 Extension API
F5 Declarative Onboarding API
F5 Telemetry Streaming API
F5 NGINX Plus API
F5 NGINX One Console API
F5 NGINX Ingress Controller API
F5 Networks Nodes API
F5 Networks Pool Members API
F5 Networks Profiles API
Where this information came from

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