Listar API de Investigações

Artigo
05/03/2024

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

Recupera uma coleção de Investigações.

Dá suporte a consultas OData V4.

A consulta do $filter OData tem suporte em: startTime, , id, state, machineIde triggeringAlertId propriedades.
$stop com valor máximo de 10.000
$skip

Confira exemplos em consultas OData com Microsoft Defender para Ponto de Extremidade

Limitações

O tamanho máximo da página é 10.000.
As limitações de taxa para essa API são 100 chamadas por minuto e 1.500 chamadas por hora.

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	Alert.Read.All	`Read all alerts`
Application	Alert.ReadWrite.All	`Read and write all alerts`
Delegado (conta corporativa ou de estudante)	Alert.Read	`Read alerts`
Delegado (conta corporativa ou de estudante)	Alert.ReadWrite	`Read and write alerts`

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: View Data. Para obter mais informações, consulte Create e gerenciar funções para obter mais informações.

Solicitação HTTP

GET https://api.securitycenter.microsoft.com/api/investigations

Cabeçalhos de solicitação

Nome	Tipo	Descrição
Autorização	Cadeia de caracteres	{token} de portador. Obrigatório.

Corpo da solicitação

Vazio

Resposta

Se for bem-sucedido, esse método retornará 200, código de resposta Ok com uma coleção de entidades investigations .

Exemplo

Exemplo de solicitação

Aqui está um exemplo de uma solicitação para obter todas as investigações:

GET https://api.securitycenter.microsoft.com/api/investigations

Exemplo de resposta

Aqui está um exemplo da resposta:

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Investigations",
    "value": [
        {
            "id": "63017",
            "startTime": "2020-01-06T14:11:34Z",
            "endTime": null,
            "state": "Running",
            "cancelledBy": null,
            "statusDetails": null,
            "machineId": "a69a22debe5f274d8765ea3c368d00762e057b30",
            "computerDnsName": "desktop-gtrcon0",
            "triggeringAlertId": "da637139166940871892_-598649278"
        }
        ...
    ]
}