Alle Netzwerke der Organisation auflisten

Note

SOC-Konten müssen stattdessen eine Organisation explizit über den Endpunkt /organisations/{organisation}/networks ansprechen.

Senden einer GET-Anfrage an den Endpunkt /networks.

Beschreibung

Mit der List-Networks-Anfrage fordern Sie eine Liste aller Netzwerke der Organisation an.

Voraussetzungen

Werte der Anfrage: keine

Objekte: keine

Anfrage

Um eine Liste aller Netzwerke anzufordern, ist im Pfad der Anfrage keine zusätzliche Information erforderlich.

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, referenziert durch `id` und `name`.	`object`
`name`	Der Name des Netzwerks.	`string`
`cidr`	Der IP-Bereich des Netzwerks in CIDR-Notation.	`string`
`enabled`	Definiert, ob die automatische Mitigation aktiviert ist.	`true` `false`
`mitigation_type`	Die Art der Mitigation, die bei Überschreitung der Schwellenwerte angewendet wird.	`ACTION_BLACKHOLE` `ACTION_MITIGATE_ONPREM` `ACTION_MITIGATE_CLOUD`
`auto_mitigation_strategy`	Die Strategie für die automatische Mitigation.	`string`
`duration`	Die Dauer der automatischen Mitigation in Sekunden.	`integer`
`pps_limit`	Das konfigurierte PPS-Limit.	`integer`
`bw_limit`	Das konfigurierte Bandbreitenlimit.	`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_manual_mitigations`	Die aktiven partiellen manuellen Mitigationen des Netzwerks.	`array`
`active_partial_auto_mitigations`	Die aktiven partiellen automatischen Mitigationen des Netzwerks.	`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,
      "mitigation_type": "ACTION_BLACKHOLE",
      "auto_mitigation_strategy": "IP",
      "duration": 0,
      "pps_limit": 0,
      "bw_limit": 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.