Compartilhar via

Executar API de verificação antivírus

  • Artigo

Aplica-se a:

Deseja experimentar o Microsoft Defender para Ponto de Extremidade? Inscreva-se para uma avaliação gratuita.

Observação

Se você for um cliente do governo dos EUA, use as URIs listadas em Microsoft Defender para Ponto de Extremidade para clientes do governo dos EUA.

Dica

Para obter um melhor desempenho, você pode usar o servidor mais próximo da localização geográfica:

  • us.api.security.microsoft.com
  • eu.api.security.microsoft.com
  • uk.api.security.microsoft.com
  • au.api.security.microsoft.com
  • swa.api.security.microsoft.com

Descrição da API

Inicie Microsoft Defender verificação antivírus em um dispositivo.

Limitações

  1. As limitações de taxa para essa API são 100 chamadas por minuto e 1500 chamadas por hora.

Observação

Esta página se concentra na execução de uma ação do computador por meio da API. Consulte tomar ações de resposta em um computador para obter mais informações sobre a funcionalidade de ações de resposta por meio de Microsoft Defender para Ponto de Extremidade.

Importante

  • Essa ação está disponível para dispositivos no Windows 10, versão 1709 ou posterior e em Windows 11.
  • Uma verificação antivírus Microsoft Defender pode ser executada junto com outras soluções antivírus, Microsoft Defender Antivírus é ou não a solução antivírus ativa. Microsoft Defender Antivírus pode estar no modo Passivo. Para obter mais informações, consulte Microsoft Defender compatibilidade com Antivírus.

Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, consulte Usar APIs de Microsoft Defender para Ponto de Extremidade

Tipo de permissão Permissão Nome da exibição de permissão
Application Machine.Scan 'Computador de verificação'
Delegado (conta corporativa ou de estudante) Machine.Scan 'Computador de verificação'

Observação

Ao obter um token usando credenciais de usuário:

  • O usuário precisa ter pelo menos a seguinte permissão de função: 'Ações de correção ativa' (Consulte Create e gerencie funções para obter mais informações)
  • O usuário precisa ter acesso ao dispositivo, com base nas configurações do grupo de dispositivos (Consulte Create e gerencie grupos de dispositivos para obter mais informações)

Há suporte para a criação do grupo de dispositivos no Plano 1 e no Plano 2 do Defender para Ponto de Extremidade.

Solicitação HTTP

POST https://api.security.microsoft.com/api/machines/{id}/runAntiVirusScan

Cabeçalhos de solicitação

Nome Tipo Descrição
Autorização Cadeia de caracteres {token} de portador. Obrigatório.
Content-Type string application/json

Corpo da solicitação

No corpo da solicitação, forneça um objeto JSON com os seguintes parâmetros:

Parâmetro Tipo Descrição
Comentário String Comente para associar à ação. Obrigatório.
ScanType Cadeia de caracteres Define o tipo da Verificação. Obrigatório.

O ScanType controla o tipo de verificação a ser executada e pode ser um dos seguintes:

  • Rápido: executar uma verificação rápida no dispositivo
  • Completo: executar a verificação completa no dispositivo

Resposta

Se for bem-sucedido, esse método retornará 201, código de resposta criado e objeto MachineAction no corpo da resposta.

Se você enviar várias chamadas de API para executar uma verificação antivírus para o mesmo dispositivo, ele retornará "ação do computador pendente" ou HTTP 400 com a mensagem "A ação já está em andamento".

Exemplo

Solicitação

Este é um exemplo da solicitação.

POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan 

{
  "Comment": "Check machine for viruses due to alert 3212",
  "ScanType": "Full"
}

Dica

Você deseja aprender mais? Engage com a comunidade de Segurança da Microsoft em nossa Comunidade Tecnológica: Microsoft Defender para Ponto de Extremidade Tech Community.