Compartilhar via

API do computador de offboard

  • Artigo

Aplica-se a:

Deseja experimentar o 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

Dispositivo offboard do Defender para Ponto de Extremidade.

Limitações

  • 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.

Observação

  • Essa API tem suporte em Windows 11, Windows 10, versão 1703 e posterior; no Windows Server 2019 e posterior; e em Windows Server 2012 R2 e Windows Server 2016 ao usar o novo agente unificado para Defender para Ponto de Extremidade.
  • Essa API não tem suporte em dispositivos macOS ou Linux.
  • A execução da API de offboarding só impede a execução do serviço de sensor, mas não remove as informações de integração do registro como um script de offboarding faz.

Permissões

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

Tipo de permissão Permissão Nome da exibição de permissão
Application Machine.Offboard 'Máquina offboard'
Delegado (conta corporativa ou de estudante) Machine.Offboard 'Máquina offboard'

Observação

Ao obter um token usando credenciais de usuário:

  • O usuário precisa da função 'Global Administração' do AD
  • 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}/offboard

A ID do computador pode ser encontrada na URL quando você seleciona o dispositivo. Geralmente, é um número alfanumérico de 40 dígitos que pode ser encontrado na URL.

Cabeçalhos de solicitação

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

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.

Resposta

Se for bem-sucedido, esse método retornará 200 – Código de resposta criado e Machine Action no corpo da resposta.

Exemplo

Solicitação

Aqui está um exemplo da solicitação. Se não houver nenhum comentário JSON adicionado, ele errou com o código 400.

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

{
  "Comment": "Offboard machine by automation"
}

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.