Defender for Cloud Apps REST API

Článek
11/28/2024

Tento článek popisuje, jak pracovat s Defender for Cloud Apps přes HTTPS.

Rozhraní API Microsoft Defender for Cloud Apps poskytuje programový přístup k Defender for Cloud Apps prostřednictvím koncových bodů rozhraní REST API. Aplikace můžou rozhraní API používat k provádění operací čtení a aktualizace Defender for Cloud Apps dat a objektů. Rozhraní API Defender for Cloud Apps například podporuje následující běžné operace pro objekt uživatele:

Nahrání souborů protokolu pro cloud discovery
Generování blokových skriptů
Výpis aktivit a výstrah
Zavření nebo řešení výstrah

Struktura adres URL rozhraní API

Pokud chcete použít rozhraní API Defender for Cloud Apps, musíte nejprve získat adresu URL rozhraní API z vašeho tenanta. Adresa URL rozhraní API používá následující formát: https://<portal_url>/api/<endpoint>.

Pokud chcete získat adresu URL Defender for Cloud Apps rozhraní API pro vašeho tenanta, proveďte následující kroky:

Na portálu Microsoft Defender vyberte Nastavení. Pak zvolte Cloud Apps. V části Systém vyberte O systému.
Na obrazovce Defender for Cloud Apps about uvidíte adresu URL rozhraní API.

Jakmile budete mít adresu URL rozhraní API, přidejte k ní příponu /api , abyste získali adresu URL rozhraní API. Pokud je například adresa URL vašeho portálu , pak adresa https://mytenant.us2.contoso.comURL rozhraní API je https://mytenant.us2.portal.cloudappsecurity.com/api.

Tokeny rozhraní API

Defender for Cloud Apps vyžaduje token rozhraní API v hlavičce všech požadavků rozhraní API na server, například následující:

Authorization: Token <your_token_key>

Kde <your_token_key> je váš osobní token rozhraní API.

Další informace o tokenech rozhraní API najdete v tématu Správa tokenů rozhraní API.

Tokeny rozhraní API – příklad

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

Jaké akce se podporují?

Následující tabulka popisuje podporované akce:

Zdroj	Příkazy HTTP	Trasy URI
Činnosti	GET nebo POST	/api/v1/activities/
Upozornění	GET nebo POST	/api/v1/alerts/
Rozšiřování dat	GET, POST nebo DELETE	/api/subnet/
Entity	GET nebo POST	/api/v1/entities/
Soubory	GET nebo POST	/api/v1/files/

Kde Prostředek představuje skupinu souvisejících entit.

Jaké typy polí jsou podporované?

Následující tabulka popisuje podporované typy polí:

:-----	Popis
řetězec	Textový řetězec
booleovský	Logická hodnota představující hodnotu true/false
celé číslo	32bitové celé číslo se signedm
časová značka	Milisekundy od epochy

Časová razítka

Zmínky o časových razítkech v rozhraní API Defender for Cloud Apps odkazují na časové razítko systému Unix v milisekundách. Toto časové razítko je určeno počtem milisekund od 1970-01-01 0:00:00. K převodu dat na časová razítka můžete použít rutinu PowerShellu get-date .

Hranice

Požadavky můžete omezit zadáním parametru limitu v požadavku.

Pro zadání parametru limitu se podporují následující metody:

Zakódovaná adresa URL (se záhlavím Content-Type: application/x-www-form-urlencoded )
Data formuláře
Text JSON (s Content-Type: multipart/form-data příslušnou hlavičkou ohraničení)

Poznámka

Pokud není zadaný žádný limit, nastaví se výchozí hodnota 100.
Odpovědi na všechny požadavky provedené pomocí tokenu rozhraní API jsou omezené na maximálně 100 položek.
Limit omezení pro všechny požadavky rozhraní API je 30 požadavků za minutu na tenanta.

Filtruje

Pokud máte velký počet výsledků, bude užitečné vyladit požadavky pomocí filtrů. Tato část popisuje strukturu a operátory filtrů, které lze použít s filtry.

Struktura

Některé z našich koncových bodů rozhraní API podporují filtry při provádění dotazů. V příslušných oddílech najdete odkaz se seznamem všech dostupných filtrovatelných polí a podporovaných operátorů pro daný prostředek.

Většina filtrů podporuje více hodnot, aby vám poskytovaly výkonné dotazy. Při kombinování filtrů a operátorů používáme operátor AND jako logický operátor mezi filtry.

Filtry – příklad

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
}'

Operátoři

Poznámka

Ne všechny operátory jsou kompatibilní se všemi filtry.

Následující tabulka popisuje podporované operátory:

Operátor	Typ odpovědi	Popis
obsahuje	seznam řetězců	Vrátí všechny relevantní záznamy obsahující jeden ze zadaných řetězců.
deq	seznam hodnot	Vrátí všechny záznamy, které obsahují jednu hodnotu, která se nerovná zadané hodnotě.
potomek	seznam hodnot	Vrátí všechny relevantní záznamy odpovídající hodnotám nebo jejich potomkům.
doesnotstartwith	seznam řetězců	Vrátí všechny relevantní záznamy, které nezačíná každým ze zadaných řetězců.
končí s	seznam řetězců	Vrátí všechny relevantní záznamy končící jedním ze zadaných řetězců.
Eq	seznam hodnot	Vrátí všechny relevantní záznamy obsahující jednu ze zadaných hodnot.
Gt	jedna hodnota	Vrátí všechny záznamy, jejichž hodnota je větší než zadaná hodnota.
Gte	jedna hodnota	Vrátí všechny záznamy, jejichž hodnota je větší nebo rovna zadané hodnotě.
gte_ndays	číslo	Vrátí všechny záznamy s datem pozdějším než před N dny.
isnotset	booleovský	Pokud je nastavená hodnota true, vrátí všechny relevantní záznamy, které nemají v zadaném poli hodnotu.
isset	booleovský	Pokud je nastavená hodnota true, vrátí všechny relevantní záznamy, které mají hodnotu v zadaném poli.
lt	jedna hodnota	Vrátí všechny záznamy, jejichž hodnota je menší než zadaná hodnota.
lte	jedna hodnota	Vrátí všechny záznamy, jejichž hodnota je menší nebo rovna zadané hodnotě.
lte_ndays	číslo	Vrátí všechny záznamy s datem dřívějším než před N dny.
nkontejnery	seznam řetězců	Vrátí všechny relevantní záznamy, které neobsahují jeden ze zadaných řetězců.
ndescendantof	seznam hodnot	Vrátí všechny relevantní záznamy, které neodpovídají hodnotám nebo jejich potomkům.
Neq	seznam hodnot	Vrátí všechny relevantní záznamy, které neobsahují všechny zadané hodnoty.
rozmezí	seznam objektů obsahujících pole "start" a "end"	Vrátí všechny záznamy v jedné ze zadaných oblastí.
začíná s	seznam řetězců	Vrátí všechny relevantní záznamy začínající jedním ze zadaných řetězců.
startswithsingle	řetězec	Vrátí všechny relevantní záznamy začínající zadaným řetězcem.
Text	řetězec	Provede fulltextové vyhledávání všech záznamů.

Další kroky

Ověřování rozhraní API

Pokud narazíte na nějaké problémy, jsme tu, abychom vám pomohli. Pokud chcete získat pomoc nebo podporu pro váš problém s produktem, otevřete lístek podpory.

Sdílet prostřednictvím