Alle Netzwerke einer Organisation auflisten

Note

Die Attribute pps_limit_percentage und bw_limit_percentage sind nur vorhanden, wenn für die Organisation prozentuale Schwellenwerte aktiviert sind.

Senden einer GET-Anfrage an den Endpunkt /organisations/{organisation}/networks.

Beschreibung

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

Voraussetzungen

Werte der Anfrage: Organisation-ID {organisation}

Objekte: keine

Anfrage

Um eine Liste aller Netzwerke einer Organisation anzufordern, fügen Sie die Organisation-ID {organisation} 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, referenziert über ID und Name.	`object`
`name`	Der Name des Netzwerks.	`string`
`cidr`	Der CIDR-Bereich des Netzwerks.	`string`
`enabled`	Zeigt an, ob die automatische Mitigation aktiviert ist.	`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`
`pps_limit`	Der konfigurierte Grenzwert für Pakete pro Sekunde.	`integer`
`bw_limit`	Der konfigurierte Bandbreiten-Grenzwert.	`integer`
`autoStatus`	Zeigt an, ob das Netzwerk aktuell unter automatischer Mitigation steht.	`true` `false`
`manualStatus`	Zeigt an, ob das Netzwerk aktuell unter manueller Mitigation steht.	`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, ob für das Netzwerk manuelle Mitigationen gestartet werden dürfen.	`true` `false`
`extra`	Zusätzliche benutzerdefinierte Felder, die für die Organisation definiert sind.	`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.