- Startseite
- API Enriched
- API-Referenz
- 🔌 Netzwerk-API
🔌 Netzwerk-API
Border-Gateway-Protokoll mit ASN-Verwaltung und Beziehungen zwischen autonomen Systemen. Site-to-Site-VPN zur Verbindung von Rechenzentren über verschlüsselte Kanäle.
- Kategorie: Netzwerk
- Komplexität: erweitert
- Pfade: 81 | Schemas: 449
- Stufe: Erweitert
- Verwandte Domänen:
virtual,network_security,dns
Anwendungsfälle
Abschnitt betitelt „Anwendungsfälle“- BGP-Routing und ASN-Verwaltung konfigurieren
- IPsec-Tunnel und IKE-Phasen verwalten
- Netzwerkverbinder und Routen konfigurieren
- SRv6 und Subnetzbildung verwalten
- Segmentverbindungen und Richtlinien definieren
- IP-Präfixmengen konfigurieren
Primäre Ressourcen
Abschnitt betitelt „Primäre Ressourcen“- virtual_network: Virtuelles Netzwerk für Site-Konnektivität und Segmentierung
- network_connector: Netzwerkverbinder für Site-to-Site- oder Cloud-Konnektivität
- site_mesh_group: Mesh-Konnektivitätskonfiguration zwischen mehreren Standorten
Endpunkte
Abschnitt betitelt „Endpunkte“| Methode | Pfad | Beschreibung |
|---|---|---|
| POST | /api/config/namespaces/{metadata.namespace}/address_allocators | Adresszuordnung erstellen. |
| GET | /api/config/namespaces/{namespace}/address_allocators | Adresszuordnung auflisten. |
| GET | /api/config/namespaces/{namespace}/address_allocators/{name} | Adresszuordnung abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/address_allocators/{name} | Adresszuordnung löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/advertise_policys | Ankündigungsrichtlinie erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/advertise_policys/{metadata.name} | Ankündigungsrichtlinie ersetzen. |
| GET | /api/config/namespaces/{namespace}/advertise_policys | Ankündigungsrichtlinie auflisten. |
| GET | /api/config/namespaces/{namespace}/advertise_policys/{name} | Ankündigungsrichtlinie abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/advertise_policys/{name} | Ankündigungsrichtlinie löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/bgps | BGP erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/bgps/{metadata.name} | BGP ersetzen. |
| GET | /api/config/namespaces/{namespace}/bgps | BGP auflisten. |
| GET | /api/config/namespaces/{namespace}/bgps/{name} | BGP abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/bgps/{name} | BGP löschen (DELETE). |
| GET | /api/config/namespaces/{namespace}/bgpstatus/{view_name} | BGP-Status für Ansicht abrufen (GET). |
| POST | /api/config/namespaces/{metadata.namespace}/bgp_asn_sets | BGP-ASN-Menge erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/bgp_asn_sets/{metadata.name} | BGP-ASN-Menge ersetzen. |
| GET | /api/config/namespaces/{namespace}/bgp_asn_sets | BGP-ASN-Menge auflisten. |
| GET | /api/config/namespaces/{namespace}/bgp_asn_sets/{name} | BGP-ASN-Menge abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/bgp_asn_sets/{name} | BGP-ASN-Menge löschen (DELETE). |
| GET | /api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers | BGP-Peer-Informationen anzeigen. |
| GET | /api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes | BGP-Routen anzeigen. |
| POST | /api/config/namespaces/{metadata.namespace}/bgp_routing_policys | BGP-Routingrichtlinie erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/bgp_routing_policys/{metadata.name} | BGP-Routingrichtlinie ersetzen. |
| GET | /api/config/namespaces/{namespace}/bgp_routing_policys | BGP-Routingrichtlinie auflisten. |
| GET | /api/config/namespaces/{namespace}/bgp_routing_policys/{name} | BGP-Routingrichtlinie abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/bgp_routing_policys/{name} | BGP-Routingrichtlinie löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/dc_cluster_groups | DC-Clustergruppe erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/dc_cluster_groups/{metadata.name} | DC-Clustergruppe ersetzen. |
| GET | /api/config/namespaces/{namespace}/dc_cluster_groups | DC-Clustergruppe auflisten. |
| POST | /api/data/namespaces/{namespace}/dc_cluster_groups/metrics | Metriken. |
| GET | /api/config/namespaces/{namespace}/dc_cluster_groups/{name} | DC-Clustergruppe abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/dc_cluster_groups/{name} | DC-Clustergruppe löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/forwarding_classs | Weiterleitungsklasse erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/forwarding_classs/{metadata.name} | Weiterleitungsklasse ersetzen. |
| GET | /api/config/namespaces/{namespace}/forwarding_classs | Weiterleitungsklasse auflisten. |
| GET | /api/config/namespaces/{namespace}/forwarding_classs/{name} | Weiterleitungsklasse abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/forwarding_classs/{name} | Weiterleitungsklasse löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/ike1s | IKE-Phase-1-Profil erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/ike1s/{metadata.name} | IKE-Phase-1-Profilkonfiguration ersetzen. |
| GET | /api/config/namespaces/{namespace}/ike1s | IKE-Phase-1-Profil auflisten. |
| GET | /api/config/namespaces/{namespace}/ike1s/{name} | IKE-Phase-1-Profilkonfiguration abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/ike1s/{name} | IKE-Phase-1-Profil löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/ike_phase1_profiles | IKE-Phase-1-Profil erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/ike_phase1_profiles/{metadata.name} | IKE-Phase-1-Profilkonfiguration ersetzen. |
| GET | /api/config/namespaces/{namespace}/ike_phase1_profiles | IKE-Phase-1-Profil auflisten. |
| GET | /api/config/namespaces/{namespace}/ike_phase1_profiles/{name} | IKE-Phase-1-Profilkonfiguration abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/ike_phase1_profiles/{name} | IKE-Phase-1-Profil löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/ike2s | IKE-Phase-2-Profil erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/ike2s/{metadata.name} | IKE-Phase-2-Profilkonfiguration ersetzen. |
| GET | /api/config/namespaces/{namespace}/ike2s | IKE-Phase-2-Profil auflisten. |
| GET | /api/config/namespaces/{namespace}/ike2s/{name} | IKE-Phase-2-Profilkonfiguration abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/ike2s/{name} | IKE-Phase-2-Profil löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/ike_phase2_profiles | IKE-Phase-2-Profil erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/ike_phase2_profiles/{metadata.name} | IKE-Phase-2-Profilkonfiguration ersetzen. |
| GET | /api/config/namespaces/{namespace}/ike_phase2_profiles | IKE-Phase-2-Profil auflisten. |
| GET | /api/config/namespaces/{namespace}/ike_phase2_profiles/{name} | IKE-Phase-2-Profilkonfiguration abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/ike_phase2_profiles/{name} | IKE-Phase-2-Profil löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/ip_prefix_sets | IP-Präfixmenge erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/ip_prefix_sets/{metadata.name} | IP-Präfixmenge ersetzen. |
| GET | /api/config/namespaces/{namespace}/ip_prefix_sets | IP-Präfixmenge auflisten. |
| GET | /api/config/namespaces/{namespace}/ip_prefix_sets/{name} | IP-Präfixmenge abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/ip_prefix_sets/{name} | IP-Präfixmenge löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/network_connectors | Netzwerkverbinder erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/network_connectors/{metadata.name} | Netzwerkverbinder ersetzen. |
| GET | /api/config/namespaces/{namespace}/network_connectors | Netzwerkverbinder auflisten. |
| GET | /api/config/namespaces/{namespace}/network_connectors/{name} | Netzwerkverbinder abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/network_connectors/{name} | Netzwerkverbinder löschen (DELETE). |
| PUT | /api/config/namespaces/{metadata.namespace}/public_ips/{metadata.name} | Öffentliche IP ersetzen. |
| GET | /api/config/namespaces/{namespace}/public_ips | Öffentliche IP auflisten. |
| GET | /api/config/namespaces/{namespace}/public_ips/{name} | Öffentliche IP abrufen (GET). |
| POST | /api/config/namespaces/{metadata.namespace}/routes | Route erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/routes/{metadata.name} | Route ersetzen. |
| GET | /api/config/namespaces/{namespace}/routes | Route auflisten. |
| GET | /api/config/namespaces/{namespace}/routes/{name} | Route abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/routes/{name} | Route löschen (DELETE). |
| POST | /api/operate/namespaces/{namespace}/sites/{site}/ver/routes | Routen anzeigen. |
| POST | /api/operate/namespaces/{namespace}/sites/{site}/ver/simplified_routes | Vereinfachte Routen anzeigen. |
| POST | /api/config/namespaces/{metadata.namespace}/srv6_network_slices | SRv6-Netzwerksegment erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/srv6_network_slices/{metadata.name} | SRv6-Netzwerksegment ersetzen. |
| GET | /api/config/namespaces/{namespace}/srv6_network_slices | SRv6-Netzwerksegment auflisten. |
| GET | /api/config/namespaces/{namespace}/srv6_network_slices/{name} | SRv6-Netzwerksegment abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/srv6_network_slices/{name} | SRv6-Netzwerksegment löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/subnets | Subnetz erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/subnets/{metadata.name} | Subnetz ersetzen. |
| GET | /api/config/namespaces/{namespace}/subnets | Subnetz auflisten. |
| GET | /api/config/namespaces/{namespace}/subnets/{name} | Subnetz abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/subnets/{name} | Subnetz löschen (DELETE). |
| POST | /api/operate/namespaces/{namespace}/sites/{site}/ver/traceroute | Traceroute. |
| POST | /api/config/namespaces/{metadata.namespace}/tunnels | Tunnel erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/tunnels/{metadata.name} | Tunnel ersetzen. |
| GET | /api/config/namespaces/{namespace}/tunnels | Tunnel auflisten. |
| GET | /api/config/namespaces/{namespace}/tunnels/{name} | Tunnel abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/tunnels/{name} | Tunnel löschen (DELETE). |
| POST | /api/config/namespaces/{metadata.namespace}/virtual_networks | Virtuelles Netzwerk erstellen. |
| PUT | /api/config/namespaces/{metadata.namespace}/virtual_networks/{metadata.name} | Virtuelles Netzwerk ersetzen. |
| GET | /api/config/namespaces/{namespace}/virtual_networks | Virtuelles Netzwerk auflisten. |
| GET | /api/config/namespaces/{namespace}/virtual_networks/{name} | Virtuelles Netzwerk abrufen (GET). |
| DELETE | /api/config/namespaces/{namespace}/virtual_networks/{name} | Virtuelles Netzwerk löschen (DELETE). |