Listar API de Investigações

Artigo
08/14/2024

Aplica-se a:

Quer experimentar o Microsoft Defender para Ponto Final? Inscrever-se para uma avaliação gratuita.

Nota

Se for um cliente do Us Government, utilize os URIs listados no Microsoft Defender para Endpoint para clientes do Us Government.

Sugestão

Para um melhor desempenho, pode utilizar 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
ina.api.security.microsoft.com

Descrição da API

Obtém uma coleção de Investigações.

Suporta consultas OData V4.

A consulta do $filter OData é suportada em: startTime, id, state, machineIde triggeringAlertId propriedades.
$stop com o valor máximo de 10 000
$skip

Veja exemplos em Consultas OData com o Microsoft Defender para Endpoint

Limitações

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

Permissões

É necessária uma das seguintes permissões para chamar esta API. Para saber mais, incluindo como escolher permissões, consulte Utilizar as APIs do Microsoft Defender para Endpoint.

Tipo de permissão	Permissão	Nome a apresentar da permissão
Aplicação	Alert.Read.All	`Read all alerts`
Aplicação	Alert.ReadWrite.All	`Read and write all alerts`
Delegado (conta escolar ou profissional)	Alert.Read	`Read alerts`
Delegado (conta escolar ou profissional)	Alert.ReadWrite	`Read and write alerts`

Nota

Ao obter um token com credenciais de utilizador:

O utilizador tem de ter, pelo menos, a seguinte permissão de função: View Data. Para obter mais informações, consulte Criar e gerir funções para obter mais informações.

Pedido HTTP

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

Cabeçalhos de pedido

Name	Tipo	Descrição
Autorização	Cadeia	Portador {token}. Obrigatório.

Corpo do pedido

Vazio

Resposta

Se for bem-sucedido, este método devolve 200 código de resposta OK com uma coleção de entidades de Investigações .

Exemplos:

Exemplo de pedido

Eis um exemplo de um pedido para obter todas as investigações:

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

Exemplo de resposta

Eis 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"
        }
        ...
    ]
}