Partilhar via


Referência da API do Defender for IoT

Esta seção descreve as APIs públicas suportadas pelo Microsoft Defender for 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 for IoT para acessar dados descobertos por sensores e executar 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 for IoT exigem um token de acesso. Os 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 Integrations>Access Tokens.

  2. Selecione Gerar token.

  3. Em Descrição, descreva para que serve o novo token e selecione Gerar.

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

  5. Selecione Concluir.

    • Os tokens criados aparecem na caixa de diálogo Tokens de acesso . O Usado indica a última vez que uma chamada externa com esse token foi recebida.

    • N/D 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 seu valor para o token que você gerou.

Referência da versão da API do sensor

Versão APIs suportadas
Sem versão Autenticação e gestão de palavras-passe:
- set_password (Altere a sua palavra-passe)
- set_password_by_admin (Atualizar uma senha de usuário pelo administrador)
- validação (Validar credenciais de usuário)
Novo na versão 1 Inventário:
- conexões (Recuperar informações de conexão do dispositivo)
- cves (Recuperar informações sobre CVEs)
- dispositivos (Recuperar informações do dispositivo)

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

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

Nota

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 sensor específico para consultar dispositivos somente desse sensor.

Época

Em todos os valores de carimbo de data/hora do Defender for IoT, o tempo de época é igual a 1/1/1970.

Próximos passos

Para obter mais informações, consulte: