Freigeben über


Warnungsverwaltungs-API-Referenz für lokale Verwaltungskonsolen

In diesem Artikel werden die REST-APIs für die Warnungsverwaltung aufgeführt, die für lokale Verwaltungskonsolen von Microsoft Defender für IoT unterstützt werden.

Warnungen (Warnungsinformationen abrufen)

Verwenden Sie diese API, um alle oder gefilterten Warnungen aus einer lokalen Verwaltungskonsole abzurufen.

URI-: /external/v1/alerts oder /external/v2/alerts

ERHALTEN

Abfrageparameter:

Name Beschreibung Beispiel Erforderlich/Optional
Zustand Erhalten Sie nur behandelte oder nicht behandelte Warnungen. Unterstützte Werte:
- handled
- unhandled
Alle anderen Werte werden ignoriert.
/api/v1/alerts?state=handled Wahlfrei
vonTime Erhalten Sie Benachrichtigungen, die ab einem bestimmten Zeitpunkt erstellt werden, in Millisekunden aus der Epochenzeit und in UTC-Zeitzone. /api/v1/alerts?fromTime=<epoch> Wahlfrei
toTime- Erhalten Sie Warnungen, die nur zu einem bestimmten Zeitpunkt erstellt wurden, in Millisekunden aus der Epochenzeit und in UTC-Zeitzone. /api/v1/alerts?toTime=<epoch> Wahlfrei
siteId- Die Website, auf der die Warnung entdeckt wurde. /api/v1/alerts?siteId=1 Wahlfrei
zoneId- Die Zone, in der die Warnung entdeckt wurde. /api/v1/alerts?zoneId=1 Wahlfrei
sensorId- Der Sensor, auf dem die Warnung entdeckt wurde. /api/v1/alerts?sensorId=1 Wahlfrei

Anmerkung

Möglicherweise verfügen Sie nicht über die Website- und Zonen-ID. Wenn dies der Fall ist, fragen Sie zuerst alle Geräte ab, um die Website- und Zonen-ID abzurufen. Weitere Informationen finden Sie unter Integrations-API-Referenz für lokale Verwaltungskonsolen (Öffentliche Vorschau).

UUID (Verwalten von Warnungen basierend auf der UUID)

Verwenden Sie diese API, um bestimmte Aktionen für eine bestimmte Warnung auszuführen, die von Defender für IoT erkannt wurde.

Sie können diese API beispielsweise verwenden, um eine Weiterleitungsregel zu erstellen, die Daten an QRadar weiterleitet. Weitere Informationen finden Sie unter Integrieren von Qradar in Microsoft Defender für IoT.

URI-: /external/v1/alerts/<UUID>

STELLEN

Typ: JSON

Abfrageparameter:

Name Beschreibung Beispiel Erforderlich/Optional
UUID- Definiert den universellen eindeutigen Bezeichner (UniversalLy Unique Identifier, UUID) für die Warnung, die Sie behandeln oder verarbeiten und lernen möchten. /api/v1/alerts/7903F632-H7EJ-4N69-F40F-4B1E689G00Q0 Erforderlich

Body-Parameter

Name Beschreibung Beispiel Erforderlich/Optional
Aktion Schnur Entweder handle oder handleAndLearn Erforderlich

Anforderungsbeispiel

{
    "action": "handle"
}

maintenanceWindow (Erstellen von Warnungsausschlüssen)

Verwaltet Wartungsfenster, unter denen Benachrichtigungen nicht gesendet werden. Verwenden Sie diese API, um Stopp- und Startzeiten, Geräte oder Subnetze zu definieren und zu aktualisieren, die beim Auslösen von Warnungen ausgeschlossen werden sollen, oder definieren und aktualisieren Sie Defender für IoT-Engines, die ausgeschlossen werden sollten.

Beispielsweise sollten Sie während eines Wartungsfensters die Benachrichtigungsübermittlung aller Warnungen beenden, mit Ausnahme von Schadsoftwarewarnungen auf kritischen Geräten.

Die Wartungsfenster, die mit der maintenanceWindow-API definiert werden, werden im Fenster "Warnungsausschlüsse" der lokalen Verwaltungskonsole als schreibgeschützte Ausschlussregel angezeigt, die mit der folgenden Syntax benannt ist: Maintenance-{token name}-{ticket ID}.

Wichtig

Diese API wird nur für Wartungszwecke und für einen begrenzten Zeitraum unterstützt und sollte nicht anstelle von Warnungsausschlussregelnverwendet werden. Verwenden Sie diese API nur für einmalige, temporäre Wartungsvorgänge.

URI-: /external/v1/maintenanceWindow

BEREITSTELLEN

Erstellt ein neues Wartungsfenster.

Body-Parameter:

Name Beschreibung Beispiel Erforderlich/Optional
ticketId- Schnur. Definiert die Wartungsticket-ID in den Systemen des Benutzers. Stellen Sie sicher, dass die Ticket-ID nicht mit einem vorhandenen geöffneten Fenster verknüpft ist. 2987345p98234 Erforderlich
ttl- Positive ganze Zahl. Definiert die TTL (Zeit für das Leben), bei der es sich um die Dauer des Wartungsfensters handelt, in Minuten. Nach Abschluss des definierten Zeitraums wird das Wartungsfenster beendet, und das System verhält sich normal wieder. 180 Erforderlich
Engines JSON-Array von Zeichenfolgen. Definiert, von welchem Modul Warnungen während des Wartungsfensters unterdrückt werden sollen. Mögliche Werte:

- ANOMALY
- MALWARE
- OPERATIONAL
- POLICY_VIOLATION
- PROTOCOL_VIOLATION
ANOMALY,OPERATIONAL Wahlfrei
sensorIds JSON-Array von Zeichenfolgen. Definiert, von welchen Sensoren Warnungen während des Wartungsfensters unterdrückt werden sollen. Sie können diese Sensor-IDs aus den Appliances (Manage OT Sensor Appliances) API abrufen. 1,35,63 Wahlfrei
Subnetze JSON-Array von Zeichenfolgen. Definiert die Subnetze, um Warnungen während des Wartungsfensters zu unterdrücken. Definieren Sie jedes Subnetz in einer CIDR-Notation. 192.168.0.0/16,138.136.80.0/14,112.138.10.0/8 Wahlfrei

LÖSCHEN

Schließt ein vorhandenes Wartungsfenster.

Abfrageparameter:

Name Beschreibung Beispiel Erforderlich/Optional
ticketId- Definiert die Wartungsticket-ID in den Systemen des Benutzers. Stellen Sie sicher, dass die Ticket-ID mit einem vorhandenen geöffneten Fenster verknüpft ist. 2987345p98234 Erforderlich

ERHALTEN

Rufen Sie ein Protokoll aller geöffneten (POST-) abschließen Sie (DELETE) und Aktualisieren (PUT) Aktionen, die mit dieser API zum Behandeln von Wartungsfenstern ausgeführt wurden. T

Abfrageparameter:

Name Beschreibung Beispiel Erforderlich/Optional
vonDate Filtert die Protokolle aus dem vordefinierten Datum und höher. Das Format ist YYYY-MM-DD. 2022-08-10 Wahlfrei
toDate- Filtert die Protokolle bis zum vordefinierten Datum. Das Format ist YYYY-MM-DD. 2022-08-10 Wahlfrei
ticketId- Filtert die Protokolle im Zusammenhang mit einer bestimmten Ticket-ID. 9a5fe99c-d914-4bda-9332-307384fe40bf Wahlfrei
tokenName- Filtert die Protokolle im Zusammenhang mit einem bestimmten Tokennamen. Vierteljährliches Sanity-Fenster Wahlfrei

Fehlercodes:

Code Nachricht Beschreibung
200 OKAY Die Aktion wurde erfolgreich abgeschlossen.
204: Kein Inhalt Es sind keine Daten vorhanden, die angezeigt werden sollen.
400 Ungültige Anforderung Das Datumsformat ist falsch.
500 Interner Serverfehler Jeder andere unerwartete Fehler.

STELLEN

Ermöglicht es Ihnen, die Dauer des Wartungsfensters zu aktualisieren, nachdem Sie den Wartungsvorgang gestartet haben, indem Sie den parameter ttl ändern. Die neue Dauerdefinition setzt die vorherige außer Kraft.

Diese Methode ist nützlich, wenn Sie eine längere Dauer als die aktuell konfigurierte Dauer festlegen möchten. Wenn Sie beispielsweise ursprünglich 180 Minuten definiert haben, 90 Minuten vergangen sind und Sie weitere 30 Minuten hinzufügen möchten, aktualisieren Sie die ttl auf 120 Minute, um die Daueranzahl zurückzusetzen.

Abfrageparameter:

Name Beschreibung Beispiel Erforderlich/Optional
ticketId- Schnur. Definiert die Wartungsticket-ID in den Systemen des Benutzers. 2987345p98234 Erforderlich
ttl- Positive ganze Zahl. Definiert die Dauer des Fensters in Minuten. 210 Erforderlich

PCAP (Anforderungsbenachrichtigung PCAP)

Verwenden Sie diese API, um eine PCAP-Datei im Zusammenhang mit einer Warnung anzufordern.

URI-: /external/v2/alerts/

ERHALTEN

Abfrageparameter:

Name Beschreibung Beispiel Erforderlich/Optional
id Warnungs-ID über die lokale Verwaltungskonsole /external/v2/alerts/pcap/<id> Erforderlich

Nächste Schritte

Weitere Informationen finden Sie in der Defender für IoT-API-Referenzübersicht.