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 integrar o Microsoft Defender para IoT aos serviços de parceiros.
Por exemplo, essa API está atualmente implementada com Tutorial: Integrar o ServiceNow ao Microsoft Defender para IoT, por meio do ServiceNow Service Graph Connector for Defender para IoT.
Nota
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 e não integrais para um console de gerenciamento local consultar todos os dispositivos ou para um sensor específico consultar dispositivos somente desse sensor. Para obter mais informações, consulte referência da API do Defender para IoT.
URI: /external/v3/integration/
dispositivos (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 |
---|---|---|---|
de carimbo de data/hora | A hora de início da qual os resultados são retornados, em milissegundos de tempo de época e no fuso horário UTC. | /external/v3/integration/devices/1664781014000 |
Necessário |
OBTER
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 dos sensores de (Obter sensores) API. | 1 |
Opcional |
notificationType | Determina os tipos de dispositivos a serem retornados. Os valores com suporte incluem: - 0 : dispositivos atualizados e novos (padrão). - 1 : somente novos dispositivos. - 2 : somente dispositivos atualizados. |
2 |
Opcional |
página | Define o número em que a numeração da página de resultado começa. Por exemplo, 0 = a primeira página é 0. Padrão = 0 |
0 |
Opcional |
tamanho | Define o dimensionamento da página. Padrão = 50 |
75 |
Opcional |
conexões (Obter conexões de dispositivo)
Essa API retorna dados sobre todas as conexões de dispositivo que foram atualizadas 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 |
---|---|---|---|
de carimbo de data/hora | A hora de início da qual os resultados são retornados, em milissegundos de tempo de época e no fuso horário UTC. | /external/v3/integration/devices/1664781014000 |
Necessário |
OBTER
parâmetros de consulta:
Nome | Descrição | Exemplo | Obrigatório/opcional |
---|---|---|---|
página | Define o número em que a numeração da página de resultado começa. Por exemplo, 0 = a primeira página é 0. Padrão = 0 |
0 |
Opcional |
tamanho | Define o dimensionamento da página. Padrão = 50 |
75 |
Opcional |
dispositivo (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}
OBTER
parâmetros de consulta:
Nome | Descrição | Exemplo | Obrigatório/opcional |
---|---|---|---|
deviceId | A ID do dispositivo solicitado no console de gerenciamento local | 1 |
Necessário |
deleteddevices (Obter dispositivos excluídos)
Essa API retorna uma lista de IDs de dispositivos excluídos recentemente do carimbo de data/hora fornecido.
URI: /external/v3/integration/deleteddevices/
OBTER
parâmetros de URI:
Nome | Descrição | Exemplo | Obrigatório/opcional |
---|---|---|---|
de carimbo de data/hora | A hora de início da qual os resultados são retornados, em milissegundos de tempo de época e no fuso horário UTC. | /external/v3/integration/deleteddevices/1664781014000 |
Necessário |
sensores (Obter sensores)
Essa API retorna uma lista de objetos de sensor para sensores de rede OT conectados.
URI: /external/v3/integration/sensors/
OBTER
devicecves (Obter CVEs do dispositivo)
Essa API retorna uma lista de CVEs ativos para todos os dispositivos que foram atualizados desde o carimbo de data/hora fornecido.
URI: /external/v3/integration/devicecves/
OBTER
URI: /external/v3/integration/devicecves/<timestamp>
Parâmetros de URI
Nome | Descrição | Exemplo | Obrigatório/opcional |
---|---|---|---|
de carimbo de data/hora | A hora de início da qual os resultados são retornados, em milissegundos de tempo de é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 em que a numeração da página de resultado começa. |
0 = a primeira página é 0. Padrão = 0 |
Opcional |
tamanho | 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 |
pontuação | Determina uma pontuação CVE mínima a ser recuperada. Todos os resultados terão uma pontuação CVE igual ou maior que o valor fornecido. | Default = 0 . |
Opcional |
deviceIds | Uma lista separada por vírgulas de IDs de dispositivo das quais você deseja mostrar resultados. | Por exemplo: 1232,34,2,456 |
Opcional |
Próximas etapas
Para obter mais informações, consulte:
- visão geral da referência da API do Defender para IoT
- Tutorial : Integrar o ServiceNow ao Microsoft Defender para IoT