🌍 Sites API
AWS, Azure, GCP VPC integration with transit gateways. Label-based selection for policy application across regions.
- Category: Infrastructure
- Complexity: advanced
- Paths: 133 | Schemas: 1015
- Tier: Standard
- Related domains:
cloud_infrastructure,customer_edge,managed_kubernetes
Use Cases
Section titled “Use Cases”- Deploy F5 XC across cloud providers (AWS, Azure, GCP)
- Manage XCKS (Managed Kubernetes) site deployments (formerly AppStack)
- Deploy Secure Mesh sites for networking-focused edge deployments
- Integrate external Kubernetes clusters as Customer Edge
- Configure AWS VPC, Azure VNet, and GCP VPC sites
- Manage virtual sites and site policies
Primary Resources
Section titled “Primary Resources”- site: Physical or cloud deployment location for edge services
- virtual_site: Logical grouping of sites using label selectors
- site_mesh_group: Mesh connectivity configuration between multiple sites
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| POST | /api/config/namespaces/{metadata.namespace}/aws_tgw_sites | Create AWS TGW site. |
| PUT | /api/config/namespaces/{metadata.namespace}/aws_tgw_sites/{metadata.name} | Replace AWS TGW site. |
| POST | /api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_tgw_info | Configure TGW Information. |
| POST | /api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vip_info | Configure AWS TGW Site VIP Information. |
| POST | /api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpc_ip_prefixes | Configure VPC IP prefixes. |
| POST | /api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpn_tunnels | Configure VPN Tunnels. |
| POST | /api/config/namespaces/{namespace}/aws_tgw_site/{name}/validate_config | Validate AWS TGW Config. |
| GET | /api/config/namespaces/{namespace}/aws_tgw_sites | List Configure AWS TGW Site. |
| GET | /api/config/namespaces/{namespace}/aws_tgw_sites/{name} | GET AWS TGW site. |
| DELETE | /api/config/namespaces/{namespace}/aws_tgw_sites/{name} | DELETE Configure AWS TGW Site. |
| POST | /api/config/namespaces/{metadata.namespace}/aws_vpc_sites | Create AWS VPC site. |
| PUT | /api/config/namespaces/{metadata.namespace}/aws_vpc_sites/{metadata.name} | Replace AWS VPC site. |
| POST | /api/config/namespaces/{namespace}/aws_vpc_site/{name}/set_cloud_site_info | Configure AWS VPC Site Information. |
| POST | /api/config/namespaces/{namespace}/aws_vpc_site/{name}/set_vip_info | Configure AWS VPC Site VIP Information. |
| POST | /api/config/namespaces/{namespace}/aws_vpc_site/{name}/storage/set_vpc_k8s_hostnames | Configure VPC K8s hostnames. |
| POST | /api/config/namespaces/{namespace}/aws_vpc_site/{name}/validate_config | Validate AWS VPC Site Config. |
| GET | /api/config/namespaces/{namespace}/aws_vpc_sites | List Configure AWS VPC Site. |
| GET | /api/config/namespaces/{namespace}/aws_vpc_sites/{name} | GET AWS VPC site. |
| DELETE | /api/config/namespaces/{namespace}/aws_vpc_sites/{name} | DELETE Configure AWS VPC Site. |
| POST | /api/config/namespaces/{metadata.namespace}/voltstack_sites | Create App Stack site. |
| PUT | /api/config/namespaces/{metadata.namespace}/voltstack_sites/{metadata.name} | Replace App Stack site. |
| GET | /api/config/namespaces/{namespace}/voltstack_sites | List Configure App Stack Site. |
| GET | /api/config/namespaces/{namespace}/voltstack_sites/{name} | GET App Stack site. |
| DELETE | /api/config/namespaces/{namespace}/voltstack_sites/{name} | DELETE Configure App Stack Site. |
| POST | /api/config/namespaces/{metadata.namespace}/azure_vnet_sites | Create Azure VNet site. |
| PUT | /api/config/namespaces/{metadata.namespace}/azure_vnet_sites/{metadata.name} | Replace Azure VNet site. |
| POST | /api/config/namespaces/{namespace}/azure_vnet_site/{name}/set_cloud_site_info | Configure Azure VNet Site Information. |
| POST | /api/config/namespaces/{namespace}/azure_vnet_site/{name}/set_vip_info | Configure Azure VNet Site VIP Information. |
| POST | /api/config/namespaces/{namespace}/azure_vnet_site/{name}/validate_config | Validate Azure VNet Site Config. |
| GET | /api/config/namespaces/{namespace}/azure_vnet_sites | List Configure Azure VNet Site. |
| GET | /api/config/namespaces/{namespace}/azure_vnet_sites/{name} | GET Azure VNet site. |
| DELETE | /api/config/namespaces/{namespace}/azure_vnet_sites/{name} | DELETE Configure Azure VNet Site. |
| POST | /api/config/namespaces/{metadata.namespace}/gcp_vpc_sites | Create GCP VPC site. |
| PUT | /api/config/namespaces/{metadata.namespace}/gcp_vpc_sites/{metadata.name} | Replace GCP VPC site. |
| POST | /api/config/namespaces/{namespace}/gcp_vpc_site/{name}/set_cloud_site_info | Configure GCP VPC Site Information. |
| POST | /api/config/namespaces/{namespace}/gcp_vpc_site/{name}/validate_config | Validate GCP VPC Site Config. |
| GET | /api/config/namespaces/{namespace}/gcp_vpc_sites | List Configure GCP VPC Site. |
| GET | /api/config/namespaces/{namespace}/gcp_vpc_sites/{name} | GET GCP VPC site. |
| DELETE | /api/config/namespaces/{namespace}/gcp_vpc_sites/{name} | DELETE Configure GCP VPC Site. |
| POST | /api/config/namespaces/{metadata.namespace}/securemesh_sites | Create Secure Mesh site. |
| PUT | /api/config/namespaces/{metadata.namespace}/securemesh_sites/{metadata.name} | Replace Secure Mesh site. |
| GET | /api/config/namespaces/{namespace}/securemesh_sites | List Configure Secure Mesh Site. |
| GET | /api/config/namespaces/{namespace}/securemesh_sites/{name} | GET Secure Mesh site. |
| DELETE | /api/config/namespaces/{namespace}/securemesh_sites/{name} | DELETE Configure Secure Mesh Site. |
| POST | /api/config/namespaces/{metadata.namespace}/securemesh_site_v2s | Create Secure Mesh site. |
| PUT | /api/config/namespaces/{metadata.namespace}/securemesh_site_v2s/{metadata.name} | Replace Secure Mesh site. |
| GET | /api/config/namespaces/{namespace}/securemesh_site_v2s | List Configure Secure Mesh Site. |
| GET | /api/config/namespaces/{namespace}/securemesh_site_v2s/{name} | GET Secure Mesh site. |
| DELETE | /api/config/namespaces/{namespace}/securemesh_site_v2s/{name} | DELETE Configure Secure Mesh Site. |
| POST | /api/config/namespaces/{metadata.namespace}/k8s_clusters | Create Configuration Specification. |
| PUT | /api/config/namespaces/{metadata.namespace}/k8s_clusters/{metadata.name} | Replace Configuration Specification. |
| GET | /api/config/namespaces/{namespace}/k8s_clusters | List K8s Cluster. |
| GET | /api/config/namespaces/{namespace}/k8s_clusters/{name} | GET Configuration Specification. |
| DELETE | /api/config/namespaces/{namespace}/k8s_clusters/{name} | DELETE K8s Cluster. |
| POST | /api/data/namespaces/{namespace}/firewall_logs | Firewall Logs Query. |
| POST | /api/data/namespaces/{namespace}/firewall_logs/aggregation | Firewall Logs Aggregation Query. |
| GET | /api/data/namespaces/{namespace}/firewall_logs/scroll | Firewall Logs Scroll Query. |
| POST | /api/data/namespaces/{namespace}/firewall_logs/scroll | Firewall Logs Scroll Query. |
| GET | /api/data/namespaces/{namespace}/k8s_audit_logs/scroll | K8s Audit Log Scroll Query. |
| POST | /api/data/namespaces/{namespace}/k8s_audit_logs/scroll | K8s Audit Log Scroll Query. |
| GET | /api/data/namespaces/{namespace}/k8s_events/scroll | K8s Events Scroll Query. |
| POST | /api/data/namespaces/{namespace}/k8s_events/scroll | K8s Events Scroll Query. |
| POST | /api/data/namespaces/{namespace}/platform_events | Platform event Query. |
| POST | /api/data/namespaces/{namespace}/platform_events/aggregation | Platform event Aggregation Query. |
| GET | /api/data/namespaces/{namespace}/platform_events/scroll | Platform event Scroll Query. |
| POST | /api/data/namespaces/{namespace}/platform_events/scroll | Platform event Scroll Query. |
| POST | /api/data/namespaces/{namespace}/site/{site}/external_connector/{external_connector}/logs | External connector log query. |
| POST | /api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs | K8s Audit Log Query. |
| POST | /api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs/aggregation | K8s Audit Log Aggregation Query. |
| POST | /api/data/namespaces/{namespace}/site/{site}/k8s_events | K8s Events Query. |
| POST | /api/data/namespaces/{namespace}/site/{site}/k8s_events/aggregation | K8s Events Aggregation Query. |
| POST | /api/data/namespaces/{namespace}/vk8s_audit_logs | VK8s Audit Log Query. |
| POST | /api/data/namespaces/{namespace}/vk8s_audit_logs/aggregation | VK8s Audit Log Aggregation Query. |
| GET | /api/data/namespaces/{namespace}/vk8s_audit_logs/scroll | VK8s Audit Log Scroll Query. |
| POST | /api/data/namespaces/{namespace}/vk8s_audit_logs/scroll | VK8s Audit Log Scroll Query. |
| POST | /api/data/namespaces/{namespace}/vk8s_events | VK8s Events Query. |
| POST | /api/data/namespaces/{namespace}/vk8s_events/aggregation | VK8s Events Aggregation Query. |
| GET | /api/data/namespaces/{namespace}/vk8s_events/scroll | VK8s Events Scroll Query. |
| POST | /api/data/namespaces/{namespace}/vk8s_events/scroll | VK8s Events Scroll Query. |
| POST | /api/web/namespaces/system/revoke/global-kubeconfigs | Revoke Global Kubeconfig. |
| POST | /api/data/namespaces/system/site/{name}/status | Check Site Exist. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/configmaps | ConfigMap List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/endpoints | Endpoints List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces | Namespace List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/configmaps | ConfigMap List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/endpoints | Endpoints List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/persistentvolumeclaims | PersistentVolumeClaim List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/pods | Pod List |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/secrets | Secret List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/services | Service List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/nodes | Namespace List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/persistentvolumeclaims | PersistentVolumeClaim List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/persistentvolumes | PersistentVolume List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/pods | Pod List |
| GET | /api/data/namespaces/system/site/{site}/api/v1/secrets | Secret List. |
| GET | /api/data/namespaces/system/site/{site}/api/v1/services | Service List. |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/daemonsets | DaemonSet List. |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/deployments | Deployment List. |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/daemonsets | DaemonSet List. |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/deployments | Deployment List. |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/replicasets | ReplicaSet List. |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/statefulsets | StatefulSet List. |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/replicasets | ReplicaSet List. |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/statefulsets | StatefulSet List. |
| GET | /api/data/namespaces/system/site/{site}/apis/batch/v1/jobs | Job List |
| GET | /api/data/namespaces/system/site/{site}/apis/batch/v1/namespaces/{namespace}/jobs | Job List |
| GET | /api/data/namespaces/system/site/{site}/apis/batch/v1beta1/cronjobs | CronJob List. |
| GET | /api/data/namespaces/system/site/{site}/apis/batch/v1beta1/namespaces/{namespace}/cronjobs | CronJob List. |
| POST | /api/data/namespaces/system/site/{site}/namespaces/{namespace}/pods/metrics | Pods Metrics. |
| POST | /api/data/namespaces/system/site/{site}/namespaces/{namespace}/virtualmachineinstances/metrics | VirtualMachineInstances Metrics. |
| POST | /api/data/namespaces/system/site/{site}/pods/metrics | Pods Metrics. |
| POST | /api/data/namespaces/system/site/{site}/virtualmachineinstances/metrics | VirtualMachineInstances Metrics. |
| GET | /api/web/namespaces/system/sites/{site}/global-kubeconfigs | List Global Kube Configs. |
| POST | /api/web/namespaces/system/sites/{site}/global-kubeconfigs | Create Global Kube Config. |
| PUT | /api/config/namespaces/{metadata.namespace}/sites/{metadata.name} | Replace Site. |
| POST | /api/register/namespaces/{namespace}/site/{name}/state | Set site state. |
| POST | /api/data/namespaces/{namespace}/site/{site}/status/metrics | Site Status Metrics. |
| GET | /api/config/namespaces/{namespace}/sites | List Site |
| GET | /api/config/namespaces/{namespace}/sites/{name} | GET Site |
| POST | /api/config/namespaces/{namespace}/sites/{name}/local-kubeconfig | Create K8s Cluster Local Kube Config. |
| GET | /api/config/namespaces/{namespace}/sites/{name}/local-kubeconfigs | List Local Kube Configs. |
| POST | /api/config/namespaces/{namespace}/sites/{name}/upgrade_os | Upgrade OS. |
| POST | /api/config/namespaces/{namespace}/sites/{name}/upgrade_sw | Upgrade SW. |
| GET | /api/config/namespaces/{namespace}/sites/{site}/global_networks | Global Network List. |
| GET | /api/config/namespaces/{namespace}/sites/{site}/segments | Segment List. |
| POST | /api/data/namespaces/{namespace}/graph/site | Site Graph Query. |
| POST | /api/data/namespaces/{namespace}/graph/site/edge | Site Edge Query. |
| POST | /api/data/namespaces/{namespace}/graph/site/node | Site Node Query. |
| GET | /api/config/namespaces/{namespace}/sites/{site}/interface | Interface List. |
| POST | /api/data/namespaces/system/topology/dc_cluster_group/{dc_cluster_group} | DC Cluster Topology. |
| GET | /api/data/namespaces/system/topology/dc_cluster_groups | DC Cluster Groups Summary. |
| GET | /api/data/namespaces/system/topology/network/{id}/route_tables | GET Network Route Tables. |
| GET | /api/data/namespaces/system/topology/route_table/{name} | GET Route Table. |
| GET | /api/data/namespaces/system/topology/site/{name}/networks | GET Site Networks. |
| POST | /api/data/namespaces/system/topology/site/{site} | Site Topology. |
| POST | /api/data/namespaces/system/topology/site_mesh_group/{site_mesh_group} | Site Mesh Topology. |
| GET | /api/data/namespaces/system/topology/site_mesh_groups | Site Mesh Groups Summary. |
| GET | /api/data/namespaces/system/topology/tgw/{id}/route_tables | GET TGW Route Tables. |
| POST | /api/config/namespaces/{metadata.namespace}/virtual_k8ss | Create Virtual Kubernetes. |
| PUT | /api/config/namespaces/{metadata.namespace}/virtual_k8ss/{metadata.name} | Replace Virtual Kubernetes. |
| POST | /api/data/namespaces/{namespace}/virtual_k8s/pvc/metrics | PVC Metrics. |
| GET | /api/config/namespaces/{namespace}/virtual_k8ss | List Virtual Kubernetes. |
| GET | /api/config/namespaces/{namespace}/virtual_k8ss/{name} | GET Virtual Kubernetes. |
| DELETE | /api/config/namespaces/{namespace}/virtual_k8ss/{name} | DELETE Virtual Kubernetes. |
| POST | /api/config/namespaces/{metadata.namespace}/virtual_sites | Create Virtual Site. |
| PUT | /api/config/namespaces/{metadata.namespace}/virtual_sites/{metadata.name} | Replace Virtual Site. |
| GET | /api/config/namespaces/{namespace}/virtual_sites | List Virtual Site. |
| GET | /api/config/namespaces/{namespace}/virtual_sites/{name} | GET Virtual Site. |
| DELETE | /api/config/namespaces/{namespace}/virtual_sites/{name} | DELETE Virtual Site. |
| GET | /api/config/namespaces/{namespace}/virtual_sites/{name}/selectees | GET Selectees. |