Referência da API de integração para consoles de gerenciamento locais (visualização pública)
Este artigo lista as APIs suportadas para integrar o Microsoft Defender for IoT com serviços de parceiros.
Por exemplo, essa API é atualmente implementada com Tutorial: Integrar o ServiceNow ao Microsoft Defender para IoT, por meio do ServiceNow Service Graph Connector for Defender for IoT.
Observação
As APIs de integração destinam-se a ser executadas continuamente e a 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 sem integração, em vez disso, para um console de gerenciamento local para consultar todos os dispositivos ou para um sensor específico para consultar dispositivos somente desse sensor. Para obter mais informações, consulte Defender for IoT API reference.
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:
OBTER
Parâmetros de consulta:
Designação | Descrição | Exemplo | Obrigatório / Opcional |
---|---|---|---|
sensorId | Devolver apenas dispositivos vistos por um sensor específico. Use o valor de ID dos resultados dos sensores de (Obter sensores) API. | 1 |
Opcional |
notificaçãoTipo | Determina os tipos de dispositivos a serem retornados. Os valores suportados incluem: - 0 : Dispositivos novos e atualizados (padrão). - 1 : Apenas novos dispositivos. - 2 : Apenas dispositivos atualizados. |
2 |
Opcional |
página | Define o número onde a numeração da página de resultados começa. Por exemplo, 0 = 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:
OBTER
Parâmetros de consulta:
Designação | Descrição | Exemplo | Obrigatório / Opcional |
---|---|---|---|
página | Define o número onde a numeração da página de resultados começa. Por exemplo, 0 = 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 um determinado ID de dispositivo.
URI: /external/v3/integration/device/{deviceId}
OBTER
Parâmetros de consulta:
Designação | 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:
sensores (Obter sensores)
Esta API retorna uma lista de objetos de sensor para sensores de rede OT conectados.
URI: /external/v3/integration/sensors/
OBTER
URI: /sensors
Sem parâmetros de consulta
devicecves (Obter CVEs de dispositivos)
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
Parâmetros de consulta
Designação | Descrição | Exemplo | Obrigatório / Opcional |
---|---|---|---|
página | Define o número onde a numeração da página de resultados começa. |
0 = 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 pelo ID do sensor fornecido. | 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 superior ao valor dado. | Padrão = 0 . |
Opcional |
deviceIds | Uma lista separada por vírgulas de IDs de dispositivo a partir dos quais você deseja mostrar resultados. | Por exemplo: 1232,34,2,456 |
Opcional |
Próximos passos
Para mais informações, consulte:
- Visão geral da referência da API do Defender for IoT
- Tutorial: Integrar o ServiceNow ao Microsoft Defender para IoT