API de busca avançada de ameaças

  • Artigo

Aplica-se a:

  • .. /microsoft-defender-endpoint.md

Aviso

Essa API de caça avançada é uma versão mais antiga com recursos limitados. Uma versão mais abrangente da API de caça avançada que pode consultar mais tabelas já está disponível na API de segurança do Microsoft Graph. Consulte Caça avançada usando a API de segurança do Microsoft Graph

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:

  • api-us.securitycenter.microsoft.com
  • api-eu.securitycenter.microsoft.com
  • api-uk.securitycenter.microsoft.com
  • api-au.securitycenter.microsoft.com

Limitações

  1. Você só pode executar uma consulta em dados dos últimos 30 dias.

  2. Os resultados incluem um máximo de 100.000 linhas.

  3. O número de execuções é limitado por locatário:

    • Chamadas de API: até 45 chamadas por minuto e até 1.500 chamadas por hora.
    • Tempo de execução: 10 minutos de tempo de execução a cada hora e 3 horas de tempo de execução por dia.

  4. O tempo máximo de execução de uma única solicitação é de 200 segundos.

  5. 429 A resposta representa atingir o limite de cota por número de solicitações ou por CPU. Leia o corpo da resposta para entender qual limite foi atingido.

  6. O tamanho máximo do resultado da consulta de uma única solicitação não pode exceder 124 MB. Se for excedida, uma Solicitação Inválida HTTP 400 com a mensagem "A execução de consulta excedeu o tamanho do resultado permitido. Otimize sua consulta limitando o número de resultados e tente novamente" ocorre.

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 AdvancedQuery.Read.All Run advanced queries
Delegado (conta corporativa ou de estudante) AdvancedQuery.Read Run advanced queries

Observação

Ao obter um token usando credenciais de usuário:

  • O usuário precisa ter a View Data função atribuída no Microsoft Entra ID
  • 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.securitycenter.microsoft.com/api/advancedqueries/run

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório.
Content-Type 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
Consultar Texto A consulta a ser executada. Obrigatório.

Resposta

Se for bem-sucedido, esse método retornará 200 OK e o objeto QueryResponse no corpo da resposta.

Exemplo

Exemplo de solicitação

Aqui está um exemplo da solicitação.

POST https://api.securitycenter.microsoft.com/api/advancedqueries/run

{
    "Query":"DeviceProcessEvents
|where InitiatingProcessFileName =~ 'powershell.exe'
|where ProcessCommandLine contains 'appdata'
|project Timestamp, FileName, InitiatingProcessFileName, DeviceId
|limit 2"
}

Exemplo de resposta

Veja um exemplo de resposta.

Observação

O objeto de resposta mostrado aqui pode ser truncado para brevidade. Todas as propriedades serão retornadas de uma chamada real.

{
    "Schema": [
        {
            "Name": "Timestamp",
            "Type": "DateTime"
        },
        {
            "Name": "FileName",
            "Type": "String"
        },
        {
            "Name": "InitiatingProcessFileName",
            "Type": "String"
        },
        {
            "Name": "DeviceId",
            "Type": "String"
        }
    ],
    "Results": [
        {
            "Timestamp": "2020-02-05T01:10:26.2648757Z",
            "FileName": "csc.exe",
            "InitiatingProcessFileName": "powershell.exe",
            "DeviceId": "10cbf9182d4e95660362f65cfa67c7731f62fdb3"
        },
        {
            "Timestamp": "2020-02-05T01:10:26.5614772Z",
            "FileName": "csc.exe",
            "InitiatingProcessFileName": "powershell.exe",
            "DeviceId": "10cbf9182d4e95660362f65cfa67c7731f62fdb3"
        }
    ]
}

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.