Referensi API Integrasi untuk konsol manajemen lokal (Pratinjau publik)
Artikel ini mencantumkan API yang didukung untuk mengintegrasikan Microsoft Defender untuk IoT dengan layanan mitra.
Misalnya, API ini saat ini diimplementasikan dengan Tutorial: Mengintegrasikan ServiceNow dengan Microsoft Defender untuk IoT, melalui Konektor ServiceNow Service Graph untuk Defender untuk IoT.
Catatan
API integrasi dimaksudkan untuk berjalan terus menerus dan membuat aliran data yang terus berjalan, seperti untuk mengkueri data baru dari lima menit terakhir. API integrasi mengembalikan data dengan tanda waktu.
Untuk hanya mengkueri data, gunakan API reguler non-integrasi sebagai gantinya, untuk konsol manajemen lokal untuk mengkueri semua perangkat, atau untuk sensor tertentu untuk mengkueri perangkat dari sensor tersebut saja. Untuk informasi selengkapnya, lihat Referensi Defender for IoT API.
URI: /external/v3/integration/
perangkat (Membuat dan memperbarui perangkat)
API ini mengembalikan data tentang semua perangkat yang diperbarui setelah stempel waktu yang diberikan.
URI: /external/v3/integration/devices/<timestamp>
Parameter URI:
Nama | Deskripsi | Contoh | Diperlukan/Opsional |
---|---|---|---|
timestamp | Waktu mulai dari mana hasil dikembalikan, dalam milidetik dari waktu Epoch dan dalam zona waktu UTC. | /external/v3/integration/devices/1664781014000 |
Diperlukan |
GET
Parameter kueri:
Nama | Deskripsi | Contoh | Diperlukan/Opsional |
---|---|---|---|
idSensor | Mengembalikan hanya perangkat yang dilihat oleh sensor tertentu. Gunakan nilai ID dari hasil API sensor (Dapatkan sensor ). | 1 |
Opsional |
notificationType | Menentukan jenis perangkat yang akan dikembalikan. Nilai yang didukung mencakup: - 0 : Perangkat yang diperbarui dan baru (default). - 1 : Hanya perangkat baru. - 2 : Hanya perangkat yang diperbarui. |
2 |
Opsional |
halaman | Menentukan angka di mana penomoran halaman hasil dimulai. Misalnya, 0 = halaman pertama adalah 0. Default = 0 |
0 |
Opsional |
ukuran | Menentukan ukuran halaman. Default = 50 |
75 |
Opsional |
koneksi (Dapatkan koneksi perangkat)
API ini mengembalikan data tentang semua koneksi perangkat yang diperbarui setelah stempel waktu yang diberikan.
URI: /external/v3/integration/connections/<timestamp>
Parameter URI:
Nama | Deskripsi | Contoh | Diperlukan/Opsional |
---|---|---|---|
timestamp | Waktu mulai dari mana hasil dikembalikan, dalam milidetik dari waktu Epoch dan dalam zona waktu UTC. | /external/v3/integration/devices/1664781014000 |
Diperlukan |
GET
Parameter kueri:
Nama | Deskripsi | Contoh | Diperlukan/Opsional |
---|---|---|---|
halaman | Menentukan angka di mana penomoran halaman hasil dimulai. Misalnya, 0 = halaman pertama adalah 0. Default = 0 |
0 |
Opsional |
ukuran | Menentukan ukuran halaman. Default = 50 |
75 |
Opsional |
perangkat (Dapatkan detail untuk perangkat)
API ini mengembalikan data tentang perangkat tertentu per ID perangkat tertentu.
URI: /external/v3/integration/device/{deviceId}
GET
Parameter kueri:
Nama | Deskripsi | Contoh | Diperlukan/Opsional |
---|---|---|---|
deviceId | ID perangkat yang diminta di konsol manajemen lokal | 1 |
Diperlukan |
deleteddevices (Dapatkan perangkat yang dihapus)
API ini mengembalikan daftar ID perangkat yang baru dihapus, dari tanda waktu yang disediakan.
URI: /external/v3/integration/deleteddevices/
GET
Parameter URI:
Nama | Deskripsi | Contoh | Diperlukan/Opsional |
---|---|---|---|
timestamp | Waktu mulai dari mana hasil dikembalikan, dalam milidetik dari waktu Epoch dan dalam zona waktu UTC. | /external/v3/integration/deleteddevices/1664781014000 |
Diperlukan |
sensor (Dapatkan sensor)
API ini mengembalikan daftar objek sensor untuk sensor jaringan OT yang terhubung.
URI: /external/v3/integration/sensors/
GET
URI: /sensors
Tidak ada parameter kueri
devicecves (Dapatkan CVE perangkat)
API ini mengembalikan daftar CVE aktif untuk semua perangkat yang diperbarui sejak tanda waktu yang disediakan.
URI: /external/v3/integration/devicecves/
GET
URI: /external/v3/integration/devicecves/<timestamp>
Parameter URI
Nama | Deskripsi | Contoh | Diperlukan/Opsional |
---|---|---|---|
timestamp | Waktu mulai dari mana hasil dikembalikan, dalam milidetik dari waktu Epoch dan dalam zona waktu UTC. | /external/v3/integration/devicecves/1664781014000 |
Diperlukan |
Parameter kueri
Nama | Deskripsi | Contoh | Diperlukan/Opsional |
---|---|---|---|
halaman | Menentukan angka di mana penomoran halaman hasil dimulai. | 0 = halaman pertama adalah 0. Default = 0 |
Opsional |
ukuran | Menentukan ukuran halaman. | Default = 50 |
Opsional |
idSensor | Menampilkan hasil dari sensor tertentu, seperti yang ditentukan oleh ID sensor yang diberikan. | 1 |
Opsional |
skor | Menentukan skor CVE minimum yang akan diambil. Semua hasil akan memiliki skor CVE yang sama dengan atau lebih besar dari nilai yang diberikan. | Default = 0 . |
Opsional |
deviceIds | Daftar ID perangkat yang dipisahkan koma tempat Anda ingin menampilkan hasil. | Misalnya: 1232,34,2,456 |
Opsional |
Langkah berikutnya
Untuk informasi selengkapnya, lihat: