Skip to content

All Application Objects Inventory.

POST
/api/config/namespaces/system/all_application_inventory
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/system/all_application_inventory \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "bigip_virtual_server_filter": { "api_discovery": true, "waf_configured": true }, "cdn_load_balancer_filter": { "api_definition": true, "api_discovery": true, "api_protection": true, "api_schema_validation": true, "bot_protection": true, "client_blocking": true, "client_side_defense": true, "cookie_protection": true, "cors_policy": true, "csrf_protection": true, "data_guard": true, "ddos_auto_mitigation": true, "ddos_mitigation": true, "ddos_protection": true, "default_loadbalancer": true, "graph_ql_inspection": true, "http_only": true, "ip_reputation": true, "malicious_user_detection": true, "malicious_user_mitigation": true, "malware_protection": true, "mutual_tls": true, "namespace_service_policy": true, "origin_server_subset": true, "private_advertisement": true, "public_advertisment": true, "routes": true, "service_policy": true, "slow_ddos_mitigation": true, "trusted_client": true, "trusted_client_ip_headers": true, "waf": true, "waf_exclusion": true }, "http_load_balancer_filter": { "api_definition": true, "api_discovery": true, "api_protection": true, "api_schema_validation": true, "bot_protection": true, "client_blocking": true, "client_side_defense": true, "cookie_protection": true, "cors_policy": true, "csrf_protection": true, "data_guard": true, "ddos_auto_mitigation": true, "ddos_mitigation": true, "ddos_protection": true, "default_loadbalancer": true, "graph_ql_inspection": true, "http_only": true, "ip_reputation": true, "malicious_user_detection": true, "malicious_user_mitigation": true, "malware_protection": true, "mutual_tls": true, "namespace_service_policy": true, "origin_server_subset": true, "private_advertisement": true, "public_advertisment": true, "routes": true, "service_policy": true, "slow_ddos_mitigation": true, "trusted_client": true, "trusted_client_ip_headers": true, "waf": true, "waf_exclusion": true }, "nginx_one_server_filter": { "api_discovery": true, "waf_configured": true }, "tcp_load_balancer_filter": { "namespace_service_policy": true, "private_advertisement": true, "public_advertisment": true, "service_policy": true, "tls_encryption": true }, "third_party_application_filter": { "api_discovery": true }, "udp_load_balancer_filter": { "private_advertisement": true, "public_advertisment": true, "namespace_service_policy": true, "service_policy": true } }'

AllApplicationInventory returns inventory of configured application related objects for all namespaces.

Examples of this operation.

Media typeapplication/json
AllApplicationInventoryRequest

Request for inventory of application related objects.

object
bigip_virtual_server_filter
object
api_discovery
API Discovery

Filter results with BIG-IP Virtual Server with API Discovery.

boolean format: boolean
waf_configured
WAF

Filter results with BIG-IP Virtual Server with WAF configured.

boolean format: boolean
cdn_load_balancer_filter
object
api_definition
API Definition

Filter results with HTTP loadbalancers with API Definition.

boolean format: boolean
api_discovery
API Discovery

Filter results with HTTP loadbalancers with API Discovery.

boolean format: boolean
api_protection
API Protection

Filter results with HTTP loadbalancers with API Protection configured.

boolean format: boolean
api_schema_validation
API Schema Validation

Filter results with HTTP loadbalancers with API Schema Validation.

boolean format: boolean
bot_protection
Bot Protection

Filter results with HTTP loadbalancers with Bot Protection configured.

boolean format: boolean
client_blocking
Client Blocking

Filter results with HTTP loadbalancers with Client Blocking.

boolean format: boolean
client_side_defense
Client Side Defense

Filter results with HTTP loadbalancers with Client Side Defense configured.

boolean format: boolean
cookie_protection
Cookie Protection

Filter results with HTTP loadbalancers with Cookie Protection.

boolean format: boolean
cors_policy
CORS Policy

Filter results with HTTP loadbalancers with CORS Policy.

boolean format: boolean
csrf_protection
CSRF Protection

Filter results with HTTP loadbalancers with CSRF Protection.

boolean format: boolean
data_guard
Data Guard

Filter results with HTTP loadbalancers with Data Guard.

boolean format: boolean
ddos_auto_mitigation
L7 DDoS Auto Mitigation

Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled.

boolean format: boolean
ddos_mitigation
DDoS Mitigation Rules

Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured.

boolean format: boolean
ddos_protection
L7 DDoS Detection

Filter results with HTTP loadbalancers with L7 DDoS detection enabled.

boolean format: boolean
default_loadbalancer
Default Loadbalancer

Filter results with HTTP loadbalancers with Default Loadbalancer.

boolean format: boolean
graph_ql_inspection
GraphQL Inspection

Filter results with HTTP loadbalancers with GraphQL Inspection.

boolean format: boolean
http_only
HTTP Only

Filter results with HTTP only loadbalancers.

boolean format: boolean
ip_reputation
IP Reputation

Filter results with HTTP loadbalancers with IP Reputation configured.

boolean format: boolean
malicious_user_detection
Malicious User Detection

Filter results with HTTP loadbalancers with Malicious User Detection configured.

boolean format: boolean
malicious_user_mitigation
Malicious User Mitigation

Filter results with HTTP loadbalancers with Malicious User Mitigation.

boolean format: boolean
malware_protection
Malware Protection

Filter results with HTTP loadbalancers with Malware Protection.

boolean format: boolean
mutual_tls
mTLS

Filter results with HTTP loadbalancers with mTLS.

boolean format: boolean
namespace_service_policy
Namespace Service Policy

Filter results with HTTP loadbalancers with Namespace Service Policy configured.

boolean format: boolean
origin_server_subset
Origin Server Subset

Filter results with HTTP loadbalancers with Origin Server Subset.

boolean format: boolean
private_advertisement
Private Advertisement

Filter results with HTTP loadbalancers advertised privately.

boolean format: boolean
public_advertisment
Public Advertisement

Filter results with HTTP loadbalancers advertised publicly.

boolean format: boolean
routes
Routes

Filter results with HTTP loadbalancers with Routes.

boolean format: boolean
service_policy
Service Policy

Filter results with HTTP loadbalancers with Service Policy configured.

boolean format: boolean
slow_ddos_mitigation
Slow DDoS Mitigation

Filter results with HTTP loadbalancers with Slow DDoS Mitigation.

boolean format: boolean
trusted_client
Trusted Client

Filter results with HTTP loadbalancers with Trusted Client.

boolean format: boolean
trusted_client_ip_headers
Trusted Client IP Headers

Filter results with HTTP loadbalancers with Trusted Client IP Headers.

boolean format: boolean
waf
WAF

Filter results with HTTP loadbalancers with WAF configured.

boolean format: boolean
waf_exclusion
WAF Exclusion

Filter results with HTTP loadbalancers with WAF Exclusion.

boolean format: boolean
http_load_balancer_filter
object
api_definition
API Definition

Filter results with HTTP loadbalancers with API Definition.

boolean format: boolean
api_discovery
API Discovery

Filter results with HTTP loadbalancers with API Discovery.

boolean format: boolean
api_protection
API Protection

Filter results with HTTP loadbalancers with API Protection configured.

boolean format: boolean
api_schema_validation
API Schema Validation

Filter results with HTTP loadbalancers with API Schema Validation.

boolean format: boolean
bot_protection
Bot Protection

Filter results with HTTP loadbalancers with Bot Protection configured.

boolean format: boolean
client_blocking
Client Blocking

Filter results with HTTP loadbalancers with Client Blocking.

boolean format: boolean
client_side_defense
Client Side Defense

Filter results with HTTP loadbalancers with Client Side Defense configured.

boolean format: boolean
cookie_protection
Cookie Protection

Filter results with HTTP loadbalancers with Cookie Protection.

boolean format: boolean
cors_policy
CORS Policy

Filter results with HTTP loadbalancers with CORS Policy.

boolean format: boolean
csrf_protection
CSRF Protection

Filter results with HTTP loadbalancers with CSRF Protection.

boolean format: boolean
data_guard
Data Guard

Filter results with HTTP loadbalancers with Data Guard.

boolean format: boolean
ddos_auto_mitigation
L7 DDoS Auto Mitigation

Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled.

boolean format: boolean
ddos_mitigation
DDoS Mitigation Rules

Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured.

boolean format: boolean
ddos_protection
L7 DDoS Detection

Filter results with HTTP loadbalancers with L7 DDoS detection enabled.

boolean format: boolean
default_loadbalancer
Default Loadbalancer

Filter results with HTTP loadbalancers with Default Loadbalancer.

boolean format: boolean
graph_ql_inspection
GraphQL Inspection

Filter results with HTTP loadbalancers with GraphQL Inspection.

boolean format: boolean
http_only
HTTP Only

Filter results with HTTP only loadbalancers.

boolean format: boolean
ip_reputation
IP Reputation

Filter results with HTTP loadbalancers with IP Reputation configured.

boolean format: boolean
malicious_user_detection
Malicious User Detection

Filter results with HTTP loadbalancers with Malicious User Detection configured.

boolean format: boolean
malicious_user_mitigation
Malicious User Mitigation

Filter results with HTTP loadbalancers with Malicious User Mitigation.

boolean format: boolean
malware_protection
Malware Protection

Filter results with HTTP loadbalancers with Malware Protection.

boolean format: boolean
mutual_tls
mTLS

Filter results with HTTP loadbalancers with mTLS.

boolean format: boolean
namespace_service_policy
Namespace Service Policy

Filter results with HTTP loadbalancers with Namespace Service Policy configured.

boolean format: boolean
origin_server_subset
Origin Server Subset

Filter results with HTTP loadbalancers with Origin Server Subset.

boolean format: boolean
private_advertisement
Private Advertisement

Filter results with HTTP loadbalancers advertised privately.

boolean format: boolean
public_advertisment
Public Advertisement

Filter results with HTTP loadbalancers advertised publicly.

boolean format: boolean
routes
Routes

Filter results with HTTP loadbalancers with Routes.

boolean format: boolean
service_policy
Service Policy

Filter results with HTTP loadbalancers with Service Policy configured.

boolean format: boolean
slow_ddos_mitigation
Slow DDoS Mitigation

Filter results with HTTP loadbalancers with Slow DDoS Mitigation.

boolean format: boolean
trusted_client
Trusted Client

Filter results with HTTP loadbalancers with Trusted Client.

boolean format: boolean
trusted_client_ip_headers
Trusted Client IP Headers

Filter results with HTTP loadbalancers with Trusted Client IP Headers.

boolean format: boolean
waf
WAF

Filter results with HTTP loadbalancers with WAF configured.

boolean format: boolean
waf_exclusion
WAF Exclusion

Filter results with HTTP loadbalancers with WAF Exclusion.

boolean format: boolean
nginx_one_server_filter
object
api_discovery
API Discovery

Filter results with NGINX One Server with specificed API Discovery enablement state.

boolean format: boolean
waf_configured
WAF

Filter results with NGINX One Server with specified WAF enablement state.

boolean format: boolean
tcp_load_balancer_filter
object
namespace_service_policy
Namespace Service Policy

Filter results with TCP loadbalancers with Namespace Service Policy configured.

boolean format: boolean
private_advertisement
Private Advertisement

Filter results with TCP loadbalancers advertised privately.

boolean format: boolean
public_advertisment
Public Advertisement

Filter results with TCP loadbalancers advertised publicly.

boolean format: boolean
service_policy
Service Policy

Filter results with TCP loadbalancers with Service Policy configured.

boolean format: boolean
tls_encryption
TLS Encryption

Filter results with TCP loadbalancers with TLS Encryption configured.

boolean format: boolean
third_party_application_filter
object
api_discovery
API Discovery

Filter results with Third Party Application with API Discovery.

boolean format: boolean
udp_load_balancer_filter
object
private_advertisement
Private Advertisement

Filter results with UDP loadbalancers advertised privately.

boolean format: boolean
public_advertisment
Public Advertisement

Filter results with UDP loadbalancers advertised publicly.

boolean format: boolean
namespace_service_policy
Namespace Service Policy

Filter results with UDP loadbalancers with Namespace Service Policy configured.

boolean format: boolean
service_policy
Service Policy

Filter results with UDP loadbalancers with Service Policy configured.

boolean format: boolean
Examplegenerated
{
"bigip_virtual_server_filter": {
"api_discovery": true,
"waf_configured": true
},
"cdn_load_balancer_filter": {
"api_definition": true,
"api_discovery": true,
"api_protection": true,
"api_schema_validation": true,
"bot_protection": true,
"client_blocking": true,
"client_side_defense": true,
"cookie_protection": true,
"cors_policy": true,
"csrf_protection": true,
"data_guard": true,
"ddos_auto_mitigation": true,
"ddos_mitigation": true,
"ddos_protection": true,
"default_loadbalancer": true,
"graph_ql_inspection": true,
"http_only": true,
"ip_reputation": true,
"malicious_user_detection": true,
"malicious_user_mitigation": true,
"malware_protection": true,
"mutual_tls": true,
"namespace_service_policy": true,
"origin_server_subset": true,
"private_advertisement": true,
"public_advertisment": true,
"routes": true,
"service_policy": true,
"slow_ddos_mitigation": true,
"trusted_client": true,
"trusted_client_ip_headers": true,
"waf": true,
"waf_exclusion": true
},
"http_load_balancer_filter": {
"api_definition": true,
"api_discovery": true,
"api_protection": true,
"api_schema_validation": true,
"bot_protection": true,
"client_blocking": true,
"client_side_defense": true,
"cookie_protection": true,
"cors_policy": true,
"csrf_protection": true,
"data_guard": true,
"ddos_auto_mitigation": true,
"ddos_mitigation": true,
"ddos_protection": true,
"default_loadbalancer": true,
"graph_ql_inspection": true,
"http_only": true,
"ip_reputation": true,
"malicious_user_detection": true,
"malicious_user_mitigation": true,
"malware_protection": true,
"mutual_tls": true,
"namespace_service_policy": true,
"origin_server_subset": true,
"private_advertisement": true,
"public_advertisment": true,
"routes": true,
"service_policy": true,
"slow_ddos_mitigation": true,
"trusted_client": true,
"trusted_client_ip_headers": true,
"waf": true,
"waf_exclusion": true
},
"nginx_one_server_filter": {
"api_discovery": true,
"waf_configured": true
},
"tcp_load_balancer_filter": {
"namespace_service_policy": true,
"private_advertisement": true,
"public_advertisment": true,
"service_policy": true,
"tls_encryption": true
},
"third_party_application_filter": {
"api_discovery": true
},
"udp_load_balancer_filter": {
"private_advertisement": true,
"public_advertisment": true,
"namespace_service_policy": true,
"service_policy": true
}
}

A successful response.

Media typeapplication/json
ApplicationInventoryResponse

Response for inventory of application related objects.

object
bigip_virtual_servers
object
api_discovery
API Discovery

Number of BIG-IP Virtual Servers with API Discovery enabled.

integer format: int64
bigiplb_results
BIGIP Virtual Server

List of BIG-IP Virtual Server.

Array<object>
BIGIPVirtualServerResultType

BIG-IP Virtual Server Inventory Results.

object
api_discovery_enabled
object
description
BIGIP VS Description

VS Description of BIG-IP.

string
>= 21 characters <= 1024 characters
host_name
BIGIP Host Name

Name of BIG-IP Host.

string
<= 1024 characters
name
BIGIP Virtual Server Name

Name of BIG-IP Virtual Server.

string
>= 6 characters <= 1024 characters
server_name
BIGIP VS Display Name

Display Name of BIG-IP VS.

string
<= 1024 characters
version
BIGIP Version

Version of BIG-IP.

string
>= 1 characters <= 1024 characters
waf_enforcement_mode
WAF Enforcement Mode

WAF Enforcement Mode.

string
<= 1024 characters
waf_policy_name
WAF Policy Name

WAF Policy Name.

string
<= 1024 characters
namespace
BIGIP VS Namespace

Namespace of BIG-IP VS.

string
>= 6 characters <= 1024 characters
waf_configured
WAF

Number of BIG-IP Virtual Servers with WAF configured.

integer format: int64
cdn_loadbalancers
object
api_discovery
API Discovery

Number of HTTP loadbalancers with API Discovery enabled.

integer format: int64
api_protection
API Protection

Number of HTTP loadbalancers with API Protection configured.

integer format: int64
bot_protection
Bot Protection

Number of HTTP loadbalancers with Bot Protection configured.

integer format: int64
cdnlb_results
CDN Loadbalancers

List of CDN loadbalancers.

Array<object>
HTTPLoadbalancerResultType

HTTP Loadbalancer Inventory Results.

object
api_definition_enabled
object
api_discovery_enabled
object
api_protection_enabled
object
api_schema_validation_enabled
object
bot_protection_enabled
object
certification_expiration_date
Certification Expiration Date

Certification Expiration Date.

string format: date-time
<= 1024 characters
certification_status
Certification Status

Certification Status.

string
<= 1024 characters
client_blocking_enabled
object
client_side_defense_enabled
object
connection_idle_timeout
Connection Idle Timeout

Connection Idle Timeout.

integer format: int64
cookie_protection_enabled
object
cors_policy_enabled
object
csrf_protection_enabled
object
data_guard_enabled
object
ddos_auto_mitigation_enabled
object
ddos_mitigation_enabled
object
ddos_protection_enabled
object
default_loadbalancer_enabled
object
dns_info
DNS Info

DNS Info

string
<= 1024 characters
domains
Domains

Domains

Array<string>
graph_ql_inspection_enabled
object
http_enabled
object
http_listen_port_choice
HTTP Listen Port Choice

HTTP Listen Port Choice.

string
<= 1024 characters
idle_timeout
Idle Timeout

Idle Timeout.

integer format: int64
ip_reputation_enabled
object
loadbalancer_algorithm
Loadbalancer Algorithm

Loadbalancer Algorithm configured.

string
<= 1024 characters
malicious_user_detection_enabled
object
malicious_user_mitigation_enabled
object
malware_protection_enabled
object
mutual_tls_enabled
object
name
HTTP LB Name

Name of HTTP LB.

string
>= 6 characters <= 1024 characters
namespace
HTTP LB Namespace

Namespace of HTTP LB.

string
>= 6 characters <= 1024 characters
namespace_service_policy_enabled
object
origin_server_subset_enabled
object
private_advertisement_enabled
object
public_advertisment_enabled
object
rate_limit
object
routes_enabled
object
service_policy_enabled
object
slow_ddos_mitigation_enabled
object
tls_security_level
TLS Security Level

TLS Security Level.

string
<= 1024 characters
trusted_client_enabled
object
trusted_client_ip_headers_enabled
object
vip_type
VIP Type

VIP Type

string
<= 1024 characters
waf_enabled
object
waf_enforcement_mode
WAF Enforcement Mode

WAF Enforcement Mode.

string
<= 1024 characters
waf_exclusion_enabled
object
waf_policy_ref
WAF Policy Reference

Reference to the WAF policy (if applicable)

Array<object>
<= 1 items
ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string
>= 1 characters <= 128 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 64 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 64 characters
client_side_defense
Client Side Defense

Number of HTTP loadbalancers with Client Side Defense configured.

integer format: int64
ddos_protection
L7 DDoS Detection

Number of HTTP loadbalancers with L7 DDoS Detection enabled.

integer format: int64
http_only
HTTP Only

Number of HTTP Only loadbalancers.

integer format: int64
httplb_results
HTTP Loadbalancers

List of HTTP loadbalancers.

Array<object>
HTTPLoadbalancerResultType

HTTP Loadbalancer Inventory Results.

object
api_definition_enabled
object
api_discovery_enabled
object
api_protection_enabled
object
api_schema_validation_enabled
object
bot_protection_enabled
object
certification_expiration_date
Certification Expiration Date

Certification Expiration Date.

string format: date-time
<= 1024 characters
certification_status
Certification Status

Certification Status.

string
<= 1024 characters
client_blocking_enabled
object
client_side_defense_enabled
object
connection_idle_timeout
Connection Idle Timeout

Connection Idle Timeout.

integer format: int64
cookie_protection_enabled
object
cors_policy_enabled
object
csrf_protection_enabled
object
data_guard_enabled
object
ddos_auto_mitigation_enabled
object
ddos_mitigation_enabled
object
ddos_protection_enabled
object
default_loadbalancer_enabled
object
dns_info
DNS Info

DNS Info

string
<= 1024 characters
domains
Domains

Domains

Array<string>
graph_ql_inspection_enabled
object
http_enabled
object
http_listen_port_choice
HTTP Listen Port Choice

HTTP Listen Port Choice.

string
<= 1024 characters
idle_timeout
Idle Timeout

Idle Timeout.

integer format: int64
ip_reputation_enabled
object
loadbalancer_algorithm
Loadbalancer Algorithm

Loadbalancer Algorithm configured.

string
<= 1024 characters
malicious_user_detection_enabled
object
malicious_user_mitigation_enabled
object
malware_protection_enabled
object
mutual_tls_enabled
object
name
HTTP LB Name

Name of HTTP LB.

string
>= 6 characters <= 1024 characters
namespace
HTTP LB Namespace

Namespace of HTTP LB.

string
>= 6 characters <= 1024 characters
namespace_service_policy_enabled
object
origin_server_subset_enabled
object
private_advertisement_enabled
object
public_advertisment_enabled
object
rate_limit
object
routes_enabled
object
service_policy_enabled
object
slow_ddos_mitigation_enabled
object
tls_security_level
TLS Security Level

TLS Security Level.

string
<= 1024 characters
trusted_client_enabled
object
trusted_client_ip_headers_enabled
object
vip_type
VIP Type

VIP Type

string
<= 1024 characters
waf_enabled
object
waf_enforcement_mode
WAF Enforcement Mode

WAF Enforcement Mode.

string
<= 1024 characters
waf_exclusion_enabled
object
waf_policy_ref
WAF Policy Reference

Reference to the WAF policy (if applicable)

Array<object>
<= 1 items
ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string
>= 1 characters <= 128 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 64 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 64 characters
ip_reputation
IP Reputation

Number of HTTP loadbalancers with IP Reputation configured.

integer format: int64
malicious_user_detection
Malicious User Detection

Number of HTTP loadbalancers with Malicious User Detection configured.

integer format: int64
malware_protection
Malware Protection

Number of HTTP loadbalancers with Malware Protection configured.

integer format: int64
namespace_service_policy
Namespace Service Policy

Number of HTTP loadbalancers with Namespace Service Policy configured.

integer format: int64
private_advertisement
Private Advertisement

Number of HTTP loadbalancers advertised privately.

integer format: int64
public_advertisment
Public Advertisement

Number of HTTP loadbalancers advertised publicly.

integer format: int64
service_policy
Service Policy

Number of HTTP loadbalancers with Service Policy configured.

integer format: int64
waf
WAF

Number of HTTP loadbalancers with WAF configured.

integer format: int64
http_loadbalancers
object
api_discovery
API Discovery

Number of HTTP loadbalancers with API Discovery enabled.

integer format: int64
api_protection
API Protection

Number of HTTP loadbalancers with API Protection configured.

integer format: int64
bot_protection
Bot Protection

Number of HTTP loadbalancers with Bot Protection configured.

integer format: int64
cdnlb_results
CDN Loadbalancers

List of CDN loadbalancers.

Array<object>
HTTPLoadbalancerResultType

HTTP Loadbalancer Inventory Results.

object
api_definition_enabled
object
api_discovery_enabled
object
api_protection_enabled
object
api_schema_validation_enabled
object
bot_protection_enabled
object
certification_expiration_date
Certification Expiration Date

Certification Expiration Date.

string format: date-time
<= 1024 characters
certification_status
Certification Status

Certification Status.

string
<= 1024 characters
client_blocking_enabled
object
client_side_defense_enabled
object
connection_idle_timeout
Connection Idle Timeout

Connection Idle Timeout.

integer format: int64
cookie_protection_enabled
object
cors_policy_enabled
object
csrf_protection_enabled
object
data_guard_enabled
object
ddos_auto_mitigation_enabled
object
ddos_mitigation_enabled
object
ddos_protection_enabled
object
default_loadbalancer_enabled
object
dns_info
DNS Info

DNS Info

string
<= 1024 characters
domains
Domains

Domains

Array<string>
graph_ql_inspection_enabled
object
http_enabled
object
http_listen_port_choice
HTTP Listen Port Choice

HTTP Listen Port Choice.

string
<= 1024 characters
idle_timeout
Idle Timeout

Idle Timeout.

integer format: int64
ip_reputation_enabled
object
loadbalancer_algorithm
Loadbalancer Algorithm

Loadbalancer Algorithm configured.

string
<= 1024 characters
malicious_user_detection_enabled
object
malicious_user_mitigation_enabled
object
malware_protection_enabled
object
mutual_tls_enabled
object
name
HTTP LB Name

Name of HTTP LB.

string
>= 6 characters <= 1024 characters
namespace
HTTP LB Namespace

Namespace of HTTP LB.

string
>= 6 characters <= 1024 characters
namespace_service_policy_enabled
object
origin_server_subset_enabled
object
private_advertisement_enabled
object
public_advertisment_enabled
object
rate_limit
object
routes_enabled
object
service_policy_enabled
object
slow_ddos_mitigation_enabled
object
tls_security_level
TLS Security Level

TLS Security Level.

string
<= 1024 characters
trusted_client_enabled
object
trusted_client_ip_headers_enabled
object
vip_type
VIP Type

VIP Type

string
<= 1024 characters
waf_enabled
object
waf_enforcement_mode
WAF Enforcement Mode

WAF Enforcement Mode.

string
<= 1024 characters
waf_exclusion_enabled
object
waf_policy_ref
WAF Policy Reference

Reference to the WAF policy (if applicable)

Array<object>
<= 1 items
ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string
>= 1 characters <= 128 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 64 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 64 characters
client_side_defense
Client Side Defense

Number of HTTP loadbalancers with Client Side Defense configured.

integer format: int64
ddos_protection
L7 DDoS Detection

Number of HTTP loadbalancers with L7 DDoS Detection enabled.

integer format: int64
http_only
HTTP Only

Number of HTTP Only loadbalancers.

integer format: int64
httplb_results
HTTP Loadbalancers

List of HTTP loadbalancers.

Array<object>
HTTPLoadbalancerResultType

HTTP Loadbalancer Inventory Results.

object
api_definition_enabled
object
api_discovery_enabled
object
api_protection_enabled
object
api_schema_validation_enabled
object
bot_protection_enabled
object
certification_expiration_date
Certification Expiration Date

Certification Expiration Date.

string format: date-time
<= 1024 characters
certification_status
Certification Status

Certification Status.

string
<= 1024 characters
client_blocking_enabled
object
client_side_defense_enabled
object
connection_idle_timeout
Connection Idle Timeout

Connection Idle Timeout.

integer format: int64
cookie_protection_enabled
object
cors_policy_enabled
object
csrf_protection_enabled
object
data_guard_enabled
object
ddos_auto_mitigation_enabled
object
ddos_mitigation_enabled
object
ddos_protection_enabled
object
default_loadbalancer_enabled
object
dns_info
DNS Info

DNS Info

string
<= 1024 characters
domains
Domains

Domains

Array<string>
graph_ql_inspection_enabled
object
http_enabled
object
http_listen_port_choice
HTTP Listen Port Choice

HTTP Listen Port Choice.

string
<= 1024 characters
idle_timeout
Idle Timeout

Idle Timeout.

integer format: int64
ip_reputation_enabled
object
loadbalancer_algorithm
Loadbalancer Algorithm

Loadbalancer Algorithm configured.

string
<= 1024 characters
malicious_user_detection_enabled
object
malicious_user_mitigation_enabled
object
malware_protection_enabled
object
mutual_tls_enabled
object
name
HTTP LB Name

Name of HTTP LB.

string
>= 6 characters <= 1024 characters
namespace
HTTP LB Namespace

Namespace of HTTP LB.

string
>= 6 characters <= 1024 characters
namespace_service_policy_enabled
object
origin_server_subset_enabled
object
private_advertisement_enabled
object
public_advertisment_enabled
object
rate_limit
object
routes_enabled
object
service_policy_enabled
object
slow_ddos_mitigation_enabled
object
tls_security_level
TLS Security Level

TLS Security Level.

string
<= 1024 characters
trusted_client_enabled
object
trusted_client_ip_headers_enabled
object
vip_type
VIP Type

VIP Type

string
<= 1024 characters
waf_enabled
object
waf_enforcement_mode
WAF Enforcement Mode

WAF Enforcement Mode.

string
<= 1024 characters
waf_exclusion_enabled
object
waf_policy_ref
WAF Policy Reference

Reference to the WAF policy (if applicable)

Array<object>
<= 1 items
ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string
>= 1 characters <= 128 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 64 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 64 characters
ip_reputation
IP Reputation

Number of HTTP loadbalancers with IP Reputation configured.

integer format: int64
malicious_user_detection
Malicious User Detection

Number of HTTP loadbalancers with Malicious User Detection configured.

integer format: int64
malware_protection
Malware Protection

Number of HTTP loadbalancers with Malware Protection configured.

integer format: int64
namespace_service_policy
Namespace Service Policy

Number of HTTP loadbalancers with Namespace Service Policy configured.

integer format: int64
private_advertisement
Private Advertisement

Number of HTTP loadbalancers advertised privately.

integer format: int64
public_advertisment
Public Advertisement

Number of HTTP loadbalancers advertised publicly.

integer format: int64
service_policy
Service Policy

Number of HTTP loadbalancers with Service Policy configured.

integer format: int64
waf
WAF

Number of HTTP loadbalancers with WAF configured.

integer format: int64
loadbalancers
Load Balancers

Number of HTTP and TCP Load Balancers configured.

integer format: int64
nginx_one_servers
object
api_discovery_enabled_server_count
API Discovery

Number of NGINX One Servers with API Discovery enabled.

integer format: int64
nginx_server_results
NGINX One Servers

List of NGINX One Server.

Array<object>
object
api_discovery_enabled
object
domains
Nginx One Server Domains

Domains of NGINX One Server.

Array<string>
name
Name

Uniqueness identifier for NGINX One Server.

string
>= 6 characters <= 1024 characters
nginx_one_object_id
NGINX One Object Id

Instance or Config Sync Group ID.

string
<= 1024 characters
nginx_one_object_name
NGINX One Object Name

Hostname value set for Instance or Name for a Config Sync Group in NGINX One.

string
<= 1024 characters
nginx_one_server_name
Nginx One Server Name

Server name specified as ${server_name} in NGINX config plus port.

string
<= 1024 characters
total_routes
Total locations configured in the NGINX Server

Total locations configured in the NGINX Server.

integer format: int64
waf_enforcement_mode
WAF Enforcement Mode

WAF Enforcement Mode.

string
<= 1024 characters
waf_policy_file_name
Waf Policy File Names

Policy file name for WAF.

string
<= 1024 characters
waf_policy_management_platform
WAF policy_management_platform

Specifies the platform that manages related WAF policies

Required: YES.

string
<= 1024 characters
waf_policy_name
Waf Policy Name

Policy name configured for WAF.

string
<= 1024 characters
waf_security_log_enabled
security_log_enabled

Specifies if security logging is enabled.

boolean format: boolean
waf_security_log_file_names
WAF Security File Names

WAF Security File Names.

Array<string>
waf_enabled_server_count
WAF

Number of NGINX One Servers with WAF configured.

integer format: int64
origin_pools
Origin Pools

Number of origin pools configured.

integer format: int64
services_discovered
Services Discovered

Number of services discovered.

integer format: int64
tcp_loadbalancers
object
namespace_service_policy
Namespace Service Policy

Number of TCP loadbalancers with Namespace Service Policy configured.

integer format: int64
private_advertisement
Private Advertisement

Number of TCP loadbalancers advertised privately.

integer format: int64
public_advertisment
Public Advertisement

Number of TCP loadbalancers advertised publicly.

integer format: int64
service_policy
Service Policy

Number of TCP loadbalancers with Service Policy configured.

integer format: int64
tcplb_results
TCP Loadbalancers

List of TCP loadbalancers.

Array<object>
TCPLoadbalancerResultType

TCP Loadbalancer Inventory Results.

object
name
TCP LB Name

Name of TCP LB.

string
>= 6 characters <= 1024 characters
namespace
TCP LB Namespace

Namespace of TCP LB.

string
>= 6 characters <= 1024 characters
namespace_service_policy
object
private_advertisement
object
public_advertisment
object
rate_limit
object
service_policy
object
tls_encryption
object
tls_encryption
TLS Encryption

Number of TCP loadbalancers with TLS Encryption configured.

integer format: int64
third_party_applications
object
api_discovery
API Discovery

Number of Third Party Application with API Discovery enabled.

integer format: int64
third_party_application_results
ThirdPartyApplicationType

List of Third Party Applications.

Array<object>
ThirdPartyApplicationType

Third Party Application Inventory Results.

object
api_discovery_enabled
object
name
Third Party Application Name

Name of Third Party Application.

string
>= 6 characters <= 1024 characters
udp_loadbalancers
object
private_advertisement
Private Advertisement

Number of UDP loadbalancers advertised privately.

integer format: int64
public_advertisment
Public Advertisement

Number of UDP loadbalancers advertised publicly.

integer format: int64
udplb_results
UDP Loadbalancers

List of UDP loadbalancers.

Array<object>
UDPLoadbalancerResultType

UDP Loadbalancer Inventory Results.

object
name
UDP LB Name

Name of UDP LB.

string
>= 6 characters <= 1024 characters
namespace
UDP LB Namespace

Namespace of UDP LB.

string
>= 6 characters <= 1024 characters
private_advertisement
object
public_advertisment
object
namespace_service_policy
object
service_policy
object
namespace_service_policy
Namespace Service Policy

Number of UDP loadbalancers with Namespace Service Policy configured.

integer format: int64
service_policy
Service Policy

Number of UDP loadbalancers with Service Policy configured.

integer format: int64
Examplegenerated
{
"bigip_virtual_servers": {
"api_discovery": 1,
"bigiplb_results": [
{
"api_discovery_enabled": {},
"description": "example",
"host_name": "example",
"name": "example",
"server_name": "example",
"version": "example",
"waf_enforcement_mode": "example",
"waf_policy_name": "example",
"namespace": "example"
}
],
"waf_configured": 1
},
"cdn_loadbalancers": {
"api_discovery": 1,
"api_protection": 1,
"bot_protection": 1,
"cdnlb_results": [
{
"api_definition_enabled": {},
"api_discovery_enabled": {},
"api_protection_enabled": {},
"api_schema_validation_enabled": {},
"bot_protection_enabled": {},
"certification_expiration_date": "2026-04-15T12:00:00Z",
"certification_status": "example",
"client_blocking_enabled": {},
"client_side_defense_enabled": {},
"connection_idle_timeout": 1,
"cookie_protection_enabled": {},
"cors_policy_enabled": {},
"csrf_protection_enabled": {},
"data_guard_enabled": {},
"ddos_auto_mitigation_enabled": {},
"ddos_mitigation_enabled": {},
"ddos_protection_enabled": {},
"default_loadbalancer_enabled": {},
"dns_info": "example",
"domains": [
"example"
],
"graph_ql_inspection_enabled": {},
"http_enabled": {},
"http_listen_port_choice": "example",
"idle_timeout": 1,
"ip_reputation_enabled": {},
"loadbalancer_algorithm": "example",
"malicious_user_detection_enabled": {},
"malicious_user_mitigation_enabled": {},
"malware_protection_enabled": {},
"mutual_tls_enabled": {},
"name": "example",
"namespace": "example",
"namespace_service_policy_enabled": {},
"origin_server_subset_enabled": {},
"private_advertisement_enabled": {},
"public_advertisment_enabled": {},
"rate_limit": {},
"routes_enabled": {},
"service_policy_enabled": {},
"slow_ddos_mitigation_enabled": {},
"tls_security_level": "example",
"trusted_client_enabled": {},
"trusted_client_ip_headers_enabled": {},
"vip_type": "example",
"waf_enabled": {},
"waf_enforcement_mode": "example",
"waf_exclusion_enabled": {},
"waf_policy_ref": [
{
"name": "example",
"namespace": "example"
}
]
}
],
"client_side_defense": 1,
"ddos_protection": 1,
"http_only": 1,
"httplb_results": [
{
"api_definition_enabled": {},
"api_discovery_enabled": {},
"api_protection_enabled": {},
"api_schema_validation_enabled": {},
"bot_protection_enabled": {},
"certification_expiration_date": "2026-04-15T12:00:00Z",
"certification_status": "example",
"client_blocking_enabled": {},
"client_side_defense_enabled": {},
"connection_idle_timeout": 1,
"cookie_protection_enabled": {},
"cors_policy_enabled": {},
"csrf_protection_enabled": {},
"data_guard_enabled": {},
"ddos_auto_mitigation_enabled": {},
"ddos_mitigation_enabled": {},
"ddos_protection_enabled": {},
"default_loadbalancer_enabled": {},
"dns_info": "example",
"domains": [
"example"
],
"graph_ql_inspection_enabled": {},
"http_enabled": {},
"http_listen_port_choice": "example",
"idle_timeout": 1,
"ip_reputation_enabled": {},
"loadbalancer_algorithm": "example",
"malicious_user_detection_enabled": {},
"malicious_user_mitigation_enabled": {},
"malware_protection_enabled": {},
"mutual_tls_enabled": {},
"name": "example",
"namespace": "example",
"namespace_service_policy_enabled": {},
"origin_server_subset_enabled": {},
"private_advertisement_enabled": {},
"public_advertisment_enabled": {},
"rate_limit": {},
"routes_enabled": {},
"service_policy_enabled": {},
"slow_ddos_mitigation_enabled": {},
"tls_security_level": "example",
"trusted_client_enabled": {},
"trusted_client_ip_headers_enabled": {},
"vip_type": "example",
"waf_enabled": {},
"waf_enforcement_mode": "example",
"waf_exclusion_enabled": {},
"waf_policy_ref": [
{
"name": "example",
"namespace": "example"
}
]
}
],
"ip_reputation": 1,
"malicious_user_detection": 1,
"malware_protection": 1,
"namespace_service_policy": 1,
"private_advertisement": 1,
"public_advertisment": 1,
"service_policy": 1,
"waf": 1
},
"http_loadbalancers": {
"api_discovery": 1,
"api_protection": 1,
"bot_protection": 1,
"cdnlb_results": [
{
"api_definition_enabled": {},
"api_discovery_enabled": {},
"api_protection_enabled": {},
"api_schema_validation_enabled": {},
"bot_protection_enabled": {},
"certification_expiration_date": "2026-04-15T12:00:00Z",
"certification_status": "example",
"client_blocking_enabled": {},
"client_side_defense_enabled": {},
"connection_idle_timeout": 1,
"cookie_protection_enabled": {},
"cors_policy_enabled": {},
"csrf_protection_enabled": {},
"data_guard_enabled": {},
"ddos_auto_mitigation_enabled": {},
"ddos_mitigation_enabled": {},
"ddos_protection_enabled": {},
"default_loadbalancer_enabled": {},
"dns_info": "example",
"domains": [
"example"
],
"graph_ql_inspection_enabled": {},
"http_enabled": {},
"http_listen_port_choice": "example",
"idle_timeout": 1,
"ip_reputation_enabled": {},
"loadbalancer_algorithm": "example",
"malicious_user_detection_enabled": {},
"malicious_user_mitigation_enabled": {},
"malware_protection_enabled": {},
"mutual_tls_enabled": {},
"name": "example",
"namespace": "example",
"namespace_service_policy_enabled": {},
"origin_server_subset_enabled": {},
"private_advertisement_enabled": {},
"public_advertisment_enabled": {},
"rate_limit": {},
"routes_enabled": {},
"service_policy_enabled": {},
"slow_ddos_mitigation_enabled": {},
"tls_security_level": "example",
"trusted_client_enabled": {},
"trusted_client_ip_headers_enabled": {},
"vip_type": "example",
"waf_enabled": {},
"waf_enforcement_mode": "example",
"waf_exclusion_enabled": {},
"waf_policy_ref": [
{
"name": "example",
"namespace": "example"
}
]
}
],
"client_side_defense": 1,
"ddos_protection": 1,
"http_only": 1,
"httplb_results": [
{
"api_definition_enabled": {},
"api_discovery_enabled": {},
"api_protection_enabled": {},
"api_schema_validation_enabled": {},
"bot_protection_enabled": {},
"certification_expiration_date": "2026-04-15T12:00:00Z",
"certification_status": "example",
"client_blocking_enabled": {},
"client_side_defense_enabled": {},
"connection_idle_timeout": 1,
"cookie_protection_enabled": {},
"cors_policy_enabled": {},
"csrf_protection_enabled": {},
"data_guard_enabled": {},
"ddos_auto_mitigation_enabled": {},
"ddos_mitigation_enabled": {},
"ddos_protection_enabled": {},
"default_loadbalancer_enabled": {},
"dns_info": "example",
"domains": [
"example"
],
"graph_ql_inspection_enabled": {},
"http_enabled": {},
"http_listen_port_choice": "example",
"idle_timeout": 1,
"ip_reputation_enabled": {},
"loadbalancer_algorithm": "example",
"malicious_user_detection_enabled": {},
"malicious_user_mitigation_enabled": {},
"malware_protection_enabled": {},
"mutual_tls_enabled": {},
"name": "example",
"namespace": "example",
"namespace_service_policy_enabled": {},
"origin_server_subset_enabled": {},
"private_advertisement_enabled": {},
"public_advertisment_enabled": {},
"rate_limit": {},
"routes_enabled": {},
"service_policy_enabled": {},
"slow_ddos_mitigation_enabled": {},
"tls_security_level": "example",
"trusted_client_enabled": {},
"trusted_client_ip_headers_enabled": {},
"vip_type": "example",
"waf_enabled": {},
"waf_enforcement_mode": "example",
"waf_exclusion_enabled": {},
"waf_policy_ref": [
{
"name": "example",
"namespace": "example"
}
]
}
],
"ip_reputation": 1,
"malicious_user_detection": 1,
"malware_protection": 1,
"namespace_service_policy": 1,
"private_advertisement": 1,
"public_advertisment": 1,
"service_policy": 1,
"waf": 1
},
"loadbalancers": 1,
"nginx_one_servers": {
"api_discovery_enabled_server_count": 1,
"nginx_server_results": [
{
"api_discovery_enabled": {},
"domains": [
"example"
],
"name": "example",
"nginx_one_object_id": "example",
"nginx_one_object_name": "example",
"nginx_one_server_name": "example",
"total_routes": 1,
"waf_enforcement_mode": "example",
"waf_policy_file_name": "example",
"waf_policy_management_platform": "example",
"waf_policy_name": "example",
"waf_security_log_enabled": true,
"waf_security_log_file_names": [
"example"
]
}
],
"waf_enabled_server_count": 1
},
"origin_pools": 1,
"services_discovered": 1,
"tcp_loadbalancers": {
"namespace_service_policy": 1,
"private_advertisement": 1,
"public_advertisment": 1,
"service_policy": 1,
"tcplb_results": [
{
"name": "example",
"namespace": "example",
"namespace_service_policy": {},
"private_advertisement": {},
"public_advertisment": {},
"rate_limit": {},
"service_policy": {},
"tls_encryption": {}
}
],
"tls_encryption": 1
},
"third_party_applications": {
"api_discovery": 1,
"third_party_application_results": [
{
"api_discovery_enabled": {},
"name": "example"
}
]
},
"udp_loadbalancers": {
"private_advertisement": 1,
"public_advertisment": 1,
"udplb_results": [
{
"name": "example",
"namespace": "example",
"private_advertisement": {},
"public_advertisment": {},
"namespace_service_policy": {},
"service_policy": {}
}
],
"namespace_service_policy": 1,
"service_policy": 1
}
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example