Defender for Cloud Apps REST API

Artikel ini menjelaskan cara berinteraksi dengan Defender for Cloud Apps melalui HTTPS.

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

• Mengunggah file log untuk penemuan cloud
• Membuat skrip blok
• Mencantumkan aktivitas dan pemberitahuan
• Menutup atau mengatasi pemberitahuan

Struktur URL API

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

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

1. Di Portal Microsoft Defender, pilih Pengaturan. Lalu pilih Cloud Apps. Di bawah Sistem, pilih Tentang.

2. Di layar Defender for Cloud Apps 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 for 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:

Resource	Kata kerja HTTP	Rute URI
Activities	GET atau POST	/api/v1/activities/
Alerts	GET atau POST	/api/v1/alerts/
Pengayaan Data	GET, POST, atau DELETE	/api/subnet/
Entitas	GET atau POST	/api/v1/entities/
Files	GET atau POST	/api/v1/files/

Di mana Sumber Daya mewakili sekelompok entitas terkait.

Jenis bidang apa yang didukung?

Tabel berikut ini menjelaskan jenis bidang yang didukung:

Ladang	Deskripsi
string	String tekstual
Boolean	Nilai boolean yang mewakili true/false
integer	Bilangan bulat dengan penanda 32-bit
stempel waktu	Milidetik sejak zaman

Tanda waktu

Penyebutan tanda waktu dalam API Defender for Cloud Apps 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.

Limits

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)

Note

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

Operators

Note

Tidak semua operator kompatibel dengan semua filter.

Tabel berikut ini menjelaskan operator yang didukung:

Operator	Jenis respons	Deskripsi
mengandung	daftar teks	Mengembalikan semua rekaman yang relevan yang berisi salah satu string yang disediakan
deq	daftar nilai	Mengembalikan semua rekaman yang berisi satu nilai yang tidak sama dengan satu nilai yang disediakan
descendantof	daftar nilai	Mengembalikan semua nilai pencocokan rekaman yang relevan atau turunannya
tidak mulaidenga	daftar teks	Mengembalikan semua rekaman yang relevan yang tidak dimulai dengan setiap string yang disediakan
mengakhiri dengan	daftar teks	Mengembalikan semua rekaman yang relevan yang diakhir dengan salah satu string yang disediakan
eq	daftar nilai	Mengembalikan semua rekaman yang relevan yang berisi salah satu nilai yang disediakan
gt	nilai tunggal	Mengembalikan semua rekaman yang nilainya lebih besar dari nilai yang disediakan
Gte	nilai tunggal	Mengembalikan semua rekaman yang nilainya lebih besar dari atau sama dengan nilai yang disediakan
gte_ndays	number	Mengembalikan semua rekaman dengan tanggal lebih lambat dari N hari yang lalu
isnotset	Boolean	Saat diatur ke "true", mengembalikan semua rekaman relevan yang tidak memiliki nilai di bidang yang ditentukan
isset	Boolean	Saat diatur ke "true", mengembalikan semua rekaman relevan yang memiliki nilai di bidang yang ditentukan
Lt	nilai tunggal	Mengembalikan semua rekaman yang nilainya lebih kecil dari nilai yang disediakan
lte	nilai tunggal	Mengembalikan semua rekaman yang nilainya kurang dari atau sama dengan nilai yang disediakan
lte_ndays	number	Mengembalikan semua rekaman dengan tanggal lebih awal dari N hari yang lalu
nkontains	daftar teks	Mengembalikan semua rekaman yang relevan yang tidak berisi salah satu string yang disediakan
ndescendantof	daftar nilai	Mengembalikan semua rekaman yang relevan yang tidak cocok dengan nilai atau turunannya
neq	daftar nilai	Mengembalikan semua rekaman yang relevan yang tidak berisi semua nilai yang disediakan
rentang	daftar objek yang berisi bidang "start" dan "end"	Mengembalikan semua rekaman dalam salah satu rentang yang disediakan
mulai dengan	daftar teks	Mengembalikan semua rekaman yang relevan yang dimulai dengan salah satu string yang disediakan
startswithsingle	string	Mengembalikan semua rekaman yang relevan yang dimulai dengan string yang disediakan
kirim pesan teks	string	Melakukan pencarian teks lengkap dari semua rekaman

Langkah berikutnya

Autentikasi API

Jika Anda mengalami masalah, kami di sini untuk membantu. Untuk mendapatkan bantuan atau dukungan untuk masalah produk Anda, buka tiket dukungan.