Netzwerk zur Organisation hinzufügen¶

Note

Der Body enthält nicht die Attribute id, created und modified. Das System legt diese Werte nach dem Erstellen des Eintrags fest.

Note

Die Attribute pps_limit und pps_limit_percentage schließen sich gegenseitig aus; das Gleiche gilt für bw_limit und bw_limit_percentage.

Note

Für ACTION_MITIGATE_CLOUD gilt: IPv4-Netzwerke benötigen mindestens /24, IPv6-Netzwerke mindestens /48.

Note

Diese Anfrage steht ausschließlich SOC-Nutzenden zur Verfügung.

Senden einer POST-Anfrage an den Endpunkt /networks.

Beschreibung¶

Mit der Add-Network-Anfrage fügen Sie der Organisation ein neues Netzwerk hinzu.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: NetworkVO

Anfrage¶

Um ein Netzwerk hinzuzufügen, ist im Pfad der Anfrage keine zusätzliche Information erforderlich.

Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen eines Netzwerks erforderlich sind, muss im Body ein Objekt NetworkVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`cidr`	Der IP-Bereich in CIDR-Notation. Muss innerhalb der Organisation eindeutig sein.	`string`
`enabled`	Definiert, ob die automatische Mitigation für das Netzwerk aktiviert ist. Bei `false` werden keine automatischen Mitigationen ausgelöst; manuelle und Ops-Mitigationen sind davon nicht betroffen.	`true` `false`
`pps_limit`	Der absolute PPS-Schwellenwert. Erforderlich, falls `pps_limit_percentage` nicht angegeben ist.	`integer`
`bw_limit`	Der absolute Bandbreiten-Schwellenwert in Mbps. Erforderlich, falls `bw_limit_percentage` nicht angegeben ist.	`integer`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`name`	Der Name des Netzwerks.	`string`
`team_id`	Die ID der Organisation, zu der das Netzwerk hinzugefügt wird.	`string`
`pps_limit_percentage` (falls prozentuale Schwellenwerte aktiviert)	Der PPS-Schwellenwert als Prozentsatz der Baseline. Kann nicht mit `pps_limit` kombiniert werden.	`integer`
`pps_limit_calculated`	Der berechnete PPS-Schwellenwert.	`integer`
`bw_limit_percentage` (falls prozentuale Schwellenwerte aktiviert)	Der Bandbreiten-Schwellenwert als Prozentsatz der Baseline. Kann nicht mit `bw_limit` kombiniert werden.	`integer`
`bw_limit_calculated`	Der berechnete Bandbreiten-Schwellenwert.	`integer`
`autoStatus`	Zeigt an, ob sich das Netzwerk aktuell in automatischer Mitigation befindet.	`true` `false`
`manualStatus`	Zeigt an, ob sich das Netzwerk aktuell in manueller Mitigation befindet.	`true` `false`
`active_partial_mitigations`	Die aktiven partiellen manuellen Mitigationen.	`array`
`active_partial_auto_mitigations`	Die aktiven partiellen automatischen Mitigationen.	`array`
`country_blocks`	Die aktiven Ländersperren.	`array`
`data_only` (falls verfügbar)	Bei `true` wird das Netzwerk im Dashboard nur zur Überwachung angezeigt und kann nicht mitigiert werden.	`true` `false`
`allow_manual_mitigation`	Zeigt an, ob für das Netzwerk manuelle Mitigationen gestartet werden können. Der Standardwert ist `true`, falls das Attribut fehlt.	`true` `false`
`subnet_mitigation_override` (falls Subnetz-Override aktiviert)	Definiert, ob die Subnetzgrößen-Beschränkung für Cloud- oder Hybrid-Mitigation überschrieben wird.	`true` `false`
`extra`	Zusätzliche benutzerdefinierte Felder der Organisation.	`object`
`mitigation_type`	Der anzuwendende Mitigationstyp.	`ACTION_BLACKHOLE` `ACTION_MITIGATE_ONPREM` `ACTION_MITIGATE_CLOUD`
`network_type` (falls Netzwerktypen aktiviert)	Der Registrierungstyp des Netzwerks.	`string`
`customer_reference` (falls Kundenreferenzen aktiviert)	Die Kennung der Kundenreferenz.	`string`
`emails`	Die E-Mail-Adressen, die bei Start oder Ende einer Mitigation benachrichtigt werden.	`array`
`duration`	Die maximale Mitigationsdauer in Sekunden (Minimum 300).	`integer`
`auto_mitigation_strategy`	Die Strategie für die automatische Mitigation.	`IP` `CIDR` `INTERNET` `DEFAULT`

Das System gibt als Antwort das Objekt NetworkVO mit den Informationen zum neuen Netzwerk zurück.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`message`	Die Statusmeldung der Anfrage.	`string`
`network`	Das neu erstellte Netzwerk als `NetworkVO`-Objekt.	`object`

Beispiel¶

Beispiel-Request-Body:

{
  "name": "Production Network",
  "cidr": "127.0.0.1/32",
  "enabled": true,
  "pps_limit": 1000,
  "bw_limit": 200,
  "pps_limit_percentage": 80,
  "pps_limit_calculated": 800,
  "bw_limit_percentage": 80,
  "bw_limit_calculated": 160,
  "team_id": "xY9pQ5wR1",
  "autoStatus": false,
  "manualStatus": false,
  "active_partial_mitigations": [
    {}
  ],
  "active_partial_auto_mitigations": [
    {}
  ],
  "country_blocks": [
    {}
  ],
  "data_only": false,
  "allow_manual_mitigation": true,
  "extra": {},
  "mitigation_type": "string",
  "network_type": "string",
  "customer_reference": "abc",
  "emails": [
    "string"
  ],
  "duration": 3600,
  "auto_mitigation_strategy": "ip"
}

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.
422	Die Anfrage war nicht erfolgreich, da die übermittelten Daten nicht verarbeitet werden konnten.