⚖️ Virtual API
Traffic distribution across regions with routing rules. Health checks and failover policies.
- Category: Networking
- Complexity: advanced
- Paths: 133 | Schemas: 903
- Tier: Advanced
- Related domains:
dns,service_policy,network
Use Cases
Section titled “Use Cases”- Configure HTTP/TCP/UDP load balancers
- Manage origin pools and services
- Configure virtual hosts and routing
- Define rate limiter and service policies
- Manage geo-location-based routing
- Configure proxy and forwarding policies
- Manage malware protection and threat campaigns
- Configure health checks and endpoint monitoring
Primary Resources
Section titled “Primary Resources”- http_loadbalancer: Layer 7 HTTP/HTTPS load balancer for application traffic distribution
- tcp_loadbalancer: Layer 4 TCP/UDP load balancer for non-HTTP protocol traffic
- origin_pool: Backend server group for load balancer traffic distribution
- healthcheck: Health monitoring configuration for origin server availability
- app_firewall: Web Application Firewall policy for HTTP traffic protection
- service_policy: Service-level access control and traffic management rules
- malicious_user_detection: Automated detection and mitigation of malicious user behavior
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| POST | /api/data/namespaces/system/app_firewall/all_ns_metrics | MetricsAllNamespaces. |
| POST | /api/config/namespaces/{metadata.namespace}/app_firewalls | Create Application Firewall. |
| PUT | /api/config/namespaces/{metadata.namespace}/app_firewalls/{metadata.name} | Replace Application Firewall. |
| POST | /api/data/namespaces/{namespace}/app_firewall/metrics | Metrics |
| GET | /api/config/namespaces/{namespace}/app_firewalls | List Application Firewall. |
| GET | /api/config/namespaces/{namespace}/app_firewalls/{name} | GET Application Firewall. |
| DELETE | /api/config/namespaces/{namespace}/app_firewalls/{name} | DELETE Application Firewall. |
| POST | /api/data/namespaces/system/app_security/all_ns_events | Security Events Query All Namespaces. |
| POST | /api/data/namespaces/system/app_security/all_ns_events/aggregation | Security Events Aggregation Query All Namespaces. |
| POST | /api/data/namespaces/system/app_security/all_ns_search/loadbalancers | Search load balancers All Namespaces. |
| POST | /api/data/namespaces/{namespace}/app_security/events | Security Events Query. |
| POST | /api/data/namespaces/{namespace}/app_security/events/aggregation | Security Events Aggregation Query. |
| GET | /api/data/namespaces/{namespace}/app_security/events/scroll | Security Event Scroll Query. |
| POST | /api/data/namespaces/{namespace}/app_security/events/scroll | Security Event Scroll Query. |
| POST | /api/data/namespaces/{namespace}/app_security/incidents | Security Incidents Query. |
| POST | /api/data/namespaces/{namespace}/app_security/incidents/aggregation | Security Incidents Aggregation Query. |
| GET | /api/data/namespaces/{namespace}/app_security/incidents/scroll | Security Incidents Scroll Query. |
| POST | /api/data/namespaces/{namespace}/app_security/incidents/scroll | Security Incidents Scroll Query. |
| POST | /api/data/namespaces/{namespace}/app_security/metrics | Security Events Metrics. |
| POST | /api/data/namespaces/{namespace}/app_security/search/loadbalancers | Search load balancers. |
| POST | /api/data/namespaces/{namespace}/app_security/suspicious_user_logs | Suspicious User Logs Query. |
| POST | /api/data/namespaces/{namespace}/app_security/suspicious_user_logs/aggregation | Suspicious User Logs Aggregation Query. |
| GET | /api/data/namespaces/{namespace}/app_security/suspicious_user_logs/scroll | Suspicious User Logs Scroll Query. |
| POST | /api/data/namespaces/{namespace}/app_security/suspicious_user_logs/scroll | Suspicious User Logs Scroll Query. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/api_endpoint_protection/suggestion | Suggest API endpoint protection rule. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/block_client/suggestion | Suggest block client rule. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/data_exposure/suggestion | Suggest sensitive data rule. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/ddos_mitigation/suggestion | Suggest DDoS Mitigation rule. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/oas_validation/suggestion | Suggest Open API specification validation rule. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/rate_limit/suggestion | Suggest rate limit rule. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/trust_client/suggestion | Suggest trust client rule. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/waf_exclusion/suggestion | Suggest WAF Exclusion Rule. |
| POST | /api/config/namespaces/{metadata.namespace}/clusters | Create Cluster. |
| PUT | /api/config/namespaces/{metadata.namespace}/clusters/{metadata.name} | Replace Cluster. |
| GET | /api/config/namespaces/{namespace}/clusters | List Cluster. |
| GET | /api/config/namespaces/{namespace}/clusters/{name} | GET Cluster. |
| DELETE | /api/config/namespaces/{namespace}/clusters/{name} | DELETE Cluster. |
| POST | /api/config/namespaces/{metadata.namespace}/http_loadbalancers | Create HTTP Load Balancer. |
| PUT | /api/config/namespaces/{metadata.namespace}/http_loadbalancers/{metadata.name} | Replace HTTP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/http_loadbalancers | List Configure HTTP Load Balancer. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/get_security_config | GET Security Config for HTTP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/http_loadbalancers/{name} | GET HTTP Load Balancer. |
| DELETE | /api/config/namespaces/{namespace}/http_loadbalancers/{name} | DELETE Configure HTTP Load Balancer. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/api_definitions/assign | Assign API Definition. |
| GET | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/api_definitions/available | List Available API Definitions. |
| POST | /api/ml/data/namespaces/{namespace}/http_loadbalancers/{name}/api_endpoints | GET API Endpoints. |
| GET | /api/ml/data/namespaces/{namespace}/http_loadbalancers/{name}/api_endpoints/swagger_spec | GET Swagger Spec for HTTP Load Balancer. |
| POST | /api/ml/data/namespaces/{namespace}/http_loadbalancers/{name}/api_inventory/api_endpoints/get_schema_updates | GET API Endpoints Schema Updates. |
| POST | /api/ml/data/namespaces/{namespace}/http_loadbalancers/{name}/api_inventory/api_endpoints/update_schemas | Update API Endpoints Schemas. |
| GET | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/dos_automitigation_rules | GET DoS Auto-Mitigation Rules for HTTP Load Balancer. |
| DELETE | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/dos_automitigation_rules/{dos_automitigation_rule_name} | DELETE DoS Auto-Mitigation Rule for HTTP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/get-dns-info | GET DNS Info. |
| POST | /api/config/namespaces/{namespace}/http_loadbalancers/{name}/l7ddos_rps_threshold | Set L7 DDoS RPS Threshold. |
| POST | /api/config/namespaces/{metadata.namespace}/protocol_inspections | Create Protocol Inspection. |
| PUT | /api/config/namespaces/{metadata.namespace}/protocol_inspections/{metadata.name} | Replace Protocol Inspection. |
| GET | /api/config/namespaces/{namespace}/protocol_inspections | List Configure Protocol Inspection. |
| GET | /api/config/namespaces/{namespace}/protocol_inspections/{name} | GET Protocol Inspection. |
| DELETE | /api/config/namespaces/{namespace}/protocol_inspections/{name} | DELETE Configure Protocol Inspection. |
| POST | /api/config/namespaces/{metadata.namespace}/tcp_loadbalancers | Create TCP Load Balancer. |
| PUT | /api/config/namespaces/{metadata.namespace}/tcp_loadbalancers/{metadata.name} | Replace TCP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/tcp_loadbalancers | List Configure TCP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/tcp_loadbalancers/{name} | GET TCP Load Balancer. |
| DELETE | /api/config/namespaces/{namespace}/tcp_loadbalancers/{name} | DELETE Configure TCP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/tcp_loadbalancers/{name}/get-dns-info | GET DNS Info. |
| POST | /api/config/namespaces/{metadata.namespace}/udp_loadbalancers | Create UDP Load Balancer. |
| PUT | /api/config/namespaces/{metadata.namespace}/udp_loadbalancers/{metadata.name} | Replace UDP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/udp_loadbalancers | List Configure UDP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/udp_loadbalancers/{name} | GET UDP Load Balancer. |
| DELETE | /api/config/namespaces/{namespace}/udp_loadbalancers/{name} | DELETE Configure UDP Load Balancer. |
| GET | /api/config/namespaces/{namespace}/udp_loadbalancers/{name}/get-dns-info | GET DNS Info. |
| POST | /api/config/namespaces/{metadata.namespace}/enhanced_firewall_policys | Create Enhanced Firewall Policy. |
| PUT | /api/config/namespaces/{metadata.namespace}/enhanced_firewall_policys/{metadata.name} | Replace Enhanced Firewall Policy. |
| POST | /api/data/namespaces/{namespace}/enhanced_firewall_policy/hits | Enhanced Firewall Policy Hits. |
| GET | /api/config/namespaces/{namespace}/enhanced_firewall_policys | List Enhanced Firewall Policy. |
| GET | /api/config/namespaces/{namespace}/enhanced_firewall_policys/{name} | GET Enhanced Firewall Policy. |
| DELETE | /api/config/namespaces/{namespace}/enhanced_firewall_policys/{name} | DELETE Enhanced Firewall Policy. |
| POST | /api/config/namespaces/system/malware_protection/addon/subscribe | Subscribe to Malware Protection. |
| POST | /api/config/namespaces/system/malware_protection/addon/unsubscribe | Unsubscribe to Malware Protection. |
| POST | /api/config/dns/namespaces/{metadata.namespace}/geo_location_sets | Create Geolocation. |
| PUT | /api/config/dns/namespaces/{metadata.namespace}/geo_location_sets/{metadata.name} | Replace Geolocation Set. |
| GET | /api/config/dns/namespaces/{namespace}/geo_location_sets | List Geolocation Set. |
| GET | /api/config/dns/namespaces/{namespace}/geo_location_sets/{name} | GET Geolocation Set. |
| DELETE | /api/config/dns/namespaces/{namespace}/geo_location_sets/{name} | DELETE Geolocation Set. |
| POST | /api/config/namespaces/{metadata.namespace}/healthchecks | Create Health Check. |
| PUT | /api/config/namespaces/{metadata.namespace}/healthchecks/{metadata.name} | Replace Health Check. |
| GET | /api/config/namespaces/{namespace}/healthchecks | List Health Check. |
| GET | /api/config/namespaces/{namespace}/healthchecks/{name} | GET Health Check. |
| DELETE | /api/config/namespaces/{namespace}/healthchecks/{name} | DELETE Health Check. |
| POST | /api/config/namespaces/{metadata.namespace}/origin_pools | Create Origin Pool. |
| PUT | /api/config/namespaces/{metadata.namespace}/origin_pools/{metadata.name} | Replace Origin Pool. |
| GET | /api/config/namespaces/{namespace}/origin_pools | List Origin Pool. |
| GET | /api/config/namespaces/{namespace}/origin_pools/{name} | GET Origin Pool. |
| DELETE | /api/config/namespaces/{namespace}/origin_pools/{name} | DELETE Origin Pool. |
| POST | /api/config/namespaces/{metadata.namespace}/proxies | Create Proxy. |
| PUT | /api/config/namespaces/{metadata.namespace}/proxies/{metadata.name} | Replace Proxy. |
| GET | /api/config/namespaces/{namespace}/proxies | List Proxy. |
| GET | /api/config/namespaces/{namespace}/proxies/{name} | GET Proxy |
| DELETE | /api/config/namespaces/{namespace}/proxies/{name} | DELETE Proxy. |
| GET | /api/config/namespaces/{namespace}/proxies/{name}/ca_certificate | GET proxy Server CA Certificate. |
| POST | /api/config/namespaces/{metadata.namespace}/rate_limiter_policys | Create Specification. |
| PUT | /api/config/namespaces/{metadata.namespace}/rate_limiter_policys/{metadata.name} | Replace Specification. |
| GET | /api/config/namespaces/{namespace}/rate_limiter_policys | List Rate Limiter Policy. |
| GET | /api/config/namespaces/{namespace}/rate_limiter_policys/{name} | GET Specification. |
| DELETE | /api/config/namespaces/{namespace}/rate_limiter_policys/{name} | DELETE Rate Limiter Policy. |
| POST | /api/config/namespaces/{metadata.namespace}/service_policys | Create Service Policy. |
| PUT | /api/config/namespaces/{metadata.namespace}/service_policys/{metadata.name} | Replace Service Policy. |
| GET | /api/config/namespaces/{namespace}/service_policys | List Service Policy. |
| GET | /api/config/namespaces/{namespace}/service_policys/{name} | GET Service Policy. |
| DELETE | /api/config/namespaces/{namespace}/service_policys/{name} | DELETE Service Policy. |
| POST | /api/config/namespaces/{metadata.namespace}/service_policy_rules | Create Service Policy Rule. |
| PUT | /api/config/namespaces/{metadata.namespace}/service_policy_rules/{metadata.name} | Replace Service Policy Rule. |
| GET | /api/config/namespaces/{namespace}/service_policy_rules | List Service Policy Rule. |
| GET | /api/config/namespaces/{namespace}/service_policy_rules/{name} | GET Service Policy Rule. |
| DELETE | /api/config/namespaces/{namespace}/service_policy_rules/{name} | DELETE Service Policy Rule. |
| GET | /api/config/namespaces/{namespace}/service_policy_sets | List Service Policy Set. |
| GET | /api/config/namespaces/{namespace}/service_policy_sets/{name} | GET Service Policy Set. |
| POST | /api/config/namespaces/{metadata.namespace}/virtual_hosts | Create Virtual Host. |
| PUT | /api/config/namespaces/{metadata.namespace}/virtual_hosts/{metadata.name} | Replace Virtual Host. |
| GET | /api/config/namespaces/{namespace}/virtual_hosts | List Virtual Host. |
| GET | /api/config/namespaces/{namespace}/virtual_hosts/{name} | GET Virtual Host. |
| DELETE | /api/config/namespaces/{namespace}/virtual_hosts/{name} | DELETE Virtual Host. |
| POST | /api/config/namespaces/{namespace}/virtual_hosts/{name}/api_definitions/assign | Assign API Definition. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint | GET API Endpoint. |
| GET | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint/learnt_schema | GET GET Learnt Schema per API endpoint. |
| GET | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint/pdf | GET API Endpoint PDF. |
| GET | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint/sources_openapi_schema | GET relevant source OpenApi schema per API endpoint. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint/unmerge_sources_openapi_schema | Unmerge Source from API Endpoint. |
| GET | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints | GET API Endpoints. |
| GET | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/stats | GET API Endpoints Stats for Virtual Host. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/summary/calls_by_response_code | GET Total API Calls for Virtual Host. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/summary/top_active | GET Top APIs Endpoints for Virtual Host. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/summary/top_sensitive_data | GET Sensitive Data Summary for Virtual Host. |
| GET | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/swagger_spec | GET Swagger Spec for App Type. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_inventory/api_endpoints/get_schema_updates | GET API Endpoints Schema Updates. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_inventory/api_endpoints/update_schemas | Update API Endpoints Schemas. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/create_ticket | Create a ticket for a vulnerability. |
| GET | /api/config/namespaces/{namespace}/virtual_hosts/{name}/get-dns-info | GET DNS Info. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/unlink_tickets | Unlink Tickets. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/vulnerabilities | GET Vulnerabilities for Virtual Host. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/vulnerability/update_state | Update Vulnerabilities for Virtual Host. |
| POST | /api/data/namespaces/{namespace}/wafs/metrics/client/rule_hits | Client Rule Hits Metrics. |
| POST | /api/data/namespaces/{namespace}/wafs/metrics/client/security_events | Client Security Events Metrics. |
| POST | /api/data/namespaces/{namespace}/wafs/metrics/server/rule_hits | Server Rule Hits Metrics. |
| POST | /api/data/namespaces/{namespace}/wafs/metrics/server/security_events | Server Security Events Metrics. |
| POST | /api/config/namespaces/{metadata.namespace}/waf_exclusion_policys | Create WAF Exclusion Policy. |
| PUT | /api/config/namespaces/{metadata.namespace}/waf_exclusion_policys/{metadata.name} | Replace WAF Exclusion Policy. |
| GET | /api/config/namespaces/{namespace}/waf_exclusion_policys | List WAF Exclusion Policy. |
| GET | /api/config/namespaces/{namespace}/waf_exclusion_policys/{name} | GET WAF Exclusion Policy. |
| DELETE | /api/config/namespaces/{namespace}/waf_exclusion_policys/{name} | DELETE WAF Exclusion Policy. |
| GET | /api/config/namespaces/{namespace}/virtual_hosts/{vh_name}/active_staged_signatures | Active Staged Signatures. |
| GET | /api/config/namespaces/{namespace}/virtual_hosts/{vh_name}/released_signatures | Released Signatures. |
| POST | /api/ml/data/namespaces/{namespace}/virtual_hosts/{vh_name}/staged_signatures | Staged Signatures. |