Share via


Informazioni di riferimento sull'API di integrazione per le console di gestione locali (anteprima pubblica)

Questo articolo elenca le API supportate per l'integrazione di Microsoft Defender per IoT con i servizi partner.

Ad esempio, questa API è attualmente implementata con Esercitazione: Integrare ServiceNow con Microsoft Defender per IoT, tramite ServiceNow Service Graph Connector per Defender per IoT.

Nota

Le API di integrazione sono destinate a eseguire continuamente e creare un flusso di dati in esecuzione costante, ad esempio per eseguire query per i nuovi dati degli ultimi cinque minuti. Le API di integrazione restituiscono dati con un timestamp.

Per eseguire semplicemente query sui dati, usare le API regolari e non di integrazione, per una console di gestione locale per eseguire query su tutti i dispositivi o per un sensore specifico per eseguire query solo sui dispositivi da tale sensore. Per altre informazioni, vedere Informazioni di riferimento sull'API Defender per IoT.

URI: /external/v3/integration/

dispositivi (Creare e aggiornare i dispositivi)

Questa API restituisce i dati relativi a tutti i dispositivi aggiornati dopo il timestamp specificato.

URI: /external/v3/integration/devices/<timestamp>

Parametri URI:

Nome Descrizione Esempio Obbligatoria / Facoltativa
timestamp Ora di inizio da cui vengono restituiti i risultati, in millisecondi dall'ora Epoch e nel fuso orario UTC. /external/v3/integration/devices/1664781014000 Necessario

GET

Parametri di query:

Nome Descrizione Esempio Obbligatoria / Facoltativa
sensorId Restituisce solo i dispositivi visualizzati da un sensore specifico. Usare il valore ID dai risultati dell'API Sensori (Get sensor). 1 Facoltativo
notificationType Determina i tipi di dispositivi da restituire. I valori supportati includono:
- 0: sia aggiornati che nuovi dispositivi (impostazione predefinita).
- 1: solo nuovi dispositivi.
- 2: solo dispositivi aggiornati.
2 Facoltativo
page Definisce il numero in cui inizia la numerazione della pagina dei risultati. Ad esempio, 0= la prima pagina è 0.
Impostazione predefinita = 0
0 Facoltativo
size Definisce il ridimensionamento della pagina. Impostazione predefinita = 50 75 Facoltativo

connessioni (Ottenere le connessioni del dispositivo)

Questa API restituisce i dati relativi a tutte le connessioni del dispositivo aggiornate dopo il timestamp specificato.

URI: /external/v3/integration/connections/<timestamp>

Parametri URI:

Nome Descrizione Esempio Obbligatoria / Facoltativa
timestamp Ora di inizio da cui vengono restituiti i risultati, in millisecondi dall'ora Epoch e nel fuso orario UTC. /external/v3/integration/devices/1664781014000 Necessario

GET

Parametri di query:

Nome Descrizione Esempio Obbligatoria / Facoltativa
page Definisce il numero in cui inizia la numerazione della pagina dei risultati. Ad esempio, 0= la prima pagina è 0.
Impostazione predefinita = 0
0 Facoltativo
size Definisce il ridimensionamento della pagina. Impostazione predefinita = 50 75 Facoltativo

dispositivo (ottenere i dettagli per un dispositivo)

Questa API restituisce dati relativi a un dispositivo specifico per ogni ID dispositivo specificato.

URI: /external/v3/integration/device/{deviceId}

GET

Parametri di query:

Nome Descrizione Esempio Obbligatoria / Facoltativa
Deviceid ID del dispositivo richiesto nella console di gestione locale 1 Necessario

deleteddevices (Get deleted devices)

Questa API restituisce un elenco di ID di dispositivi eliminati di recente, dal timestamp fornito.

URI: /external/v3/integration/deleteddevices/

GET

Parametri URI:

Nome Descrizione Esempio Obbligatoria / Facoltativa
timestamp Ora di inizio da cui vengono restituiti i risultati, in millisecondi dall'ora Epoch e nel fuso orario UTC. /external/v3/integration/deleteddevices/1664781014000 Necessario

sensori (Get sensor)

Questa API restituisce un elenco di oggetti sensore per i sensori di rete OT connessi.

URI: /external/v3/integration/sensors/

GET

URI: /sensors

Nessun parametro di query

devicecves (Get device CVEs)

Questa API restituisce un elenco di CVE attivi per tutti i dispositivi aggiornati dal timestamp fornito.

URI: /external/v3/integration/devicecves/

GET

URI: /external/v3/integration/devicecves/<timestamp>

Parametri URI

Nome Descrizione Esempio Obbligatoria / Facoltativa
timestamp Ora di inizio da cui vengono restituiti i risultati, in millisecondi dall'ora Epoch e nel fuso orario UTC. /external/v3/integration/devicecves/1664781014000 Necessario

Parametri di query

Nome Descrizione Esempio Obbligatoria / Facoltativa
page Definisce il numero in cui inizia la numerazione della pagina dei risultati. 0= la prima pagina è 0.
Impostazione predefinita = 0
Facoltativo
size Definisce il ridimensionamento della pagina. Impostazione predefinita = 50 Facoltativo
sensorId Mostra i risultati di un sensore specifico, come definito dall'ID sensore specificato. 1 Facoltativo
Punteggio Determina un punteggio CVE minimo da recuperare. Tutti i risultati avranno un punteggio CVE uguale o maggiore del valore specificato. Valore predefinito = 0. Facoltativo
deviceIds Elenco delimitato da virgole di ID dispositivo da cui si desidera visualizzare i risultati. ad esempio 1232,34,2,456 Facoltativo

Passaggi successivi

Per altre informazioni, vedere: