Partilhar via


Referência da API de Integração para consolas de gestão no local (Pré-visualização pública)

Este artigo lista as APIs suportadas para integrar Microsoft Defender para IoT com serviços de parceiros.

Por exemplo, esta API está atualmente implementada com o Tutorial: Integrar o ServiceNow com Microsoft Defender para IoT, através do ServiceNow Service Graph Connector para Defender para IoT.

Nota

As APIs de integração destinam-se a ser executadas continuamente e a criar um fluxo de dados em execução constante, como para consultar novos dados dos últimos cinco minutos. As APIs de integração devolvem dados com um carimbo de data/hora.

Para consultar simplesmente os dados, utilize as APIs normais e não integrais para uma consola de gestão no local para consultar todos os dispositivos ou para um sensor específico consultar dispositivos apenas a partir desse sensor. Para obter mais informações, veja Referência da API do Defender para IoT.

URI: /external/v3/integration/

dispositivos (Criar e atualizar dispositivos)

Esta API devolve dados sobre todos os dispositivos que foram atualizados após o carimbo de data/hora especificado.

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

Parâmetros do URI:

Nome Descrição Exemplo Obrigatório/Opcional
carimbo de data/hora A hora de início a partir da qual os resultados são devolvidos, em milissegundos da hora da época e no fuso horário UTC. /external/v3/integration/devices/1664781014000 Necessário

GET

Parâmetros de consulta:

Nome Descrição Exemplo Obrigatório/Opcional
sensorId Devolver apenas dispositivos vistos por um sensor específico. Utilize o valor de ID dos resultados da API de sensores (Obter sensores ). 1 Opcional
notificationType Determina os tipos de dispositivos a devolver. Os valores suportados incluem:
- 0: dispositivos atualizados e novos (predefinição).
- 1: apenas novos dispositivos.
- 2: apenas dispositivos atualizados.
2 Opcional
página Define o número onde começa a numeração da página de resultados. Por exemplo, 0= a primeira página é 0.
Predefinição = 0
0 Opcional
tamanho Define o dimensionamento da página. Predefinição = 50 75 Opcional

ligações (Obter ligações de dispositivo)

Esta API devolve dados sobre todas as ligações de dispositivo que foram atualizadas após o carimbo de data/hora especificado.

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

Parâmetros do URI:

Nome Descrição Exemplo Obrigatório/Opcional
carimbo de data/hora A hora de início a partir da qual os resultados são devolvidos, em milissegundos da hora da época e no fuso horário UTC. /external/v3/integration/devices/1664781014000 Necessário

GET

Parâmetros de consulta:

Nome Descrição Exemplo Obrigatório/Opcional
página Define o número onde começa a numeração da página de resultados. Por exemplo, 0= a primeira página é 0.
Predefinição = 0
0 Opcional
tamanho Define o dimensionamento da página. Predefinição = 50 75 Opcional

dispositivo (Obter detalhes de um dispositivo)

Esta API devolve dados sobre um dispositivo específico por um determinado ID de dispositivo.

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

GET

Parâmetros de consulta:

Nome Descrição Exemplo Obrigatório/Opcional
deviceId O ID do dispositivo pedido na consola de gestão no local 1 Necessário

dispositivos eliminados (Obter dispositivos eliminados)

Esta API devolve uma lista de IDs de dispositivos eliminados recentemente, a partir do carimbo de data/hora fornecido.

URI: /external/v3/integration/deleteddevices/

GET

Parâmetros URI:

Nome Descrição Exemplo Obrigatório/Opcional
carimbo de data/hora A hora de início a partir da qual os resultados são devolvidos, em milissegundos da hora da época e no fuso horário UTC. /external/v3/integration/deleteddevices/1664781014000 Necessário

sensores (Obter sensores)

Esta API devolve uma lista de objetos de sensor para sensores de rede OT ligados.

URI: /external/v3/integration/sensors/

GET

URI: /sensors

Sem parâmetros de consulta

devicecves (Obter CVEs do dispositivo)

Esta API devolve uma lista de CVEs ativos para todos os dispositivos que foram atualizados desde o carimbo de data/hora fornecido.

URI: /external/v3/integration/devicecves/

GET

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

Parâmetros do URI

Nome Descrição Exemplo Obrigatório/Opcional
carimbo de data/hora A hora de início a partir da qual os resultados são devolvidos, em milissegundos da hora da época e no fuso horário UTC. /external/v3/integration/devicecves/1664781014000 Necessário

Parâmetros de consulta

Nome Descrição Exemplo Obrigatório/Opcional
página Define o número onde começa a numeração da página de resultados. 0= a primeira página é 0.
Predefinição = 0
Opcional
tamanho Define o dimensionamento da página. Predefinição = 50 Opcional
sensorId Mostra os resultados de um sensor específico, conforme definido pelo ID do sensor especificado. 1 Opcional
pontuação Determina uma classificação de CVE mínima a ser obtida. Todos os resultados terão uma classificação CVE igual ou superior ao valor especificado. Predefinição = 0. Opcional
deviceIds Uma lista separada por vírgulas de IDs de dispositivo dos quais pretende mostrar resultados. Por exemplo: 1232,34,2,456 Opcional

Passos seguintes

Para obter mais informações, consulte: