REST API för Defender för molnet-appar

Artikel
01/23/2024

Den här artikeln beskriver hur du interagerar med Defender för molnet-appar via HTTPS.

API:et Microsoft Defender för molnet Apps ger programmatisk åtkomst till Defender för molnet-appar via REST API-slutpunkter. Program kan använda API:et för att utföra läs- och uppdateringsåtgärder på Defender för molnet Apps-data och -objekt. API:et Defender för molnet Apps stöder till exempel följande vanliga åtgärder för ett användarobjekt:

Ladda upp loggfiler för Cloud Discovery
Generera blockskript
Visa en lista över aktiviteter och aviseringar
Stänga eller lösa aviseringar

API-URL-struktur

Om du vill använda API:et Defender för molnet Apps måste du först hämta API-URL:en från din klientorganisation. API-URL:en använder följande format: https://<portal_url>/api/<endpoint>.

Utför följande steg för att hämta API:en för Defender för molnet Apps för din klientorganisation:

I Microsoft Defender-portalen väljer du Inställningar. Välj sedan Cloud Apps. Under System väljer du Om.
På skärmen Defender för molnet Appar om kan du se API-URL:en.

När du har API-URL:en lägger du till suffixet /api i den för att hämta DIN API-URL. Om portalens URL till exempel är https://mytenant.us2.contoso.comär https://mytenant.us2.portal.cloudappsecurity.com/apiAPI-URL:en .

API-token

Defender för molnet Apps kräver en API-token i rubriken för alla API-begäranden till servern, till exempel följande:

Authorization: Token <your_token_key>

Var <your_token_key> finns din personliga API-token.

Mer information om API-token finns i Hantera API-token.

API-token – exempel

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint"

Vilka åtgärder stöds?

I följande tabell beskrivs de åtgärder som stöds:

Resurs	HTTP-verb	URI-vägar
Aktiviteter	GET eller POST	/api/v1/activities/
Aviseringar	GET eller POST	/api/v1/alerts/
Databerikning	GET, POST eller DELETE	/api/undernät/
Entiteter	GET eller POST	/api/v1/entiteter/
Files	GET eller POST	/api/v1/files/

Där Resurs representerar en grupp med relaterade entiteter.

Vilka fälttyper stöds?

I följande tabell beskrivs de fälttyper som stöds:

Fält	beskrivning
sträng	En textsträng
boolean	Ett booleskt värde som representerar sant/falskt
integer	32-bitars signerat heltal
timestamp	Millisekunder sedan epoken

Tidsstämplar

Omnämnanden av tidsstämplar i API:et Defender för molnet Apps refererar till Unix-tidsstämpeln i millisekunder. Tidsstämpeln bestäms av antalet millisekunder sedan 1970-01-01 0:00:00. Du kan använda PowerShell-cmdleten get-date för att konvertera datum till tidsstämplar.

Gränser

Du kan välja att begränsa dina begäranden genom att ange en gränsparameter i begäran.

Följande metoder stöds för att tillhandahålla gränsparametern:

URL-kodad (med Content-Type: application/x-www-form-urlencoded sidhuvud)
Formulärdata
JSON-brödtext (med Content-Type: multipart/form-data och ett lämpligt gränshuvud)

Kommentar

Om ingen gräns anges anges standardvärdet 100.
Svar för alla begäranden som görs med API-token är begränsade till högst 100 objekt.
Begränsningsgränsen för alla API-begäranden är 30 begäranden per minut per klientorganisation.

Filter

När du har ett stort antal resultat är det bra att finjustera begäranden med hjälp av filter. I det här avsnittet beskrivs strukturen för filter och operatorer som kan användas med.

Struktur

Vissa av våra API-slutpunkter stöder filter när du utför frågor. I relevanta avsnitt hittar du en referens som visar alla tillgängliga filterbara fält och operatorer som stöds för den resursen.

De flesta filter stöder flera värden för att ge dig kraftfulla frågor. När vi kombinerar filter och operatorer använder vi AND som logisk operator mellan filtren.

Filter – exempel

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint" -d '{
  "filters": {
    "some.field": {
      "eq": ["value1", "value2"],
      "isset": true
    },
    "some.field2": {
      "gte": 5
    }
  },
  "skip": 5,
  "limit": 10
}'

Operatorer