API for offboard-maskin

Artikkel
11/19/2024

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
ina.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`

Viktig

Microsoft anbefaler at du bruker roller med færrest tillatelser. Dette bidrar til å forbedre sikkerheten for organisasjonen. Global administrator er en svært privilegert rolle som bør begrenses til nødscenarioer når du ikke kan bruke en eksisterende rolle.

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

Brukeren må ha en tilordnet riktig rolle (se tillatelsesalternativer).
Brukeren må ha tilgang til enheten, basert på innstillingene for enhetsgruppen. Hvis du vil ha mer informasjon, kan du se Opprette og administrere enhetsgrupper.

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
Autorisasjon	Streng	Bærer {token}. Obligatorisk.
Innholdstype	streng	program/json. Obligatorisk.

Forespørselstekst

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

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

Svar

Hvis vellykket, returnerer 200 - Created response denne metoden kode og maskinhandling i svarteksten.

Eksempel

Anmodning

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

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

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