Compartilhar via


Referência da API de Integração para consoles de gerenciamento locais (versão prévia pública)

Este artigo lista as APIs com suporte para integração do Microsoft Defender para IoT com serviços parceiros.

Por exemplo, essa API está implementada no momento com o Tutorial: Integrar o ServiceNow ao Microsoft Defender para IoT, por meio do ServiceNow Service Graph Connector para Defender para IoT.

Observação

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

Para simplesmente consultar dados, use as APIs regulares não de integração para um console de gerenciamento local consultar todos os dispositivos ou para um sensor específico consultar dispositivos somente desse sensor. Para saber mais, confira Referência da API do Defender para IoT.

URI: /external/v3/integration/

devices (Criar e atualizar dispositivos)

Essa API retorna dados sobre todos os dispositivos que foram atualizados após o carimbo de data/hora fornecido.

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

Parâmetros de URI:

Nome Descrição Exemplo Obrigatório/Opcional
timestamp A hora de início de retorno dos resultados, em milissegundos, a partir da hora Época e no fuso horário UTC. /external/v3/integration/devices/1664781014000 Obrigatório

GET

Parâmetros de consulta:

Nome Descrição Exemplo Obrigatório/Opcional
sensorId Retornar somente dispositivos vistos por um sensor específico. Use o valor da ID dos resultados da API sensors (Obter sensores). 1 Opcional
notificationType Determina os tipos de dispositivos a serem retornados. Os valores compatíveis incluem:
- 0: dispositivos atualizados e novos (padrão).
- 1: somente dispositivos novos.
- 2: somente dispositivos atualizados.
2 Opcional
page Define o número em que a numeração da página de resultados começa. For exemplo, 0= a primeira página é 0.
Padrão = 0
0 Opcional
size Define o dimensionamento da página. Padrão = 50 75 Opcional

connections (Obter conexões de dispositivo)

Essa API retorna dados sobre todas as conexões de dispositivos que foram atualizados após o carimbo de data/hora fornecido.

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

Parâmetros de URI:

Nome Descrição Exemplo Obrigatório/Opcional
timestamp A hora de início de retorno dos resultados, em milissegundos, a partir da hora Época e no fuso horário UTC. /external/v3/integration/devices/1664781014000 Obrigatório

GET

Parâmetros de consulta:

Nome Descrição Exemplo Obrigatório/Opcional
page Define o número em que a numeração da página de resultados começa. For exemplo, 0= a primeira página é 0.
Padrão = 0
0 Opcional
size Define o dimensionamento da página. Padrão = 50 75 Opcional

device (Obter detalhes de um dispositivo)

Essa API retorna dados sobre um dispositivo específico por determinada ID do dispositivo.

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

GET

Parâmetros de consulta:

Nome Descrição Exemplo Obrigatório/Opcional
deviceId A ID do dispositivo solicitado no console de gerenciamento local 1 Obrigatório

deleteddevices (Obter dispositivos excluídos)

Essa API retorna uma lista de IDs de dispositivos excluídos recentemente, com base no carimbo de data/hora fornecido.

URI: /external/v3/integration/deleteddevices/

GET

Parâmetros de URI:

Nome Descrição Exemplo Obrigatório/Opcional
timestamp A hora de início de retorno dos resultados, em milissegundos, a partir da hora Época e no fuso horário UTC. /external/v3/integration/deleteddevices/1664781014000 Obrigatório

sensors (Obter sensores)

Essa API retorna uma lista de objetos de sensor para sensores de rede OT conectados.

URI: /external/v3/integration/sensors/

GET

URI: /sensors

Sem parâmetros de consulta

devicecves (Obter CVEs de dispositivo)

Essa API retorna uma lista de CVEs ativos para todos os dispositivos 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
timestamp A hora de início de retorno dos resultados, em milissegundos, a partir da hora Época e no fuso horário UTC. /external/v3/integration/devicecves/1664781014000 Obrigatório

Parâmetros de consulta

Nome Descrição Exemplo Obrigatório/Opcional
page Define o número em que a numeração da página de resultados começa. 0= a primeira página é 0.
Padrão = 0
Opcional
size Define o dimensionamento da página. Padrão = 50 Opcional
sensorId Mostra os resultados de um sensor específico, conforme definido pela ID do sensor fornecida. 1 Opcional
score Determina uma pontuação de CVE mínima a ser recuperada. Todos os resultados terão uma pontuação de CVE igual ou superior ao valor fornecido. Padrão = 0. Opcional
deviceIds Uma lista separada por vírgulas de IDs de dispositivo cujos resultados você deseja mostrar. Por exemplo: 1232,34,2,456 Opcional

Próximas etapas

Para obter mais informações, consulte: