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 Load Balancer Virtual Servers API

Manage virtual servers that direct client traffic to appropriate server pools based on configured rules and profiles.

F5 Load Balancer Virtual Servers API is one of 17 APIs that F5 Load Balancer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virtual Servers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

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

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

6 operations 2 paths 3 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
3.50.0
Base URL
https://bigip-host/mgmt/tm
Authentication
HTTP Basic, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

F5 Load Balancer 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.
  • tokenAuth — Token-based authentication obtained from the /mgmt/shared/authn/login endpoint.

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.

Virtual Servers 6

Manage virtual servers that direct client traffic to appropriate server pools based on configured rules and profiles.

GET
/ltm/virtual
F5 Load Balancer List all virtual servers
listVirtualServers 5 params → 200401500
POST
/ltm/virtual
F5 Load Balancer Create a virtual server
createVirtualServer body → 200400401409500
GET
/ltm/virtual/{virtualName}
F5 Load Balancer Get a specific virtual server
getVirtualServer 1 param → 200401404
PUT
/ltm/virtual/{virtualName}
F5 Load Balancer Update a virtual server
updateVirtualServer 1 param body → 200400401404
PATCH
/ltm/virtual/{virtualName}
F5 Load Balancer Partially update a virtual server
patchVirtualServer 1 param body → 200400401404
DELETE
/ltm/virtual/{virtualName}
F5 Load Balancer Delete a virtual server
deleteVirtualServer 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are VirtualServer (25 properties), VirtualServerCollection (3 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
3 properties
VirtualServerCollection
object
3 properties
VirtualServer
object
25 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

f5-load-balancer-virtual-servers-api-openapi.yml Raw ↑

Other APIs F5 Load Balancer publishes across the network.

F5 Load Balancer Config API
F5 Load Balancer Data Groups API
F5 Load Balancer Declarations API
F5 Load Balancer Info API
F5 Load Balancer Inspect API
F5 Load Balancer iRules API
F5 Load Balancer Monitors API
F5 Load Balancer Nodes API
F5 Load Balancer Policies API
F5 Load Balancer Pool Members API
F5 Load Balancer Pools API
F5 Load Balancer Profiles API
Where this information came from

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