Informazioni di riferimento sulle 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 progettate per l'esecuzione continua e la creazione di un flusso di dati in esecuzione costante, ad esempio per eseguire query sui nuovi dati degli ultimi cinque minuti. Le API di integrazione restituiscono dati con un timestamp.
Per eseguire semplicemente query sui dati, usare invece le NORMALI API non di integrazione, per una console di gestione locale per eseguire query su tutti i dispositivi o per un sensore specifico per eseguire query sui dispositivi solo da tale sensore. Per altre informazioni, vedere Informazioni di riferimento sulle API di Defender per IoT.
URI: /external/v3/integration/
dispositivi (creare e aggiornare i dispositivi)
Questa API restituisce dati su tutti i dispositivi aggiornati dopo il timestamp specificato.
URI: /external/v3/integration/devices/<timestamp>
parametri URI:
Nome | Descrizione | Esempio | Obbligatorio/Facoltativo |
---|---|---|---|
timestamp | Ora di inizio da cui vengono restituiti i risultati, in millisecondi da periodo di tempo e in fuso orario UTC. | /external/v3/integration/devices/1664781014000 |
Obbligatorio |
OTTIENI
parametri di query:
Nome | Descrizione | Esempio | Obbligatorio/Facoltativo |
---|---|---|---|
sensorId | Restituisce solo i dispositivi visualizzati da un sensore specifico. Usare il valore ID dai risultati dell'API sensori |
1 |
Opzionale |
notificationType | Determina i tipi di dispositivi da restituire. I valori supportati includono: - 0 : sia i dispositivi aggiornati che i nuovi dispositivi (impostazione predefinita). - 1 : solo i nuovi dispositivi. - 2 : solo i dispositivi aggiornati. |
2 |
Opzionale |
pagina | Definisce il numero in cui inizia la numerazione della pagina dei risultati. Ad esempio, 0 = prima pagina è 0. Valore predefinito = 0 |
0 |
Opzionale |
dimensioni | Definisce il ridimensionamento della pagina. Valore predefinito = 50 |
75 |
Opzionale |
connessioni (Ottenere connessioni dispositivo)
Questa API restituisce dati su tutte le connessioni del dispositivo aggiornate dopo il timestamp specificato.
URI: /external/v3/integration/connections/<timestamp>
parametri URI:
Nome | Descrizione | Esempio | Obbligatorio/Facoltativo |
---|---|---|---|
timestamp | Ora di inizio da cui vengono restituiti i risultati, in millisecondi da periodo di tempo e in fuso orario UTC. | /external/v3/integration/devices/1664781014000 |
Obbligatorio |
OTTIENI
parametri di query:
Nome | Descrizione | Esempio | Obbligatorio/Facoltativo |
---|---|---|---|
pagina | Definisce il numero in cui inizia la numerazione della pagina dei risultati. Ad esempio, 0 = prima pagina è 0. Valore predefinito = 0 |
0 |
Opzionale |
dimensioni | Definisce il ridimensionamento della pagina. Valore predefinito = 50 |
75 |
Opzionale |
dispositivo (ottenere i dettagli per un dispositivo)
Questa API restituisce dati su un dispositivo specifico per ogni ID dispositivo specificato.
URI: /external/v3/integration/device/{deviceId}
OTTIENI
parametri di query:
Nome | Descrizione | Esempio | Obbligatorio/Facoltativo |
---|---|---|---|
deviceId | ID del dispositivo richiesto nella console di gestione locale | 1 |
Obbligatorio |
deleteddevices (Ottieni dispositivi eliminati)
Questa API restituisce un elenco di ID di dispositivi eliminati di recente, dal timestamp fornito.
URI: /external/v3/integration/deleteddevices/
OTTIENI
parametri URI:
Nome | Descrizione | Esempio | Obbligatorio/Facoltativo |
---|---|---|---|
timestamp | Ora di inizio da cui vengono restituiti i risultati, in millisecondi da periodo di tempo e in fuso orario UTC. | /external/v3/integration/deleteddevices/1664781014000 |
Obbligatorio |
sensori (get sensors)
Questa API restituisce un elenco di oggetti sensore per sensori di rete OT connessi.
URI: /external/v3/integration/sensors/
OTTIENI
URI: /sensors
Nessun parametro di query
devicecves (Get device CVEs)
Questa API restituisce un elenco di CVE attivi per tutti i dispositivi aggiornati dopo il timestamp fornito.
URI: /external/v3/integration/devicecves/
OTTIENI
URI: /external/v3/integration/devicecves/<timestamp>
Parametri URI
Nome | Descrizione | Esempio | Obbligatorio/Facoltativo |
---|---|---|---|
timestamp | Ora di inizio da cui vengono restituiti i risultati, in millisecondi da periodo di tempo e in fuso orario UTC. | /external/v3/integration/devicecves/1664781014000 |
Obbligatorio |
Parametri di query
Nome | Descrizione | Esempio | Obbligatorio/Facoltativo |
---|---|---|---|
pagina | Definisce il numero in cui inizia la numerazione della pagina dei risultati. |
0 = la prima pagina è 0. Valore predefinito = 0 |
Opzionale |
dimensioni | Definisce il ridimensionamento della pagina. | Valore predefinito = 50 |
Opzionale |
sensorId | Mostra i risultati di un sensore specifico, come definito dall'ID sensore specificato. | 1 |
Opzionale |
punteggio | Determina un punteggio CVE minimo da recuperare. Tutti i risultati avranno un punteggio CVE uguale o maggiore del valore specificato. | Valore predefinito = 0 . |
Opzionale |
deviceIds | Elenco delimitato da virgole di ID dispositivo da cui visualizzare i risultati. | Ad esempio: 1232,34,2,456 |
Opzionale |
Passaggi successivi
Per altre informazioni, vedere: