Api til listeundersøgelser

API-beskrivelse

Henter en samling af undersøgelser.

Understøtter OData V4-forespørgsler. OData-understøttede operatorer:

  • $filter på følgende egenskaber:
    • startTime
    • id
    • state
    • machineId
    • triggeringAlertId
  • $stop med en maksimumværdi på 10.000.
  • $skip

Se eksempler på OData-forespørgsler med Microsoft Defender for Endpoint

Begrænsninger

  • Den maksimale sidestørrelse er 10.000.
  • Hastighedsbegrænsninger for denne API er 100 opkald pr. minut og 1.500 opkald pr. time.

Tilladelser

Når du henter et token ved hjælp af brugerlegitimationsoplysninger:

  • Brugeren skal som minimum have følgende rolletilladelse: View Data. Du kan få flere oplysninger under: Opret og administrer roller.

En af følgende tilladelser er påkrævet for at kalde denne API. Hvis du vil vide mere, herunder hvordan du vælger tilladelser, skal du se Brug Microsoft Defender for Endpoint API'er.

Tilladelsestype Tilladelse Vist navn for tilladelse
Program Alert.ReadWrite.All Read and write all alerts
Uddelegeret (arbejds- eller skolekonto) Alert.ReadWrite Read and write alerts

HTTP-anmodning

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

Anmodningsheadere

Navn Type Beskrivelse
Tilladelse String Ihændehaver {token}. Påkrævet.

Brødtekst i anmodning

Tom

Svar

Hvis det lykkes, returnerer denne metode 200, Ok-svarkode med en samling af enheder af typen Investigations.

Eksempel

Eksempel på anmodning

Her er et eksempel på en anmodning om at få alle undersøgelser:

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

Svareksempel

Her er et eksempel på svaret:

{
    "@odata.context": "https://api.security.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"
        }
        ...
    ]
}