Netzwerk anhand der ID abrufen¶
Note
Die Attribute pps_limit_percentage und bw_limit_percentage sind nur vorhanden, wenn die Organisation prozentuale Schwellenwerte aktiviert hat.
Note
SOC-Konten müssen eine Organisation stattdessen explizit über den Endpunkt /organisations/{organisation}/networks adressieren.
Senden einer GET-Anfrage an den Endpunkt /networks/{network}.
Beschreibung¶
Mit der Get-Network-Anfrage fordern Sie ein einzelnes Netzwerk für eine angegebene ID an.
Voraussetzungen¶
Werte der Anfrage: Netzwerk-ID {network}
Objekte: keine
Anfrage¶
Um ein einzelnes Netzwerk anzufordern, fügen Sie die Netzwerk-ID {network} in den Pfad der Anfrage ein.
Als Ergebnis erhalten Sie ein Objekt NetworkVO mit den angefragten Informationen.
Das Objekt liefert die folgenden Informationen:
| Attribut | Beschreibung | Werte |
|---|---|---|
id |
Die ID des Netzwerks. | string |
organisation |
Die zugehörige Organisation. | object |
name |
Der Name des Netzwerks. | string |
cidr |
Der CIDR-Bereich des Netzwerks. | string |
enabled |
Definiert, ob die automatische Mitigation aktiviert ist. |
|
data_only (falls verfügbar) |
Definiert, ob das Netzwerk nur überwacht wird: im Dashboard sichtbar, aber nicht mitigierbar. |
|
mitigation_type |
Der Mitigationstyp des Netzwerks. |
|
auto_mitigation_strategy |
Die Strategie der automatischen Mitigation des Netzwerks. | string |
duration |
Die Dauer der automatischen Mitigation. | integer |
subnet_mitigation_override (falls Subnetz-Override aktiviert) |
Der Mitigations-Override für das Subnetz. |
|
pps_limit |
Das konfigurierte PPS-Limit. | integer |
bw_limit |
Das konfigurierte Bandbreitenlimit. | integer |
pps_limit_percentage (falls prozentuale Schwellenwerte aktiviert) |
Das PPS-Limit als Prozentwert. | integer |
bw_limit_percentage (falls prozentuale Schwellenwerte aktiviert) |
Das Bandbreitenlimit als Prozentwert. | integer |
autoStatus |
Definiert, ob für das Netzwerk aktuell eine automatische Mitigation läuft. |
|
manualStatus |
Definiert, ob für das Netzwerk aktuell eine manuelle Mitigation läuft. |
|
active_partial_manual_mitigations |
Die aktiven partiellen manuellen Mitigationen. | array |
active_partial_auto_mitigations |
Die aktiven partiellen automatischen Mitigationen. | array |
allow_manual_mitigation |
Zeigt an, ob für das Netzwerk manuelle Mitigationen gestartet werden können. |
|
extra |
Zusätzliche benutzerdefinierte Felder der Organisation. | object |
Beispiel¶
Beispiel-Antwort:
{
"id": "xY9pQ5wR1",
"organisation": {
"id": "aB3cD4eF5",
"name": "ACME GmbH"
},
"name": "Customer-A-Prod",
"cidr": "192.0.2.0/24",
"enabled": true,
"data_only": false,
"mitigation_type": "ACTION_BLACKHOLE",
"auto_mitigation_strategy": "IP",
"duration": 0,
"subnet_mitigation_override": false,
"pps_limit": 0,
"bw_limit": 0,
"pps_limit_percentage": 0,
"bw_limit_percentage": 0,
"autoStatus": true,
"manualStatus": true,
"active_partial_manual_mitigations": [
{}
],
"active_partial_auto_mitigations": [
{}
],
"allow_manual_mitigation": true,
"extra": {}
}
Antworten¶
Die folgenden Antworten sind möglich:
| STATUSCODE | BESCHREIBUNG |
|---|---|
| 200 | Die Anfrage war erfolgreich. |
| 401 | Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war. |
| 403 | Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen. |