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 Profiles API

Manage profiles that define traffic handling behavior for virtual servers, including HTTP, TCP, UDP, client SSL, and persistence profiles.

F5 Networks Profiles 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 Profiles. 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 8 operations across 8 paths, and defines 5 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.

8 operations 8 paths 5 schemas 8 GET

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 Profiles 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 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Profiles 8

Manage profiles that define traffic handling behavior for virtual servers, including HTTP, TCP, UDP, client SSL, and persistence profiles.

GET
/ltm/profile/http
List Http Profiles
listHttpProfiles 2 params → 200401500
GET
/ltm/profile/http/{profileName}
Get an Http Profile
getHttpProfile 1 param → 200401404500
GET
/ltm/profile/tcp
List Tcp Profiles
listTcpProfiles 2 params → 200401500
GET
/ltm/profile/tcp/{profileName}
Get a Tcp Profile
getTcpProfile 1 param → 200401404500
GET
/ltm/profile/client-ssl
List Client Ssl Profiles
listClientSslProfiles 2 params → 200401500
GET
/ltm/profile/client-ssl/{profileName}
Get a Client Ssl Profile
getClientSslProfile 1 param → 200401404500
GET
/ltm/persistence/cookie
List Cookie Persistence Profiles
listCookiePersistenceProfiles 2 params → 200401500
GET
/ltm/persistence/cookie/{profileName}
Get a Cookie Persistence Profile
getCookiePersistenceProfile 1 param → 200401404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are HttpProfile (26 properties), TcpProfile (25 properties), CookiePersistenceProfile (22 properties), ClientSslProfile (21 properties). Each schema is shown below with its type and property counts.

HttpProfile
object
An HTTP profile that defines how the BIG-IP processes HTTP traffic for a virtual server.
26 properties
ClientSslProfile
object
A Client SSL profile for managing SSL/TLS connections between clients and the BIG-IP system.
21 properties
ErrorResponse
object
Standard error response from the iControl REST API.
4 properties
CookiePersistenceProfile
object
A cookie persistence profile that maintains session persistence by inserting or reading HTTP cookies.
22 properties
TcpProfile
object
A TCP profile that defines how the BIG-IP processes TCP traffic, including connection settings, timeouts, and optimization.
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

f5-networks-profiles-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 Pools API
Where this information came from

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