Del via

API for offboard-maskin

  • Artikkel

Gjelder for:

Vil du oppleve Defender for endepunkt? Registrer deg for en gratis prøveperiode.

Obs!

Hvis du er us Government-kunde, kan du bruke URI-ene som er oppført i Microsoft Defender for endepunkt for US Government-kunder.

Tips

Hvis du vil ha bedre ytelse, kan du bruke serveren nærmere geografisk plassering:

  • 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

API-beskrivelse

Offboard-enhet fra Defender for Endpoint.

Begrensninger

  • Satsbegrensninger for denne API-en er 100 oppkall per minutt og 1500 anrop per time.

    Obs!

    Denne siden fokuserer på å utføre en maskinhandling via API. Se utføre responshandlinger på en maskin for mer informasjon om responshandlingsfunksjonalitet via Microsoft Defender for endepunkt.

Obs!

  • Denne API-en støttes på Windows 11, Windows 10, versjon 1703 og nyere, på Windows Server 2019 og nyere, og på Windows Server 2012 R2 og Windows Server 2016 når du bruker den nye enhetlige agenten for Defender for Endpoint.
  • Denne API-en støttes ikke på macOS- eller Linux-enheter.
  • Hvis du kjører avlastings-API-en, stopper bare sensortjenesten fra å kjøre, men den fjerner ikke pålastingsinformasjonen fra registeret som et offboarding-skript gjør.

Tillatelser

Én av følgende tillatelser er nødvendig for å kalle opp denne API-en. Hvis du vil ha mer informasjon, inkludert hvordan du velger tillatelser, kan du se Bruke Defender for endepunkt-API-er

Tillatelsestype Tillatelse Visningsnavn for tillatelse
Program Machine.Offboard 'Offboard machine'
Delegert (jobb- eller skolekonto) Machine.Offboard 'Offboard machine'

Obs!

Når du skaffer et token ved hjelp av brukerlegitimasjon:

Oppretting av enhetsgruppe støttes i Defender for Endpoint Plan 1 og Plan 2.

HTTP-forespørsel

POST https://api.security.microsoft.com/api/machines/{id}/offboard

Du finner maskin-ID-en i nettadressen når du velger enheten. Vanligvis er det et 40-sifret alfanumerisk tall som du finner i nettadressen.

Forespørselshoder

Navn Type: Beskrivelse
Authorization Streng Bærer {token}. Obligatorisk.
Innholdstype Streng program/json. Obligatorisk.

Forespørselstekst

Angi et JSON-objekt med følgende parametere i forespørselsteksten:

Parameteren Type: Beskrivelse
Kommentar Streng Kommentar som skal knyttes til handlingen. Obligatorisk.

Svar

Hvis dette lykkes, returnerer denne metoden 200 – opprettet svarkode og maskinhandling i svarteksten.

Eksempel

Forespørsel

Her er et eksempel på forespørselen. Hvis det ikke er lagt til noen JSON-kommentar, vil det feile med kode 400.

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

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

Tips

Vil du lære mer? Engage med Microsoft Security-fellesskapet i teknisk fellesskap: Microsoft Defender for endepunkt teknisk fellesskap.