Referência da API do Defender para IoT

  • Artigo

Esta seção descreve as APIs públicas compatíveis com Microsoft Defender para IoT. As APIs do Defender for IoT são regidas pela Licença e Termos de Uso da API da Microsoft.

Use as APIs do Defender para IoT para acessar os dados descobertos por sensores e consoles de gerenciamento locais e realizar ações com esses dados.

As conexões de API são protegidas por SSL.

Gerar um token de acesso à API

Muitas APIs do Defender para IoT exigem um token de acesso. Tokens de acesso não são necessários para APIs de autenticação.

Para gerar um token:

  1. Na janela Configurações do sistema, selecione integrações>Tokens de acesso.

  2. Selecione Gerar token.

  3. Em Descrição, explique a que se destina o novo token e selecione Gerar.

  4. O token de acesso aparece. Copie-o, pois ele não será exibido novamente.

  5. Selecione Concluir.

    • Os tokens que você cria aparecem na caixa de diálogo Tokens de Acesso. O campo Usado indica a última vez em que uma chamada externa foi recebida com esse token.

    • O valor N/A no campo Usado indica que a conexão entre o sensor e o servidor conectado não está funcionando.

Depois de gerar o token, adicione um cabeçalho HTTP intitulado Autorização à sua solicitação e defina o valor como o token que você gerou.

Referência de versão da API do sensor

Versão APIs com suporte
Nenhuma versão Autenticação e gerenciamento de senhas:
- set_password (Alterar sua senha)
- set_password_by_admin (Atualizar uma senha de usuário por administrador)
- validation (Validar credenciais do usuário)
Novo na versão 1 Inventário:
- connections (Recuperar informações de conexão do dispositivo)
- cves (Recuperar informações sobre CVEs)
- devices (Recuperar informações do dispositivo)

Alertas:
- alerts (Recuperar informações de alerta)
- events (Recuperar eventos da linha do tempo)

Vulnerabilidades:
- operational (Recuperar vulnerabilidades operacionais)
- devices (Recuperar informações de vulnerabilidade do dispositivo)
- mitigation (Recuperar etapas de mitigação)
- security (Recuperar vulnerabilidades de segurança)
Novo na versão 2 Alertas:
– Atualizações a alerts (Recuperar informações de alerta)

Referência de versão da API do console de gerenciamento local

Versão APIs
Nenhuma versão Autenticação e gerenciamento de senhas:
- set_password (Alterar senha)
- set_password_by_admin (atualização de senha do usuário pelo administrador do sistema)
- validation (Autenticar credenciais de usuário)
Novo na versão 1 Sites
- appliances (Gerenciar dispositivos de sensor de OT)
Inventário:
- devices (Recuperar todas as informações do dispositivo)

Alertas:
- alerts (Recuperar informações de alerta)
- maintenanceWindow (Criar exclusões de alerta)
Novo na versão 2 Alertas:
– Atualizações a alerts (Recuperar informações de alerta)
- pcap (PCAP de alerta de solicitação)
Novo na versão 3 APIs de integração:
- connections (Obter conexões de dispositivo)
- device (Obter detalhes de um dispositivo)
- devicecves (Obter CVEs de dispositivo)
- devices (Criar e atualizar dispositivos)
- deleteddevices (Obter dispositivos excluídos)
- sensors (Obter sensores)

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.

Hora da época

Em todos os valores de carimbo de data/hora do Defender para IoT, a Hora da época é igual a 1/1/1970.

Próximas etapas

Para obter mais informações, consulte: