F5 Networks Virtual Servers API
Manage virtual servers that direct client traffic to appropriate server pools based on configured rules and profiles.
F5 Networks Virtual Servers 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 Virtual Servers. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
F5 Networks Virtual Servers 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.
Manage virtual servers that direct client traffic to appropriate server pools based on configured rules and profiles.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are VirtualServer (35 properties), VirtualServerUpdate (21 properties), VirtualServerCreate (18 properties), ErrorResponse (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from F5 Networks 12
Other APIs F5 Networks publishes across the network.
This is an independent, third-party profile of F5 Networks Virtual Servers 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.