DEFENDER UNTUK CLOUD Apps REST API

Artikel
01/23/2024

Artikel ini menjelaskan cara berinteraksi dengan aplikasi Defender untuk Cloud melalui HTTPS.

API aplikasi Microsoft Defender untuk Cloud menyediakan akses terprogram ke aplikasi Defender untuk Cloud melalui titik akhir REST API. Aplikasi dapat menggunakan API untuk melakukan operasi baca dan perbarui pada data dan objek Defender untuk Cloud Apps. Misalnya, DEFENDER UNTUK CLOUD Apps API mendukung operasi umum berikut untuk objek pengguna:

Mengunggah file log untuk Cloud Discovery
Membuat skrip blok
Mencantumkan aktivitas dan pemberitahuan
Menutup atau mengatasi pemberitahuan

Struktur URL API

Untuk menggunakan API aplikasi Defender untuk Cloud, Anda harus terlebih dahulu mendapatkan URL API dari penyewa Anda. URL API menggunakan format berikut: https://<portal_url>/api/<endpoint>.

Untuk mendapatkan URL API aplikasi Defender untuk Cloud untuk penyewa Anda, lakukan langkah-langkah berikut:

Di Portal Pertahanan Microsoft, pilih Pengaturan. Lalu pilih Cloud Apps. Di bawah Sistem, pilih Tentang.
Di layar aplikasi Defender untuk Cloud tentang, Anda dapat melihat url API.

Setelah Anda memiliki url API, tambahkan /api akhiran ke dalamnya untuk mendapatkan URL API Anda. Misalnya, jika URL portal Anda adalah https://mytenant.us2.contoso.com, maka URL API Anda adalah https://mytenant.us2.portal.cloudappsecurity.com/api.

Token API

Defender untuk Cloud Apps memerlukan token API di header semua permintaan API ke server, seperti berikut ini:

Authorization: Token <your_token_key>

Di mana <your_token_key> token API pribadi Anda.

Untuk informasi selengkapnya tentang token API, lihat Mengelola token API.

Token API - contoh

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

Tindakan apa yang didukung?

Tabel berikut ini menjelaskan tindakan yang didukung:

Sumber Daya	Kata kerja HTTP	Rute URI
Aktivitas	DAPATKAN ataupun POSTING	/api/v1/activities/
Peringatan	DAPATKAN ataupun POSTING	/api/v1/alerts/
Pengayaan Data	GET, POST, atau DELETE	/api/subnet/
Entitas	DAPATKAN ataupun POSTING	/api/v1/entities/
File	DAPATKAN ataupun POSTING	/api/v1/files/

Di mana Sumber Daya mewakili sekelompok entitas terkait.

Jenis bidang apa yang didukung?

Tabel berikut ini menjelaskan jenis bidang yang didukung:

Bidang	Deskripsi
string	String tekstual
Boolean	Nilai boolean yang mewakili true/false
Integer	Bilangan bulat bertanda 32-bit
rentang waktu	Milidetik sejak zaman

Stempel waktu

Penyebutan tanda waktu di DEFENDER UNTUK CLOUD Apps API mengacu pada tanda waktu Unix dalam milidetik. Tanda waktu ini ditentukan oleh jumlah milidetik sejak 1970-01-01 0:00:00. Anda dapat menggunakan cmdlet PowerShell tanggal dapatkan untuk mengonversi tanggal menjadi tanda waktu.

Batas

Anda dapat memilih untuk membatasi permintaan Anda dengan memberikan parameter batas dalam permintaan.

Metode berikut didukung untuk menyediakan parameter batas:

Dikodekan URL (dengan Content-Type: application/x-www-form-urlencoded header)
Data formulir
Isi JSON (dengan Content-Type: multipart/form-data dan header batas yang sesuai)

Catatan

Jika tidak ada batas yang disediakan, default 100 akan ditetapkan.
Respons untuk semua permintaan yang dibuat dengan token API dibatasi hingga maksimum 100 item.
Batas pembatasan untuk semua permintaan API adalah 30 permintaan per menit per penyewa.

Filter

Ketika Anda memiliki sejumlah besar hasil, Anda akan merasa berguna untuk menyempurnakan permintaan menggunakan filter. Bagian ini menjelaskan struktur, dan operator yang dapat digunakan dengan, filter.

Struktur

Beberapa titik akhir API kami mendukung filter saat melakukan kueri. Di bagian yang relevan, Anda akan menemukan referensi yang mencantumkan semua bidang yang dapat difilter yang tersedia dan operator yang didukung untuk sumber daya tersebut.

Sebagian besar filter mendukung beberapa nilai untuk memberi Anda kueri yang kuat. Saat menggabungkan filter dan operator, kami menggunakan AND sebagai operator logis antara filter.

Filter - contoh

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

Operator