Alle Netzwerke mit ihrem Mitigationsstatus auflisten¶

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 stattdessen eine Organisation explizit über den Endpunkt /organisations/{organisation}/networks ansprechen.

Senden einer GET-Anfrage an den Endpunkt /networks-with-mitigations.

Beschreibung¶

Mit der List-Networks-With-Mitigations-Anfrage fordern Sie eine Liste aller Netzwerke der aktiven Organisation einschließlich ihres aktuellen Mitigationsstatus an.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: keine

Anfrage¶

Um eine Liste aller Netzwerke mit ihrem Mitigationsstatus anzufordern, fügen Sie keine zusätzliche Information in den Pfad der Anfrage ein.

Als Ergebnis erhalten Sie ein oder mehrere Objekte 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`	Die CIDR des Netzwerks.	`string`
`enabled`	Zeigt an, ob die automatische Mitigation aktiviert ist.	`true` `false`
`data_only` (falls verfügbar)	Zeigt an, dass das Netzwerk ein Monitor-only-Netzwerk ist: im Dashboard sichtbar, aber nicht mitigierbar.	`true` `false`
`mitigation_type`	Der Mitigationstyp des Netzwerks.	`ACTION_BLACKHOLE` `ACTION_MITIGATE_ONPREM` `ACTION_MITIGATE_CLOUD`
`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.	`true` `false`
`pps_limit`	Das konfigurierte Limit für Pakete pro Sekunde.	`integer`
`bw_limit`	Das konfigurierte Bandbreitenlimit.	`integer`
`pps_limit_percentage` (falls prozentuale Schwellenwerte aktiviert)	Das PPS-Limit in Prozent.	`integer`
`bw_limit_percentage` (falls prozentuale Schwellenwerte aktiviert)	Das Bandbreitenlimit in Prozent.	`integer`
`autoStatus`	Zeigt an, ob das Netzwerk sich aktuell in einer automatischen Mitigation befindet.	`true` `false`
`manualStatus`	Zeigt an, ob das Netzwerk sich aktuell in einer manuellen Mitigation befindet.	`true` `false`
`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.	`true` `false`
`extra`	Zusätzliche benutzerdefinierte Felder der Organisation.	`object`

Beispiel¶

Beispiel-Antwort:

{
  "data": [
    {
      "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": {}
    }
  ],
  "links": {
    "first": "https://datahub-api.com/api/networks?page=1",
    "last": "https://datahub-api.com/api/networks?page=5",
    "prev": null,
    "next": "https://datahub-api.com/api/networks?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [
      {
        "url": "https://datahub-api.com/api/networks?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://datahub-api.com/api/networks",
    "per_page": 15,
    "to": 15,
    "total": 64
  }
}

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.