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

anfordern
Antwort-
cURL-Befehl

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).

Typ: JSON

Eine Liste der Warnungen mit den folgenden Feldern:

Name	Art	Nullable / Nicht nullable	Liste der Werte
-ID-	Numerisch	Lässt keine Nullwerte zu.	-
sensorId-	Numerisch	Lässt keine Nullwerte zu.	-
zoneId-	Numerisch	Lässt keine Nullwerte zu.	-
Zeit	Numerisch	Lässt keine Nullwerte zu.	Millisekunden aus Epochenzeitin UTC-Zeitzone
Titel	Schnur	Lässt keine Nullwerte zu.	-
nachricht	Schnur	Lässt keine Nullwerte zu.	-
schweregrad	Schnur	Lässt keine Nullwerte zu.	`Warning`, `Minor`, `Major`oder `Critical`
Engine	Schnur	Lässt keine Nullwerte zu.	`Protocol Violation`, `Policy Violation`, `Malware`, `Anomaly`oder `Operational`
sourceDevice-	Numerisch	Nullable	Geräte-ID
destinationDevice-	Numerisch	Nullable	Geräte-ID
RemediationSteps-	Schnur	Nullable	In Warnung angezeigte Korrekturschritte
additionalInformation	Zusätzliches Informationsobjekt	Nullable	-
behandelte	Boolescher Status der Warnung	Lässt keine Nullwerte zu.	`true` oder `false`

Zusätzliche Informationsfelder:

Name	Art	Nullable / Nicht nullable	Liste der Werte
Beschreibung	Schnur	Lässt keine Nullwerte zu.	-
Informationen	JSON-Array	Lässt keine Nullwerte zu.	Schnur

für V2-hinzugefügt:

Name	Art	Nullable / Nicht nullable	Liste der Werte
sourceDeviceAddress-	Schnur	Nullable	IP- oder MAC-Adresse
destinationDeviceAddress	Schnur	Nullable	IP- oder MAC-Adresse
RemediationSteps-	JSON-Array	Lässt keine Nullwerte zu.	Zeichenfolgen, In Warnung beschriebene Korrekturschritte
sensorName-	Schnur	Lässt keine Nullwerte zu.	Name des vom Benutzer definierten Sensors
zoneName-	Schnur	Lässt keine Nullwerte zu.	Name der Zone, die dem Sensor zugeordnet ist
siteName-	Schnur	Lässt keine Nullwerte zu.	Name des Standorts, der dem Sensor zugeordnet ist

Weitere Informationen finden Sie unter Sensor-API-Versionsreferenz.

Antwortbeispiel

[
    {
        "engine": "Operational",
        "handled": false,
        "title": "Traffic Detected on sensor Interface",
        "additionalInformation": null,
        "sourceDevice": 0,
        "zoneId": 1,
        "siteId": 1,
        "time": 1594808245000,
        "sensorId": 1,
        "message": "The sensor resumed detecting network traffic on ens224.",
        "destinationDevice": 0,
        "id": 1,
        "severity": "Warning"
    },
    {
        "engine": "Anomaly",
        "handled": false,
        "title": "Address Scan Detected",
        "additionalInformation": null,
        "sourceDevice": 4,
        "zoneId": 1,
        "siteId": 1,
        "time": 1594808260000,
        "sensorId": 1,
        "message": "Address scan detected.\nScanning address: 10.10.10.22\nScanned subnet: 10.11.0.0/16\nScanned addresses: 10.11.1.1, 10.11.20.1, 10.11.20.10, 10.11.20.100, 10.11.20.2, 10.11.20.3, 10.11.20.4, 10.11.20.5, 10.11.20.6, 10.11.20.7...\nIt is recommended to notify the security officer of the incident.",
        "destinationDevice": 0,
        "id": 2,
        "severity": "Critical"
    },
    {
        "engine": "Operational",
        "handled": false,
        "title": "Suspicion of Unresponsive MODBUS Device",
        "additionalInformation": null,
        "sourceDevice": 194,
        "zoneId": 1,
        "siteId": 1,
        "time": 1594808285000,
        "sensorId": 1,
        "message": "Outstation device 10.13.10.1 (Protocol Address 53) seems to be unresponsive to MODBUS requests.",
        "destinationDevice": 0,
        "id": 3,
        "severity": "Minor"
    }
]

Typ: GET

API-:

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<>IP_ADDRESS>/external/v1/alerts?state=&zoneId=&fromTime=&toTime=&siteId=&sensor='

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/alerts?state=unhandled&zoneId=1&fromTime=0&toTime=1594551777000&siteId=1&sensor=1'

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

anfordern
Antwort-
cURL-Befehl

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"
}

Typ: JSON

Array von JSON-Objekten, die Geräte darstellen.

Antwortfelder:

Name	Art	Erforderlich/Optional	Beschreibung
Inhalt/Fehler-	Schnur	Erforderlich	Wenn die Anforderung erfolgreich ist, wird die Inhaltseigenschaft angezeigt. Andernfalls wird die Fehlereigenschaft angezeigt.

Mögliche Inhaltswerte:

Statuscode	Nachricht	Beschreibung
200	Die Warnungsaktualisierungsanforderung wurde erfolgreich abgeschlossen.	Die Updateanforderung wurde erfolgreich abgeschlossen. Keine Kommentare.
200	Warnung wurde bereits behandelt (Handle).	Die Warnung wurde bereits behandelt, wenn eine Handle-Anforderung für die Warnung empfangen wurde. Die Warnung bleibt behandelt.
200	Warnung wurde bereits behandelt und gelernt (handleAndLearn).	Die Warnung wurde bereits behandelt und gelernt, als eine Anforderung zum handleAndLearn empfangen wurde. Die Warnung verbleibt im handledAndLearn Status.
200	Warnung wurde bereits behandelt (behandelt). Behandeln und Lernen (handleAndLearn) wurde für die Warnung ausgeführt.	Die Warnung wurde bereits behandelt, wenn eine Anforderung zum handleAndLearn empfangen wurde. Die Warnung wird handleAndLearn.
200	Warnung wurde bereits behandelt und gelernt (handleAndLearn). Ignorierte Handle-Anforderung.	Die Warnung wurde bereits handleAndLearn, als eine Anforderung zum Behandeln der Warnung empfangen wurde. Die Warnung bleibt handleAndLearn.
500	Ungültige Aktion.	Die gesendete Aktion ist keine gültige Aktion, die für die Warnung ausgeführt werden soll.
500	Unerwarteter Fehler.	Unerwarteter Fehler. Wenden Sie sich an den technischen Support, um das Problem zu beheben.
500	Anforderung konnte nicht ausgeführt werden, weil für diese UUID keine Warnung gefunden wurde.	Die angegebene UUID wurde im System nicht gefunden.

Antwortbeispiel: Erfolgreich

{
    "content": "Alert update request finished successfully"
}

Antwortbeispiel: Erfolglos

{
    "error": "Invalid action"
}

Typ: PUT

APIs:

curl -k -X PUT -d '{"action": "<ACTION>"}' -H "Authorization: <AUTH_TOKEN>" https://<IP_ADDRESS>/external/v1/alerts/<UUID>

Beispiel:

curl -k -X PUT -d '{"action": "handle"}' -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/external/v1/alerts/1-1594550943000

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.

anfordern
Antwort-
cURL-Befehl

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

Statuscode	Nachricht	Beschreibung
201 (Erstellt)	-	Die Aktion wurde erfolgreich abgeschlossen.
400 (Ungültige Anfrage)	Keine TicketId	Die API-Anforderung fehlte ein `ticketId` Wert.
400 (Ungültige Anfrage)	Ungültiger TTL-Parameter	Die API-Anforderung enthielt einen nicht positiven oder nicht numerischen TTL-Wert.
400 (Ungültige Anfrage)	Anforderung konnte nicht analysiert werden.	Problem beim Analysieren des Textkörpers, z. B. falsche Parameter oder ungültige Werte.
400 (Ungültige Anfrage)	Das Wartungsfenster mit denselben Parametern ist bereits vorhanden.	Wird angezeigt, wenn bereits ein vorhandenes Wartungsfenster mit denselben Details vorhanden ist.
404 (Nicht gefunden)	Unbekannte Sensor-ID	Einer der in der Anforderung aufgeführten Sensoren ist nicht vorhanden.
409 (Konflikt)	Die Ticket-ID verfügt bereits über ein geöffnetes Fenster.	Die Ticket-ID ist mit einem anderen geöffneten Wartungsfenster verknüpft.
500 (Interner Serverfehler)	-	Jeder andere unerwartete Fehler.

Typ: POST

API-:

curl -k -X POST -d '{"ticketId": "<TICKET_ID>",ttl": <TIME_TO_LIVE>,"engines": [<ENGINE1, ENGINE2...ENGINEn>],"sensorIds": [<SENSOR_ID1, SENSOR_ID2...SENSOR_IDn>],"subnets": [<SUBNET1, SUBNET2....SUBNETn>]}' -H "Authorization: <AUTH_TOKEN>" https://<IP address>/external/v1/maintenanceWindow

Beispiel:

curl -k -X POST -d '{"ticketId": "a5fe99c-d914-4bda-9332-307384fe40bf","ttl": "20","engines": ["ANOMALY"],"sensorIds": ["5","3"],"subnets": ["10.0.0.0/16"]}' -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/external/v1/maintenanceWindow

LÖSCHEN

Schließt ein vorhandenes Wartungsfenster.

anfordern
Antwort-
cURL-Befehl

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

Fehlercodes:

Code	Nachricht	Beschreibung
200 (OK)	-	Die Aktion wurde erfolgreich abgeschlossen.
400 (Ungültige Anfrage)	Keine TicketId	Der ticketId Parameter fehlt in der Anforderung.
404 (Nicht gefunden):	Wartungsfenster nicht gefunden.	Die Ticket-ID ist nicht mit einem geöffneten Wartungsfenster verknüpft.
500 (Interner Serverfehler)	-	Jeder andere unerwartete Fehler.

Typ: DELETE

API-:

curl -k -X DELETE -d '{"ticketId": "<TICKET_ID>"}' -H "Authorization: <AUTH_TOKEN>" https://<IP address>/external/v1/maintenanceWindow

Beispiel:

curl -k -X DELETE -d '{"ticketId": "a5fe99c-d914-4bda-9332-307384fe40bf"}' -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/external/v1/maintenanceWindow

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

anfordern
Antwort-
cURL-Befehl

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.

Typ: JSON

Array von JSON-Objekten, die Wartungsfenstervorgänge darstellen.

Antwortstruktur:

Name	Art	Nullable / Nicht nullable	Liste der Werte
id	Lange ganze Zahl	Lässt keine Nullwerte zu.	Eine interne ID für das aktuelle Protokoll
dateTime-	Schnur	Lässt keine Nullwerte zu.	Die Zeit, zu der die Aktivität aufgetreten ist, z. B.: `2022-04-23T18:25:43.511Z`
ticketId-	Schnur	Lässt keine Nullwerte zu.	Die Wartungsfenster-ID. Beispiel: `9a5fe99c-d914-4bda-9332-307384fe40bf`
tokenName-	Schnur	Lässt keine Nullwerte zu.	Der Name des Wartungsfenstertokens. Beispiel: `quarterly-sanity-window`
Engines	Array von Zeichenfolgen	Nullable	Die Motoren, auf die das Wartungsfenster angewendet wird, wie bei der Erstellung von Wartungsfenstern angegeben: `Protocol Violation`, `Policy Violation`, `Malware`, `Anomaly`oder `Operational`
sensorIds	Array der Zeichenfolge	Nullable	Die Sensoren, auf die das Wartungsfenster angewendet wird, wie bei der Erstellung von Wartungsfenstern angegeben.
Subnetze	Array der Zeichenfolge	Nullable	Die Subnetze, auf die das Wartungsfenster angewendet wird, wie bei der Erstellung von Wartungsfenstern angegeben.
ttl-	Numerisch	Nullable	Die Time to Live (TTL) des Wartungsfensters, wie während der Erstellung oder Aktualisierung des Wartungsfensters angegeben.
operationType-	Schnur	Lässt keine Nullwerte zu.	Einer der folgenden Werte: `OPEN`, `UPDATE`und `CLOSE`

Typ: GET

API-:

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/external/v1/maintenanceWindow?fromDate=&toDate=&ticketId=&tokenName='

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/maintenanceWindow?fromDate=2020-01-01&toDate=2020-07-14&ticketId=a5fe99c-d914-4bda-9332-307384fe40bf&tokenName=a'

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.

anfordern
Antwort-
cURL-Befehl

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

Fehlercodes:

Code	Nachricht	Beschreibung
200 (OK)	-	Die Aktion wurde erfolgreich abgeschlossen.
400 (Ungültige Anfrage)	Keine TicketId	Die Anforderung fehlt ein `ticketId` Wert.
400 (Ungültige Anfrage)	Ungültiger TTL-Parameter	Die definierte TTL ist keine numerische oder keine positive ganze Zahl.
400 (Ungültige Anfrage)	Anforderung konnte nicht analysiert werden	Die Anforderung fehlt ein `ttl` Parameterwert.
404 (Nicht gefunden)	Wartungsfenster nicht gefunden	Die Ticket-ID ist nicht mit einem geöffneten Wartungsfenster verknüpft.
500 (Interner Serverfehler)	-	Jeder andere unerwartete Fehler.

Typ: PUT

API-:

curl -k -X PUT -d '{"ticketId": "<TICKET_ID>",ttl": "<TIME_TO_LIVE>"}' -H "Authorization: <AUTH_TOKEN>" https://<IP address>/external/v1/maintenanceWindow

Beispiel:

curl -k -X PUT -d '{"ticketId": "a5fe99c-d914-4bda-9332-307384fe40bf","ttl": "20"}' -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/external/v1/maintenanceWindow

PCAP (Anforderungsbenachrichtigung PCAP)

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

URI-: /external/v2/alerts/

ERHALTEN

anfordern
Antwort-
cURL-Befehl

Abfrageparameter:

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

Typ: JSON

Meldungszeichenfolge mit den Vorgangsstatusdetails:

Statuscode	Nachricht	Beschreibung
200 (OK)	-	JSON-Objekt mit Daten zur angeforderten PCAP-Datei. Weitere Informationen finden Sie unter Datenfelder.
500 (Interner Serverfehler)	Warnung nicht gefunden	Die angegebene Warnungs-ID wurde in der lokalen Verwaltungskonsole nicht gefunden.
500 (Interner Serverfehler)	Fehler beim Abrufen des Tokens für xSense-ID `<number>`	Fehler beim Abrufen des Sensortokens für die angegebene Sensor-ID
500 (Interner Serverfehler)	-	Jeder andere unerwartete Fehler.

Datenfelder

Name	Art	Nullable / Nicht nullable	Liste der Werte
id	Numerisch	Lässt keine Nullwerte zu.	Die lokale Verwaltungskonsolenbenachrichtigungs-ID
xsenseId-	Numerisch	Lässt keine Nullwerte zu.	Die Sensor-ID
xsenseAlertId-	Numerisch	Lässt keine Nullwerte zu.	Die Warnungs-ID der Sensorkonsole
downloadUrl-	Schnur	Lässt keine Nullwerte zu.	Die URL zum Herunterladen der PCAP-Datei
Token-	Schnur	Lässt keine Nullwerte zu.	Das Token des Sensors, das beim Herunterladen der PCAP-Datei verwendet werden soll

Antwortbeispiel: Erfolg

{
  "downloadUrl": "https://10.1.0.2/api/v2/alerts/pcap/1",
  "xsenseId": 1,
  "token": "d2791f58-2a88-34fd-ae5c-2651fe30a63c",
  "id": 1,
  "xsenseAlertId": 1
}

Antwortbeispiel: Fehler

{
  "error": "alert not found"
}

Typ: GET

-APIs

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/external/v2/alerts/pcap/<ID>'

* Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://10.1.0.1/external/v2/alerts/pcap/1'

Nächste Schritte

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

Last updated on 2022-06-13

Freigeben über

Warnungsverwaltungs-API-Referenz für lokale Verwaltungskonsolen

Warnungen (Warnungsinformationen abrufen)

ERHALTEN

UUID (Verwalten von Warnungen basierend auf der UUID)

STELLEN

maintenanceWindow (Erstellen von Warnungsausschlüssen)

BEREITSTELLEN

LÖSCHEN

ERHALTEN

STELLEN

PCAP (Anforderungsbenachrichtigung PCAP)

ERHALTEN

Nächste Schritte

Zusätzliche Ressourcen