🔌 Network API
Border gateway protocol with ASN management and autonomous system relationships. Site-to-site VPN linking datacenters through encrypted channels.
- Category: Networking
- Complexity: advanced
- Paths: 81 | Schemas: 449
- Tier: Advanced
- Related domains:
virtual,network_security,dns
Use Cases
Section titled “Use Cases”- Configure BGP routing and ASN management
- Manage IPsec tunnels and IKE phases
- Configure network connectors and routes
- Manage SRv6 and subnetting
- Define segment connections and policies
- Configure IP prefix sets
Primary Resources
Section titled “Primary Resources”- virtual_network: Virtual network for site connectivity and segmentation
- network_connector: Network connector for site-to-site or cloud connectivity
- site_mesh_group: Mesh connectivity configuration between multiple sites
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| POST | /api/config/namespaces/{metadata.namespace}/address_allocators | Create Address Allocator. |
| GET | /api/config/namespaces/{namespace}/address_allocators | List Address Allocator. |
| GET | /api/config/namespaces/{namespace}/address_allocators/{name} | GET Address Allocator. |
| DELETE | /api/config/namespaces/{namespace}/address_allocators/{name} | DELETE Address Allocator. |
| POST | /api/config/namespaces/{metadata.namespace}/advertise_policys | Create Advertise Policy. |
| PUT | /api/config/namespaces/{metadata.namespace}/advertise_policys/{metadata.name} | Replace Advertise Policy. |
| GET | /api/config/namespaces/{namespace}/advertise_policys | List Advertise Policy. |
| GET | /api/config/namespaces/{namespace}/advertise_policys/{name} | GET Advertise Policy. |
| DELETE | /api/config/namespaces/{namespace}/advertise_policys/{name} | DELETE Advertise Policy. |
| POST | /api/config/namespaces/{metadata.namespace}/bgps | Create BGP. |
| PUT | /api/config/namespaces/{metadata.namespace}/bgps/{metadata.name} | Replace BGP. |
| GET | /api/config/namespaces/{namespace}/bgps | List BGP |
| GET | /api/config/namespaces/{namespace}/bgps/{name} | GET BGP |
| DELETE | /api/config/namespaces/{namespace}/bgps/{name} | DELETE BGP. |
| GET | /api/config/namespaces/{namespace}/bgpstatus/{view_name} | GET BGP Status for view. |
| POST | /api/config/namespaces/{metadata.namespace}/bgp_asn_sets | Create BGP ASN Set. |
| PUT | /api/config/namespaces/{metadata.namespace}/bgp_asn_sets/{metadata.name} | Replace BGP ASN Set. |
| GET | /api/config/namespaces/{namespace}/bgp_asn_sets | List BGP ASN Set. |
| GET | /api/config/namespaces/{namespace}/bgp_asn_sets/{name} | GET BGP ASN Set. |
| DELETE | /api/config/namespaces/{namespace}/bgp_asn_sets/{name} | DELETE BGP ASN Set. |
| GET | /api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers | Show BGP Peer Info. |
| GET | /api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes | Show BGP Routes. |
| POST | /api/config/namespaces/{metadata.namespace}/bgp_routing_policys | Create BGP Routing Policy. |
| PUT | /api/config/namespaces/{metadata.namespace}/bgp_routing_policys/{metadata.name} | Replace BGP Routing Policy. |
| GET | /api/config/namespaces/{namespace}/bgp_routing_policys | List BGP Routing Policy. |
| GET | /api/config/namespaces/{namespace}/bgp_routing_policys/{name} | GET BGP Routing Policy. |
| DELETE | /api/config/namespaces/{namespace}/bgp_routing_policys/{name} | DELETE BGP Routing Policy. |
| POST | /api/config/namespaces/{metadata.namespace}/dc_cluster_groups | Create DC Cluster Group. |
| PUT | /api/config/namespaces/{metadata.namespace}/dc_cluster_groups/{metadata.name} | Replace DC Cluster Group. |
| GET | /api/config/namespaces/{namespace}/dc_cluster_groups | List DC Cluster Group. |
| POST | /api/data/namespaces/{namespace}/dc_cluster_groups/metrics | Metrics |
| GET | /api/config/namespaces/{namespace}/dc_cluster_groups/{name} | GET DC Cluster Group. |
| DELETE | /api/config/namespaces/{namespace}/dc_cluster_groups/{name} | DELETE DC Cluster Group. |
| POST | /api/config/namespaces/{metadata.namespace}/forwarding_classs | Create Forwarding Class. |
| PUT | /api/config/namespaces/{metadata.namespace}/forwarding_classs/{metadata.name} | Replace Forwarding Class. |
| GET | /api/config/namespaces/{namespace}/forwarding_classs | List Forwarding Class. |
| GET | /api/config/namespaces/{namespace}/forwarding_classs/{name} | GET Forwarding Class. |
| DELETE | /api/config/namespaces/{namespace}/forwarding_classs/{name} | DELETE Forwarding Class. |
| POST | /api/config/namespaces/{metadata.namespace}/ike1s | Create IKE Phase1 Profile. |
| PUT | /api/config/namespaces/{metadata.namespace}/ike1s/{metadata.name} | Replace IKE Phase1 Profile configuration. |
| GET | /api/config/namespaces/{namespace}/ike1s | List IKE Phase 1 Profile. |
| GET | /api/config/namespaces/{namespace}/ike1s/{name} | GET IKE Phase1 profile configuration. |
| DELETE | /api/config/namespaces/{namespace}/ike1s/{name} | DELETE IKE Phase 1 Profile. |
| POST | /api/config/namespaces/{metadata.namespace}/ike_phase1_profiles | Create IKE Phase1 Profile. |
| PUT | /api/config/namespaces/{metadata.namespace}/ike_phase1_profiles/{metadata.name} | Replace IKE Phase1 Profile configuration. |
| GET | /api/config/namespaces/{namespace}/ike_phase1_profiles | List IKE Phase 1 Profile. |
| GET | /api/config/namespaces/{namespace}/ike_phase1_profiles/{name} | GET IKE Phase1 profile configuration. |
| DELETE | /api/config/namespaces/{namespace}/ike_phase1_profiles/{name} | DELETE IKE Phase 1 Profile. |
| POST | /api/config/namespaces/{metadata.namespace}/ike2s | Create IKE Phase2 Profile. |
| PUT | /api/config/namespaces/{metadata.namespace}/ike2s/{metadata.name} | Replace IKE Phase2 Profile configuration. |
| GET | /api/config/namespaces/{namespace}/ike2s | List IKE Phase 2 Profile. |
| GET | /api/config/namespaces/{namespace}/ike2s/{name} | GET IKE Phase2 profile configuration. |
| DELETE | /api/config/namespaces/{namespace}/ike2s/{name} | DELETE IKE Phase 2 Profile. |
| POST | /api/config/namespaces/{metadata.namespace}/ike_phase2_profiles | Create IKE Phase2 Profile. |
| PUT | /api/config/namespaces/{metadata.namespace}/ike_phase2_profiles/{metadata.name} | Replace IKE Phase2 Profile configuration. |
| GET | /api/config/namespaces/{namespace}/ike_phase2_profiles | List IKE Phase 2 Profile. |
| GET | /api/config/namespaces/{namespace}/ike_phase2_profiles/{name} | GET IKE Phase2 profile configuration. |
| DELETE | /api/config/namespaces/{namespace}/ike_phase2_profiles/{name} | DELETE IKE Phase 2 Profile. |
| POST | /api/config/namespaces/{metadata.namespace}/ip_prefix_sets | Create IP Prefix Set. |
| PUT | /api/config/namespaces/{metadata.namespace}/ip_prefix_sets/{metadata.name} | Replace IP Prefix Set. |
| GET | /api/config/namespaces/{namespace}/ip_prefix_sets | List IP Prefix Set. |
| GET | /api/config/namespaces/{namespace}/ip_prefix_sets/{name} | GET IP Prefix Set. |
| DELETE | /api/config/namespaces/{namespace}/ip_prefix_sets/{name} | DELETE IP Prefix Set. |
| POST | /api/config/namespaces/{metadata.namespace}/network_connectors | Create Network Connector. |
| PUT | /api/config/namespaces/{metadata.namespace}/network_connectors/{metadata.name} | Replace Network Connector. |
| GET | /api/config/namespaces/{namespace}/network_connectors | List Network Connector. |
| GET | /api/config/namespaces/{namespace}/network_connectors/{name} | GET Network Connector. |
| DELETE | /api/config/namespaces/{namespace}/network_connectors/{name} | DELETE Network Connector. |
| PUT | /api/config/namespaces/{metadata.namespace}/public_ips/{metadata.name} | Replace Public IP. |
| GET | /api/config/namespaces/{namespace}/public_ips | List Public IP. |
| GET | /api/config/namespaces/{namespace}/public_ips/{name} | GET Public IP. |
| POST | /api/config/namespaces/{metadata.namespace}/routes | Create Route. |
| PUT | /api/config/namespaces/{metadata.namespace}/routes/{metadata.name} | Replace Route. |
| GET | /api/config/namespaces/{namespace}/routes | List Route. |
| GET | /api/config/namespaces/{namespace}/routes/{name} | GET Route |
| DELETE | /api/config/namespaces/{namespace}/routes/{name} | DELETE Route. |
| POST | /api/operate/namespaces/{namespace}/sites/{site}/ver/routes | Show Routes. |
| POST | /api/operate/namespaces/{namespace}/sites/{site}/ver/simplified_routes | Show Simplified Routes. |
| POST | /api/config/namespaces/{metadata.namespace}/srv6_network_slices | Create SRv6 Network Slice. |
| PUT | /api/config/namespaces/{metadata.namespace}/srv6_network_slices/{metadata.name} | Replace SRv6 Network Slice. |
| GET | /api/config/namespaces/{namespace}/srv6_network_slices | List SRv6 Network Slice. |
| GET | /api/config/namespaces/{namespace}/srv6_network_slices/{name} | GET SRv6 Network Slice. |
| DELETE | /api/config/namespaces/{namespace}/srv6_network_slices/{name} | DELETE SRv6 Network Slice. |
| POST | /api/config/namespaces/{metadata.namespace}/subnets | Create Subnet. |
| PUT | /api/config/namespaces/{metadata.namespace}/subnets/{metadata.name} | Replace Subnet. |
| GET | /api/config/namespaces/{namespace}/subnets | List Subnet. |
| GET | /api/config/namespaces/{namespace}/subnets/{name} | GET Subnet. |
| DELETE | /api/config/namespaces/{namespace}/subnets/{name} | DELETE Subnet. |
| POST | /api/operate/namespaces/{namespace}/sites/{site}/ver/traceroute | Traceroute. |
| POST | /api/config/namespaces/{metadata.namespace}/tunnels | Create Tunnel. |
| PUT | /api/config/namespaces/{metadata.namespace}/tunnels/{metadata.name} | Replace Tunnel. |
| GET | /api/config/namespaces/{namespace}/tunnels | List Tunnel. |
| GET | /api/config/namespaces/{namespace}/tunnels/{name} | GET Tunnel. |
| DELETE | /api/config/namespaces/{namespace}/tunnels/{name} | DELETE Tunnel. |
| POST | /api/config/namespaces/{metadata.namespace}/virtual_networks | Create Virtual Network. |
| PUT | /api/config/namespaces/{metadata.namespace}/virtual_networks/{metadata.name} | Replace Virtual Network. |
| GET | /api/config/namespaces/{namespace}/virtual_networks | List Virtual Network. |
| GET | /api/config/namespaces/{namespace}/virtual_networks/{name} | GET Virtual Network. |
| DELETE | /api/config/namespaces/{namespace}/virtual_networks/{name} | DELETE Virtual Network. |