Application delivery controllers — virtual servers, pools, monitors, iRules, GTM/DNS, AS3, and config hygiene. Auto-generated from the platform OpenAPI schema so it matches the running API.
REST API for this feature — 94 operations across 73 resource paths, auto-generated from the platform's live OpenAPI schema (drf-spectacular).
Base URL
https://<your-versus-host>/api· AuthAuthorization: Bearer <JWT>(fromPOST /api/auth/token/) · 📄 Download the OpenAPI spec for Postman/Insomnia/Swagger · see the API overview for pagination, filtering, and errors.
GET /api/applications/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedApplicationList
POST /api/applications/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): ApplicationRequest
Responses: 201 → Application
GET /api/applications/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this application. |
Responses: 200 → ApplicationDetail
PUT /api/applications/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this application. |
Request body (application/json): ApplicationRequest
Responses: 200 → Application
PATCH /api/applications/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this application. |
Request body (application/json): PatchedApplicationRequest
Responses: 200 → Application
DELETE /api/applications/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this application. |
Responses: 204
PATCH /api/applications/{id}/update_canvas/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this application. |
Request body (application/json): PatchedApplicationRequest
Responses: 200 → Application
GET /api/as3-templates/List as3 templates
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedAs3TemplateList
POST /api/as3-templates/Create as3 template
Request body (application/json): As3TemplateRequest
Responses: 201 → As3Template
GET /api/as3-templates/{id}/Retrieve as3 template
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this as3 template. |
Responses: 200 → As3Template
PUT /api/as3-templates/{id}/Update as3 template
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this as3 template. |
Request body (application/json): As3TemplateRequest
Responses: 200 → As3Template
PATCH /api/as3-templates/{id}/Update as3 template
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this as3 template. |
Request body (application/json): PatchedAs3TemplateRequest
Responses: 200 → As3Template
DELETE /api/as3-templates/{id}/Delete as3 template
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this as3 template. |
Responses: 204
GET /api/datagroups/List datagroups
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
dg_type | query | no | string | * string - String |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedDataGroupList
GET /api/datagroups/{id}/Retrieve datagroup
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this data group. |
Responses: 200 → DataGroup
GET /api/f5-stale-vs/List f5 stale vs
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
is_enabled | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
partition | query | no | string | |
search | query | no | string | A search term. |
status | query | no | string | * disabled - Disabled |
Responses: 200 → F5StaleVirtualServer[]
GET /api/f5-stale-vs/criteria/Current staleness criteria (Settings > Stale Virtual Servers),
Responses: 200 → F5StaleVirtualServer
POST /api/f5-stale-vs/reset_status/Resets the live F5 traffic counters for the given
Request body (application/json): F5StaleVirtualServerRequest
Responses: 200 → F5StaleVirtualServer
POST /api/f5-stale-vs/trigger_scan/Trigger an immediate scan for a specific device or all devices.
Request body (application/json): F5StaleVirtualServerRequest
Responses: 200 → F5StaleVirtualServer
GET /api/f5-stale-vs/{id}/Retrieve f5 stale v
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this f5 stale virtual server. |
Responses: 200 → F5StaleVirtualServer
GET /api/f5-stale-wideips/List f5 stale wideips
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
is_enabled | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
partition | query | no | string | |
search | query | no | string | A search term. |
status | query | no | string | * disabled - Disabled |
Responses: 200 → F5StaleWideIP[]
GET /api/f5-stale-wideips/criteria/Current staleness criteria (Settings > Stale WideIPs).
Responses: 200 → F5StaleWideIP
POST /api/f5-stale-wideips/reset_status/Restarts the no-healthy-members window for the given
Request body (application/json): F5StaleWideIPRequest
Responses: 200 → F5StaleWideIP
POST /api/f5-stale-wideips/trigger_scan/Trigger an immediate scan for a specific device or all devices.
Request body (application/json): F5StaleWideIPRequest
Responses: 200 → F5StaleWideIP
GET /api/f5-stale-wideips/{id}/Retrieve f5 stale wideip
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this f5 stale wide ip. |
Responses: 200 → F5StaleWideIP
GET /api/f5-unused-objects/List f5 unused objects
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
object_type | query | no | string | * pool - Pool |
ordering | query | no | string | Which field to use when ordering the results. |
partition | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → F5UnusedObject[]
POST /api/f5-unused-objects/trigger_scan/Trigger an immediate unused-object scan (all devices or one device).
Request body (application/json): F5UnusedObjectRequest
Responses: 200 → F5UnusedObject
GET /api/f5-unused-objects/{id}/Retrieve f5 unused object
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this f5 unused object. |
Responses: 200 → F5UnusedObject
GET /api/gtm-datacenters/List gtm datacenters
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedGTMDatacenterList
GET /api/gtm-datacenters/{id}/Retrieve gtm datacenter
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this gtm datacenter. |
Responses: 200 → GTMDatacenter
GET /api/gtm-monitors/List gtm monitors
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
monitor_type | query | no | string | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedGTMMonitorList
GET /api/gtm-monitors/{id}/Retrieve gtm monitor
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this gtm monitor. |
Responses: 200 → GTMMonitor
GET /api/gtm-pools/List gtm pools
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
record_type | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedGTMPoolList
GET /api/gtm-pools/{id}/Retrieve gtm pool
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this gtm pool. |
Responses: 200 → GTMPool
GET /api/gtm-servers/List gtm servers
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedGTMServerList
GET /api/gtm-servers/{id}/Retrieve gtm server
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this gtm server. |
Responses: 200 → GTMServer
GET /api/gtm-wideips/List gtm wideips
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
enabled | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
record_type | query | no | string | * a - A |
search | query | no | string | A search term. |
Responses: 200 → PaginatedGTMWideIPListList
GET /api/gtm-wideips/{id}/Retrieve gtm wideip
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this gtm wide ip. |
Responses: 200 → GTMWideIPDetail
GET /api/gtm-wideips/{id}/f5-raw/Fetch the raw F5 API response for this WideIP to diagnose pool linkage.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this gtm wide ip. |
Responses: 200 → GTMWideIPList
POST /api/gtm-wideips/{id}/toggle/Toggle: gtm wideip
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this gtm wide ip. |
Request body (application/json): GTMWideIPListRequest
Responses: 200 → GTMWideIPList
GET /api/iapp-virtual-servers/Virtual servers currently associated with an F5 iApp (Application
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
search | query | no | string | A search term. |
Responses: 200 → IAppVirtualServer[]
POST /api/iapp-virtual-servers/detach/Detaches the selected virtual servers from their iApp:
Request body (application/json): IAppVirtualServerRequest
Responses: 200 → IAppVirtualServer
GET /api/iapp-virtual-servers/{id}/Virtual servers currently associated with an F5 iApp (Application
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → IAppVirtualServer
GET /api/irules/List irules
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedIRuleList
GET /api/irules/{id}/Retrieve irule
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this i rule. |
Responses: 200 → IRule
GET /api/monitors/List monitors
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
monitor_type | query | no | string | * http - HTTP |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedMonitorListList
GET /api/monitors/{id}/Retrieve monitor
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this monitor. |
Responses: 200 → MonitorList
GET /api/nodes/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
enabled | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
status | query | no | string | * up - Up |
Responses: 200 → PaginatedNodeList
GET /api/nodes/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this node. |
Responses: 200 → Node
GET /api/pool-members/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
enabled | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
pool | query | no | integer | |
search | query | no | string | A search term. |
status | query | no | string | * up - Up |
Responses: 200 → PaginatedPoolMemberList
POST /api/pool-members/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): PoolMemberRequest
Responses: 201 → PoolMember
GET /api/pool-members/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool member. |
Responses: 200 → PoolMember
PUT /api/pool-members/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool member. |
Request body (application/json): PoolMemberRequest
Responses: 200 → PoolMember
PATCH /api/pool-members/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool member. |
Request body (application/json): PatchedPoolMemberRequest
Responses: 200 → PoolMember
DELETE /api/pool-members/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool member. |
Responses: 204
GET /api/pool-members/{id}/stats_history/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool member. |
Responses: 200 → PoolMember
POST /api/pool-members/{id}/toggle/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool member. |
Request body (application/json): PoolMemberRequest
Responses: 200 → PoolMember
GET /api/pools/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
virtual_servers | query | no | array |
Responses: 200 → PaginatedPoolList
POST /api/pools/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): PoolRequest
Responses: 201 → Pool
GET /api/pools/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool. |
Responses: 200 → Pool
PUT /api/pools/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool. |
Request body (application/json): PoolRequest
Responses: 200 → Pool
PATCH /api/pools/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool. |
Request body (application/json): PatchedPoolRequest
Responses: 200 → Pool
DELETE /api/pools/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool. |
Responses: 204
GET /api/pools/{id}/references/On-demand: which iRules and LTM Policies reference this pool by
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this pool. |
Responses: 200 → Pool
GET /api/virtual-servers/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
application | query | no | integer | |
device | query | no | integer | |
device__vendor | query | no | string | * f5_bigip - F5 BIG-IP |
device__vendor__in | query | no | array | Multiple values may be separated by commas. |
enabled | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
status | query | no | string | * available - Available |
Responses: 200 → PaginatedVirtualServerListList
POST /api/virtual-servers/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): VirtualServerRequest
Responses: 201 → VirtualServer
GET /api/virtual-servers/expiring_certs/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
PUT /api/virtual-servers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
PATCH /api/virtual-servers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): PatchedVirtualServerRequest
Responses: 200 → VirtualServer
DELETE /api/virtual-servers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 204
POST /api/virtual-servers/{id}/analyze_capture/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
POST /api/virtual-servers/{id}/capture/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
POST /api/virtual-servers/{id}/confirm_waf_link/Human confirms a candidate WafLink. This records the match in
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
POST /api/virtual-servers/{id}/discover_fqdn/Single-VS reverse-DNS (PTR) lookup — same logic as
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
POST /api/virtual-servers/{id}/guess_environment/Infer the Environment from the VS name (e.g. 'app01-prod-vs') and
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/live_stats/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/logs/Return syslog entries relevant to this VS and its pools.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/pools-with-members/All pools and live member stats for this VS — used by the App Builder pool member editor.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
POST /api/virtual-servers/{id}/push_waf_link/Explicit, separate step: PATCH the confirmed WAF link's summary
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
POST /api/virtual-servers/{id}/reject_waf_link/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/siem_events/Return SIEM events matching this VS's VIP and pool member IPs.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/stats_history/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
POST /api/virtual-servers/{id}/stop_capture/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/tmsh_config/Generate TMSH stanzas from synced DB data.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
POST /api/virtual-servers/{id}/toggle/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Request body (application/json): VirtualServerRequest
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/waf_candidates/Run the DNS/name/NAT-rule heuristic matcher and upsert the
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/xc_audit_log/Live-fetched config change history for this VS's namespace —
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/xc_traffic_stats/Historical request-rate/latency/status-code stats for an F5 XC
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
GET /api/virtual-servers/{id}/xc_violations/WAF/bot/API violations recorded for an F5 XC load balancer —
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this virtual server. |
Responses: 200 → VirtualServer
GET /api/vs-as3/Generate or retrieve AS3 JSON/YAML for a given VS. GET with ?vs=<id>&format=json|yaml
Responses: 200
GET /api/vs-drift/Playbook ↔ live-config drift for a VS.
Responses: 200
POST /api/vs-drift/Playbook ↔ live-config drift for a VS.
Responses: 200
GET /api/vs-yml/Generate or retrieve Ansible YML for a given VS. GET with ?vs=<id>
Responses: 200
Auto-generated from drf-spectacular OpenAPI. Endpoint descriptions come from viewset docstrings/serializers; enriching those improves this page on the next generation.