Referensi REST API inti Portal Perangkat Windows

Artikel
07/05/2024

Semua fungsionalitas Windows Device Portal (WDP) dibangun di REST API yang dapat dipanggil pengembang secara langsung untuk mengakses sumber daya dan mengontrol perangkat mereka secara terprogram.

Penyebaran aplikasi

Menginstal aplikasi

Permintaan

Anda dapat menginstal aplikasi dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/app/packagemanager/package

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
package	(wajib) Nama file paket yang akan diinstal.

Header permintaan

Tidak

Badan permintaan

File .appx atau .appxbundle, serta dependensi apa pun yang diperlukan aplikasi.
Sertifikat yang digunakan untuk menandatangani aplikasi, jika perangkat adalah IoT atau Windows Desktop. Platform lain tidak memerlukan sertifikat.

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	Menyebarkan permintaan yang diterima dan sedang diproses
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Catatan

Windows Mixed Reality berjalan pada desktop reguler, sehingga portalnya sama dengan Desktop.

Permintaan

Anda dapat menginstal set terkait dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/app/packagemanager/package

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
package	(wajib) Nama file paket yang akan diinstal.

Header permintaan

Tidak

Badan permintaan

Tambahkan ".opt" ke nama file paket opsional saat menentukannya sebagai parameter, seperti: "foo.appx.opt" atau "bar.appxbundle.opt".
File .appx atau .appxbundle, serta dependensi apa pun yang diperlukan aplikasi.
Sertifikat yang digunakan untuk menandatangani aplikasi, jika perangkat adalah IoT atau Windows Desktop. Platform lain tidak memerlukan sertifikat.

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	Menyebarkan permintaan yang diterima dan sedang diproses
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Mendaftarkan aplikasi di folder longgar

Permintaan

Anda dapat mendaftarkan aplikasi di folder longgar dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/app/packagemanager/networkapp

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

{
    "mainpackage" :
    {
        "networkshare" : "\\some\share\path",
        "username" : "optional_username",
        "password" : "optional_password"
    }
}

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	Menyebarkan permintaan yang diterima dan sedang diproses
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
Xbox
HoloLens
IoT

Permintaan

Anda dapat mendaftarkan set terkait di folder longgar dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/app/packagemanager/networkapp

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

{
    "mainpackage" :
    {
        "networkshare" : "\\some\share\path",
        "username" : "optional_username",
        "password" : "optional_password"
    },
    "optionalpackages" :
    [
        {
            "networkshare" : "\\some\share\path2",
            "username" : "optional_username2",
            "password" : "optional_password2"
        },
        ...
    ]
}

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	Menyebarkan permintaan yang diterima dan sedang diproses
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
Xbox
HoloLens
IoT

Mendapatkan status penginstalan aplikasi

Permintaan

Anda bisa mendapatkan status penginstalan aplikasi yang saat ini sedang berlangsung dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/app/packagemanager/state

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	Hasil penyebaran terakhir
204	Penginstalan sedang berjalan
404	Tidak ada tindakan penginstalan yang ditemukan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Menghapus instalan aplikasi

Permintaan

Anda dapat menghapus instalan aplikasi dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
DELETE	/api/app/packagemanager/package

Parameter URI

Parameter URI	Deskripsi
package	(wajib) PackageFullName (dari GET /api/app/packagemanager/packages) dari aplikasi target

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Dapatkan aplikasi yang terinstal

Permintaan

Anda bisa mendapatkan daftar aplikasi yang diinstal pada sistem dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/app/packagemanager/packages

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup daftar paket yang diinstal dengan detail terkait. Templat untuk respons ini adalah sebagai berikut.

{"InstalledPackages": [
    {
        "Name": string,
        "PackageFamilyName": string,
        "PackageFullName": string,
        "PackageOrigin": int, (https://msdn.microsoft.com/library/windows/desktop/dn313167(v=vs.85).aspx)
        "PackageRelativeId": string,
        "Publisher": string,
        "Version": {
            "Build": int,
            "Major": int,
            "Minor": int,
            "Revision": int
     },
     "RegisteredUsers": [
     {
        "UserDisplayName": string,
        "UserSID": string
     },...
     ]
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Bluetooth

Dapatkan radio Bluetooth di komputer

Permintaan

Anda bisa mendapatkan daftar radio Bluetooth yang diinstal pada komputer dengan menggunakan format permintaan berikut. Ini juga dapat ditingkatkan ke koneksi WebSocket, dengan data JSON yang sama.

Metode	URI Permintaan
GET	/api/bt/getradios
GET/WebSocket	/api/bt/getradios

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Responsnya mencakup array JSON radio Bluetooth yang terpasang pada perangkat.

{"BluetoothRadios" : [
    {
        "BluetoothAddress" : int64,
        "DisplayName" : string,
        "HasUnknownUsbDevice" : boolean,
        "HasProblem" : boolean,
        "ID" : string,
        "ProblemCode" : int,
        "State" : string
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Nyalakan atau matikan radio Bluetooth

Permintaan

Mengatur radio Bluetooth tertentu ke Aktif atau Nonaktif.

Metode	URI Permintaan
POST	/api/bt/setradio

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
ID	(wajib) ID perangkat untuk radio Bluetooth dan harus dikodekan basis 64.
Provinsi	(wajib) Ini bisa atau `"On"` `"Off"`.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Mendapatkan daftar perangkat Bluetooth yang dipasangkan

Permintaan

Anda bisa mendapatkan daftar perangkat Bluetooth yang saat ini dipasangkan dengan menggunakan format permintaan berikut. Ini dapat ditingkatkan ke koneksi WebSocket dengan data JSON yang sama. Selama masa pakai koneksi WebSocket, daftar perangkat dapat berubah. Daftar lengkap perangkat akan dikirim melalui koneksi WebSocket setiap kali ada pembaruan.

Metode	URI Permintaan
GET	/api/bt/getpaired
GET/WebSocket	/api/bt/getpaired

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup array JSON perangkat Bluetooth yang saat ini dipasangkan.

{"PairedDevices": [
    {
        "Name" : string,
        "ID" : string,
        "AudioConnectionStatus" : string
    },...
]}

Bidang AudioConnectionStatus akan ada jika perangkat dapat digunakan untuk audio pada sistem ini. (Kebijakan dan komponen opsional dapat memengaruhi hal ini.) AudioConnectionStatus akan menjadi "Tersambung" atau "Terputus".

Mendapatkan daftar perangkat Bluetooth yang tersedia

Permintaan

Anda bisa mendapatkan daftar perangkat Bluetooth yang tersedia untuk dipasangkan dengan menggunakan format permintaan berikut. Ini dapat ditingkatkan ke koneksi WebSocket dengan data JSON yang sama. Selama masa pakai koneksi WebSocket, daftar perangkat dapat berubah. Daftar lengkap perangkat akan dikirim melalui koneksi WebSocket setiap kali ada pembaruan.

Metode	URI Permintaan
GET	/api/bt/getavailable
GET/WebSocket	/api/bt/getavailable

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup array JSON perangkat Bluetooth yang saat ini tersedia untuk dipasangkan.

{"AvailableDevices": [
    {
        "Name" : string,
        "ID" : string
    },...
]}

Menyambungkan perangkat Bluetooth

Permintaan

Akan tersambung ke perangkat jika perangkat dapat digunakan untuk audio pada sistem ini. (Kebijakan dan komponen opsional dapat memengaruhi hal ini.)

Metode	URI Permintaan
POST	/api/bt/connectdevice

Parameter URI

Parameter URI	Deskripsi
ID	(wajib) ID Titik Akhir Asosiasi untuk perangkat Bluetooth dan harus dikodekan Base64.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Memutuskan sambungan perangkat Bluetooth

Permintaan

Akan memutuskan sambungan perangkat jika perangkat dapat digunakan untuk audio pada sistem ini. (Kebijakan dan komponen opsional dapat memengaruhi hal ini.)

Metode	URI Permintaan
POST	/api/bt/disconnectdevice

Parameter URI

Parameter URI	Deskripsi
ID	(wajib) ID Titik Akhir Asosiasi untuk perangkat Bluetooth dan harus dikodekan Base64.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Manajer perangkat

Mendapatkan perangkat yang terinstal di komputer

Permintaan

Anda bisa mendapatkan daftar perangkat yang diinstal pada komputer dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/devicemanager/devices

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup array JSON perangkat yang terpasang pada perangkat.

{"DeviceList": [
    {
        "Class": string,
        "Description": string,
        "ID": string,
        "Manufacturer": string,
        "ParentID": string,
        "ProblemCode": int,
        "StatusCode": int
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
IoT

Mendapatkan data tentang Perangkat/Hub USB yang terhubung

Permintaan

Anda bisa mendapatkan daftar deskriptor USB untuk perangkat USB dan Hub yang terhubung dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/ext/devices/usbdevices

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Responsnya adalah JSON yang mencakup DeviceID untuk Perangkat USB bersama dengan Deskriptor USB dan informasi port untuk hub.

{
    "DeviceList": [
        {
        "ID": string,
        "ParentID": string, // Will equal an "ID" within the list, or be blank
        "Description": string, // optional
        "Manufacturer": string, // optional
        "ProblemCode": int, // optional
        "StatusCode": int // optional
        },
        ...
    ]
}

Contoh data pengembalian

{
    "DeviceList": [{
        "ID": "System",
        "ParentID": ""
    }, {
        "Class": "USB",
        "Description": "Texas Instruments USB 3.0 xHCI Host Controller",
        "ID": "PCI\\VEN_104C&DEV_8241&SUBSYS_1589103C&REV_02\\4&37085792&0&00E7",
        "Manufacturer": "Texas Instruments",
        "ParentID": "System",
        "ProblemCode": 0,
        "StatusCode": 25174026
    }, {
        "Class": "USB",
        "Description": "USB Composite Device",
        "DeviceDriverKey": "{36fc9e60-c465-11cf-8056-444553540000}\\0016",
        "ID": "USB\\VID_045E&PID_00DB\\8&2994096B&0&1",
        "Manufacturer": "(Standard USB Host Controller)",
        "ParentID": "USB\\VID_0557&PID_8021\\7&2E9A8711&0&4",
        "ProblemCode": 0,
        "StatusCode": 25182218
    }]
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Koleksi cadangan

Mendapatkan daftar semua crash dump untuk aplikasi

Permintaan

Anda bisa mendapatkan daftar semua crash dump yang tersedia untuk semua aplikasi sideload dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/debug/dump/usermode/dumps

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup daftar crash dump untuk setiap aplikasi yang dimuat samping.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Window Mobile (dalam Program Windows Insider)
Desktop Windows
HoloLens
IoT

Mendapatkan pengaturan pengumpulan crash dump untuk aplikasi

Permintaan

Anda bisa mendapatkan pengaturan pengumpulan crash dump untuk aplikasi yang dimuat samping dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/debug/dump/usermode/crashcontrol

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
packageFullName	(wajib) Nama lengkap paket untuk aplikasi yang dimuat samping.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons memiliki format berikut.

{"CrashDumpEnabled": bool}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Window Mobile (dalam Program Windows Insider)
Desktop Windows
HoloLens
IoT

Menghapus crash dump untuk aplikasi yang dimuat samping

Permintaan

Anda dapat menghapus crash dump aplikasi yang dimuat samping dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
DELETE	/api/debug/dump/usermode/crashdump

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
packageFullName	(wajib) Nama lengkap paket untuk aplikasi yang dimuat samping.
fileName	(wajib) Nama file cadangan yang harus dihapus.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Window Mobile (dalam Program Windows Insider)
Desktop Windows
HoloLens
IoT

Menonaktifkan crash dump untuk aplikasi yang dimuat samping

Permintaan

Anda dapat menonaktifkan crash dump untuk aplikasi yang dimuat samping dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
DELETE	/api/debug/dump/usermode/crashcontrol

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
packageFullName	(wajib) Nama lengkap paket untuk aplikasi yang dimuat samping.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Window Mobile (dalam Program Windows Insider)
Desktop Windows
HoloLens
IoT

Mengunduh crash dump untuk aplikasi yang dimuat samping

Permintaan

Anda dapat mengunduh crash dump aplikasi yang dimuat samping dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/debug/dump/usermode/crashdump

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
packageFullName	(wajib) Nama lengkap paket untuk aplikasi yang dimuat samping.
fileName	(wajib) Nama file cadangan yang ingin Anda unduh.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup file cadangan. Anda dapat menggunakan WinDbg atau Visual Studio untuk memeriksa file cadangan.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Window Mobile (dalam Program Windows Insider)
Desktop Windows
HoloLens
IoT

Mengaktifkan crash dump untuk aplikasi yang dimuat samping

Permintaan

Anda dapat mengaktifkan crash dump untuk aplikasi yang dimuat samping dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/debug/dump/usermode/crashcontrol

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
packageFullName	(wajib) Nama lengkap paket untuk aplikasi yang dimuat samping.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Window Mobile (dalam Program Windows Insider)
Desktop Windows
HoloLens
IoT

Mendapatkan daftar file bugcheck

Permintaan

Anda bisa mendapatkan daftar file minidump bugcheck dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/debug/dump/kernel/dumplist

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup daftar nama file cadangan dan ukuran file ini. Daftar ini akan dalam format berikut.

{"DumpFiles": [
    {
        "FileName": string,
        "FileSize": int
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Mengunduh file cadangan bugcheck

Permintaan

Anda dapat mengunduh file cadangan bugcheck dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/debug/dump/kernel/dump

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
filename	(wajib) Nama file file cadangan. Anda dapat menemukan ini dengan menggunakan API untuk mendapatkan daftar cadangan.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup file cadangan. Anda dapat memeriksa file ini menggunakan WinDbg.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Mendapatkan pengaturan kontrol crash bugcheck

Permintaan

Anda bisa mendapatkan pengaturan kontrol crash bugcheck dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/debug/dump/kernel/crashcontrol

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup pengaturan kontrol crash. Untuk informasi selengkapnya tentang CrashControl, lihat artikel CrashControl . Templat untuk respons adalah sebagai berikut.

{
    "autoreboot": bool (0 or 1),
    "dumptype": int (0 to 4),
    "maxdumpcount": int,
    "overwrite": bool (0 or 1)
}

Jenis cadangan

0: Dinonaktifkan

1: Menyelesaikan cadangan memori (mengumpulkan semua memori yang digunakan)

2: Cadangan memori kernel (mengabaikan memori mode pengguna)

3: Minidump kernel terbatas

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Dapatkan cadangan kernel langsung

Permintaan

Anda bisa mendapatkan cadangan kernel langsung dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/debug/dump/livekernel

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Responsnya mencakup dump mode kernel penuh. Anda dapat memeriksa file ini menggunakan WinDbg.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Mendapatkan cadangan dari proses pengguna langsung

Permintaan

Anda bisa mendapatkan cadangan untuk proses pengguna langsung dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/debug/dump/usermode/live

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
pid	(wajib) Id proses unik untuk proses yang Anda minati.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup dump proses. Anda dapat memeriksa file ini menggunakan WinDbg atau Visual Studio.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Mengatur pengaturan kontrol crash bugcheck

Permintaan

Anda dapat mengatur pengaturan untuk mengumpulkan data pemeriksaan bug dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/debug/dump/kernel/crashcontrol

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
boot ulang otomatis	(opsional) Benar atau salah. Ini menunjukkan apakah sistem dimulai ulang secara otomatis setelah gagal atau terkunci.
dumptype	(opsional) Jenis cadangan. Untuk nilai yang didukung, lihat Enumerasi CrashDumpType.
maxdumpcount	(opsional) Jumlah maksimum cadangan yang akan disimpan.
menimpa	(opsional) True of false. Ini menunjukkan apakah akan menimpa cadangan lama atau tidak ketika batas penghitung cadangan yang ditentukan oleh maxdumpcount telah tercapai.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

ETW

Membuat sesi ETW realtime melalui websocket

Permintaan

Anda dapat membuat sesi ETW realtime dengan menggunakan format permintaan berikut. Ini akan dikelola melalui websocket. Peristiwa ETW di-batch di server dan dikirim ke klien sekali per detik.

Metode	URI Permintaan
GET/WebSocket	/api/etw/session/realtime

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup peristiwa ETW dari penyedia yang diaktifkan. Lihat perintah WebSocket ETW di bawah ini.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Perintah WebSocket ETW

Perintah ini dikirim dari klien ke server.

Perintah	Deskripsi
penyedia {guid} aktifkan {level}	Aktifkan penyedia yang ditandai oleh {guid} (tanpa tanda kurung) pada tingkat yang ditentukan. {level} adalah int dari 1 (detail paling sedikit) hingga 5 (verbose).
penyedia {guid} nonaktifkan	Nonaktifkan penyedia yang ditandai oleh {guid} (tanpa tanda kurung).

Respons ini dikirim dari server ke klien. Ini dikirim sebagai teks dan Anda mendapatkan format berikut dengan mengurai JSON.

{
    "Events":[
        {
            "Timestamp": int,
            "ProviderName": string,
            "ID": int, 
            "TaskName": string,
            "Keyword": int,
            "Level": int,
            payload objects...
        },...
    ],
    "Frequency": int
}

Objek payload adalah pasangan nilai kunci tambahan (string:string) yang disediakan dalam peristiwa ETW asli.

Contoh:

{
    "ID" : 42, 
    "Keyword" : 9223372036854775824, 
    "Level" : 4, 
    "Message" : "UDPv4: 412 bytes transmitted from 10.81.128.148:510 to 132.215.243.34:510. ",
    "PID" : "1218", 
    "ProviderName" : "Microsoft-Windows-Kernel-Network", 
    "TaskName" : "KERNEL_NETWORK_TASK_UDPIP", 
    "Timestamp" : 131039401761757686, 
    "connid" : "0", 
    "daddr" : "132.245.243.34", 
    "dport" : "500", 
    "saddr" : "10.82.128.118", 
    "seqnum" : "0", 
    "size" : "412", 
    "sport" : "500"
}

Menghitung penyedia ETW terdaftar

Permintaan

Anda dapat menghitung melalui penyedia terdaftar dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/etw/providers

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup daftar penyedia ETW. Daftar akan menyertakan nama yang mudah diingat dan GUID untuk setiap penyedia dalam format berikut.

{"Providers": [
    {
        "GUID": string, (GUID)
        "Name": string
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Menghitung penyedia ETW kustom yang diekspos oleh platform.

Permintaan

Anda dapat menghitung melalui penyedia terdaftar dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/etw/customproviders

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

200 OK. Respons mencakup daftar penyedia ETW. Daftar akan menyertakan nama yang mudah diingat dan GUID untuk setiap penyedia.

{"Providers": [
    {
        "GUID": string, (GUID)
        "Name": string
    },...
]}

Kode status

Kode status standar.

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Lokasi

Mendapatkan mode penimpaan lokasi

Permintaan

Anda bisa mendapatkan status penimpaan tumpukan lokasi perangkat dengan menggunakan format permintaan berikut. Mode pengembang harus aktif agar panggilan ini berhasil.

Metode	URI Permintaan
GET	/ext/location/override

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup status penimpaan perangkat dalam format berikut.

{"Override" : bool}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Mengatur mode penimpaan lokasi

Permintaan

Anda dapat mengatur status penimpaan tumpukan lokasi perangkat dengan menggunakan format permintaan berikut. Saat diaktifkan, tumpukan lokasi memungkinkan injeksi posisi. Mode pengembang harus aktif agar panggilan ini berhasil.

Metode	URI Permintaan
TARUH	/ext/location/override

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

{"Override" : bool}

Respons

Respons mencakup status penimpaan yang telah diatur perangkat ke dalam format berikut.

{"Override" : bool}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Dapatkan posisi yang disuntikkan

Permintaan

Anda bisa mendapatkan lokasi perangkat yang disuntikkan (spoofed) dengan menggunakan format permintaan berikut. Lokasi yang disuntikkan harus diatur, atau kesalahan akan dilemparkan.

Metode	URI Permintaan
GET	/ext/location/position

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup nilai garis lintang dan bujur yang disuntikkan saat ini dalam format berikut.

{
    "Latitude" : double,
    "Longitude" : double
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Mengatur posisi yang disuntikkan

Permintaan

Anda dapat mengatur lokasi perangkat yang disuntikkan (spoofed) dengan menggunakan format permintaan berikut. Mode penimpaan lokasi harus diaktifkan terlebih dahulu pada perangkat, dan lokasi yang ditetapkan harus merupakan lokasi yang valid atau kesalahan akan dilemparkan.

Metode	URI Permintaan
TARUH	/ext/location/override

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

{
    "Latitude" : double,
    "Longitude" : double
}

Respons

Respons mencakup lokasi yang telah diatur dalam format berikut.

{
    "Latitude" : double,
    "Longitude" : double
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Informasi OS

Mendapatkan nama komputer

Permintaan

Anda bisa mendapatkan nama komputer dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/os/machinename

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup nama komputer dalam format berikut.

{"ComputerName": string}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Mendapatkan informasi sistem operasi

Permintaan

Anda bisa mendapatkan informasi OS untuk komputer dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/os/info

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup informasi OS dalam format berikut.

{
    "ComputerName": string,
    "OsEdition": string,
    "OsEditionId": int,
    "OsVersion": string,
    "Platform": string
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Dapatkan keluarga perangkat

Permintaan

Anda bisa mendapatkan keluarga perangkat (Xbox, telepon, desktop, dll) menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/os/devicefamily

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Responsnya mencakup keluarga perangkat (SKU - Desktop, Xbox, dll).

{
   "DeviceType" : string
}

DeviceType akan terlihat seperti "Windows.Xbox", "Windows.Desktop", dll.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Mengatur nama komputer

Permintaan

Anda dapat mengatur nama komputer dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/os/machinename

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
nama	(wajib) Nama baru untuk komputer. Ini harus dikodekan base64.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Informasi pengguna

Mendapatkan pengguna aktif

Permintaan

Anda bisa mendapatkan nama pengguna aktif di perangkat dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/users/activeuser

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup informasi pengguna dalam format berikut.

Pada keberhasilan:

{
    "UserDisplayName" : string, 
    "UserSID" : string
}

Gagal:

{
    "Code" : int, 
    "CodeText" : string, 
    "Reason" : string, 
    "Success" : bool
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Data performa

Mendapatkan daftar proses yang sedang berjalan

Permintaan

Anda bisa mendapatkan daftar proses yang sedang berjalan dengan menggunakan format permintaan berikut. ini juga dapat ditingkatkan ke koneksi WebSocket, dengan data JSON yang sama didorong ke klien sekali per detik.

Metode	URI Permintaan
GET	/api/resourcemanager/processes
GET/WebSocket	/api/resourcemanager/processes

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup daftar proses dengan detail untuk setiap proses. Informasi dalam format JSON dan memiliki templat berikut.

{"Processes": [
    {
        "CPUUsage": float,
        "ImageName": string,
        "PageFileUsage": long,
        "PrivateWorkingSet": long,
        "ProcessId": int,
        "SessionId": int,
        "UserName": string,
        "VirtualSize": long,
        "WorkingSetSize": long
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Mendapatkan statistik performa sistem

Permintaan

Anda bisa mendapatkan statistik performa sistem dengan menggunakan format permintaan berikut. Ini termasuk informasi seperti siklus baca dan tulis dan berapa banyak memori yang telah digunakan.

Metode	URI Permintaan
GET	/api/resourcemanager/systemperf
GET/WebSocket	/api/resourcemanager/systemperf

Ini juga dapat ditingkatkan ke koneksi WebSocket. Ini menyediakan data JSON yang sama di bawah ini sekali setiap detik.

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup statistik performa untuk sistem seperti penggunaan CPU dan GPU, akses memori, dan akses jaringan. Informasi ini dalam format JSON dan memiliki templat berikut.

{
    "AvailablePages": int,
    "CommitLimit": int,
    "CommittedPages": int,
    "CpuLoad": int,
    "IOOtherSpeed": int,
    "IOReadSpeed": int,
    "IOWriteSpeed": int,
    "NonPagedPoolPages": int,
    "PageSize": int,
    "PagedPoolPages": int,
    "TotalInstalledInKb": int,
    "TotalPages": int,
    "GPUData": 
    {
        "AvailableAdapters": [{ (One per detected adapter)
            "DedicatedMemory": int,
            "DedicatedMemoryUsed": int,
            "Description": string,
            "SystemMemory": int,
            "SystemMemoryUsed": int,
            "EnginesUtilization": [ float,... (One per detected engine)]
        },...
    ]},
    "NetworkingData": {
        "NetworkInBytes": int,
        "NetworkOutBytes": int
    }
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Power

Dapatkan status baterai saat ini

Permintaan

Anda bisa mendapatkan status baterai saat ini dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/power/battery

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Informasi status baterai saat ini dikembalikan menggunakan format berikut.

{
    "AcOnline": int (0 | 1),
    "BatteryPresent": int (0 | 1),
    "Charging": int (0 | 1),
    "DefaultAlert1": int,
    "DefaultAlert2": int,
    "EstimatedTime": int,
    "MaximumCapacity": int,
    "RemainingCapacity": int
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Mendapatkan skema daya aktif

Permintaan

Anda bisa mendapatkan skema daya aktif dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/power/activecfg

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Skema daya aktif memiliki format berikut.

{"ActivePowerScheme": string (guid of scheme)}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Mendapatkan subnilai untuk skema daya

Permintaan

Anda bisa mendapatkan subnilai untuk skema daya dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	Jalur skema /api/power/cfg/<power>

Opsi:

SCHEME_CURRENT

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Daftar lengkap status daya yang tersedia berdasarkan per aplikasi dan pengaturan untuk menandai berbagai status daya seperti baterai rendah dan kritis.

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Mendapatkan status daya sistem

Permintaan

Anda dapat memeriksa status daya sistem dengan menggunakan format permintaan berikut. Ini akan memungkinkan Anda memeriksa apakah dalam keadaan daya rendah.

Metode	URI Permintaan
GET	/api/power/state

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Informasi status daya memiliki templat berikut.

{"LowPowerState" : false, "LowPowerStateAvailable" : true }

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Mengatur skema daya aktif

Permintaan

Anda dapat mengatur skema daya aktif dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/power/activecfg

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
skema	(wajib) GUID skema yang ingin Anda tetapkan sebagai skema daya aktif untuk sistem.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Mengatur sub-nilai untuk skema daya

Permintaan

Anda dapat mengatur sub-nilai untuk skema daya dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	Jalur skema /api/power/cfg/<power>

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
valueAC	(wajib) Nilai yang digunakan untuk daya A/C.
valueDC	(wajib) Nilai yang digunakan untuk daya baterai.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Dapatkan laporan studi tidur

Permintaan

Metode	URI Permintaan
GET	/api/power/sleepstudy/report

Anda bisa mendapatkan laporan studi tidur dengan menggunakan format permintaan berikut.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Responsnya adalah file yang berisi studi tidur.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Menghitung laporan studi tidur yang tersedia

Permintaan

Anda dapat menghitung laporan studi tidur yang tersedia dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/power/sleepstudy/reports

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Daftar laporan yang tersedia memiliki templat berikut.

{"Reports": [
    {
        "FileName": string
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Dapatkan transformasi studi tidur

Permintaan

Anda bisa mendapatkan transformasi studi tidur dengan menggunakan format permintaan berikut. Transformasi ini adalah XSLT yang mengonversi laporan studi tidur menjadi format XML yang dapat dibaca oleh seseorang.

Metode	URI Permintaan
GET	/api/power/sleepstudy/transform

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons berisi transformasi studi tidur.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
IoT

Kontrol jauh

Mulai ulang komputer target

Permintaan

Anda dapat memulai ulang komputer target dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/control/restart

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Matikan komputer target

Permintaan

Anda dapat mematikan komputer target dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/control/shutdown

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Manajer tugas

Memulai aplikasi modern

Permintaan

Anda dapat memulai aplikasi modern dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/taskmanager/app

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
appid	(wajib) PRAID untuk aplikasi yang ingin Anda mulai. Nilai ini harus dikodekan hex64.
package	(wajib) Nama lengkap untuk paket aplikasi yang ingin Anda mulai. Nilai ini harus dikodekan hex64.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Menghentikan aplikasi modern

Permintaan

Anda dapat menghentikan aplikasi modern dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
DELETE	/api/taskmanager/app

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
package	(wajib) Nama lengkap paket aplikasi yang ingin Anda hentikan. Nilai ini harus dikodekan hex64.
forcestop	(opsional) Nilai ya menunjukkan bahwa sistem harus memaksa semua proses berhenti.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Mematikan proses oleh PID

Permintaan

Anda dapat mematikan proses dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
DELETE	/api/taskmanager/process

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
pid	(wajib) Id proses unik untuk proses dihentikan.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Jaringan

Mendapatkan konfigurasi IP saat ini

Permintaan

Anda bisa mendapatkan konfigurasi IP saat ini dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/networking/ipconfig

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons mencakup konfigurasi IP dalam templat berikut.

{"Adapters": [
    {
        "Description": string,
        "HardwareAddress": string,
        "Index": int,
        "Name": string,
        "Type": string,
        "DHCP": {
            "LeaseExpires": int, (timestamp)
            "LeaseObtained": int, (timestamp)
            "Address": {
                "IpAddress": string,
                "Mask": string
            }
        },
        "WINS": {(WINS is optional)
            "Primary": {
                "IpAddress": string,
                "Mask": string
            },
            "Secondary": {
                "IpAddress": string,
                "Mask": string
            }
        },
        "Gateways": [{ (always 1+)
            "IpAddress": "10.82.128.1",
            "Mask": "255.255.255.255"
            },...
        ],
        "IpAddresses": [{ (always 1+)
            "IpAddress": "10.82.128.148",
            "Mask": "255.255.255.0"
            },...
        ]
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Mengatur alamat IP statis (konfigurasi IPV4)

Permintaan

Mengatur konfigurasi IPV4 dengan IP statis dan DNS. Jika IP statis tidak ditentukan, maka IP tersebut akan mengaktifkan DHCP. Jika IP statis ditentukan, maka DNS juga harus ditentukan.

Metode	URI Permintaan
TARUH	/api/networking/ipv4config

Parameter URI

Parameter URI	Deskripsi
AdapterName	(wajib) GUID antarmuka jaringan.
IPAddress	Alamat IP statis yang akan diatur.
SubnetMask	(diperlukan jika IPAddress tidak null) Subnet mask statis.
DefaultGateway	(diperlukan jika IPAddress tidak null) Gateway default statis.
PrimaryDNS	(diperlukan jika IPAddress tidak null) DNS utama statis yang akan diatur.
SecondayDNS	(diperlukan jika PrimaryDNS tidak null) DNS sekunder statis untuk diatur.

Untuk kejelasan, untuk mengatur antarmuka ke DHCP, serialisasikan hanya AdapterName pada kawat:

{
    "AdapterName":"{82F86C1B-2BAE-41E3-B08D-786CA44FEED7}"
}

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Menghitung antarmuka jaringan nirkabel

Permintaan

Anda dapat menghitung antarmuka jaringan nirkabel yang tersedia dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/wifi/interfaces

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Daftar antarmuka nirkabel yang tersedia dengan detail dalam format berikut.

{"Interfaces": [{
    "Description": string,
    "GUID": string (guid with curly brackets),
    "Index": int,
    "ProfilesList": [
        {
            "GroupPolicyProfile": bool,
            "Name": string, (Network currently connected to)
            "PerUserProfile": bool
        },...
    ]
    }
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Menghitung jaringan nirkabel

Permintaan

Anda dapat menghitung daftar jaringan nirkabel pada antarmuka yang ditentukan dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/wifi/networks

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
interface	(wajib) GUID untuk antarmuka jaringan yang digunakan untuk mencari jaringan nirkabel, tanpa tanda kurung.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Daftar jaringan nirkabel yang ditemukan pada antarmuka yang disediakan. Ini termasuk detail untuk jaringan dalam format berikut.

{"AvailableNetworks": [
    {
        "AlreadyConnected": bool,
        "AuthenticationAlgorithm": string, (WPA2, etc)
        "Channel": int,
        "CipherAlgorithm": string, (for example, AES)
        "Connectable": int, (0 | 1)
        "InfrastructureType": string,
        "ProfileAvailable": bool,
        "ProfileName": string,
        "SSID": string,
        "SecurityEnabled": int, (0 | 1)
        "SignalQuality": int,
        "BSSID": [int,...],
        "PhysicalTypes": [string,...]
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Sambungkan dan putuskan sambungan ke jaringan Wi-Fi.

Permintaan

Anda dapat menyambungkan atau memutuskan sambungan ke jaringan Wi-Fi dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
POST	/api/wifi/network

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
interface	(wajib) GUID untuk antarmuka jaringan yang Anda gunakan untuk menyambungkan ke jaringan.
op	(wajib) Menunjukkan tindakan yang harus diambil. Nilai yang mungkin adalah sambungkan atau putuskan sambungan.
ssid	(diperlukan jika op == connect) SSID yang akan disambungkan.
kunci	(diperlukan jika op == sambungkan dan jaringan memerlukan autentikasi) Kunci bersama.
createprofile	(wajib) Buat profil untuk jaringan pada perangkat. Hal ini akan menyebabkan perangkat tersambung secara otomatis ke jaringan di masa mendatang. Ini bisa ya atau tidak.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Menghapus profil Wi-Fi

Permintaan

Anda dapat menghapus profil yang terkait dengan jaringan pada antarmuka tertentu dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
DELETE	/api/wifi/profile

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
interface	(wajib) GUID untuk antarmuka jaringan yang terkait dengan profil yang akan dihapus.
profil	(wajib) Nama profil yang akan dihapus.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Pelaporan Galat Windows (WER)

Mengunduh file pelaporan kesalahan Windows (WER)

Permintaan

Anda dapat mengunduh file terkait WER dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/wer/report/file

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
pengguna	(wajib) Nama pengguna yang terkait dengan laporan.
jenis	(wajib) Jenis laporan. Ini dapat dikueri atau diarsipkan.
nama	(wajib) Nama laporan. Ini harus dikodekan base64.
file	(wajib) Nama file yang akan diunduh dari laporan. Ini harus dikodekan base64.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Respons berisi file yang diminta.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Menghitung file dalam laporan pelaporan kesalahan Windows (WER)

Permintaan

Anda dapat menghitung file dalam laporan WER dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/wer/report/files

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
pengguna	(wajib) Pengguna yang terkait dengan laporan.
jenis	(wajib) Jenis laporan. Ini dapat dikueri atau diarsipkan.
nama	(wajib) Nama laporan. Ini harus dikodekan base64.

Header permintaan

Tidak

Badan permintaan

{"Files": [
    {
        "Name": string, (Filename, not base64 encoded)
        "Size": int (bytes)
    },...
]}

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Mencantumkan laporan pelaporan kesalahan Windows (WER)

Permintaan

Anda bisa mendapatkan laporan WER dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/wer/reports

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

WER melaporkan dalam format berikut.

{"WerReports": [
    {
        "User": string,
        "Reports": [
            {
                "CreationTime": int,
                "Name": string, (not base64 encoded)
                "Type": string ("Queue" or "Archive")
            },
    ]},...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Desktop Windows
HoloLens
IoT

Perekam Performa Windows (WPR)

Mulai melacak dengan profil kustom

Permintaan

Anda dapat mengunggah profil WPR dan mulai melacak menggunakan profil tersebut dengan menggunakan format permintaan berikut. Hanya satu jejak yang dapat berjalan pada satu waktu. Profil tidak akan tetap ada pada perangkat.

Metode	URI Permintaan
POST	/api/wpr/customtrace

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Badan http multi-bagian yang sesuai dengan yang berisi profil WPR kustom.

Respons

Status sesi WPR dalam format berikut.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal or boot)
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Memulai sesi pelacakan performa boot

Permintaan

Anda dapat memulai sesi pelacakan WPR boot dengan menggunakan format permintaan berikut. Ini juga dikenal sebagai sesi pelacakan performa.

Metode	URI Permintaan
POST	/api/wpr/boottrace

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
profil	(wajib) Parameter ini diperlukan saat mulai. Nama profil yang harus memulai sesi pelacakan performa. Profil yang mungkin disimpan dalam perfprofiles/profiles.json.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Pada awalnya, API ini mengembalikan status sesi WPR dalam format berikut.

{
    "SessionType": string, (Running or Idle) 
    "State": string (boot)
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Menghentikan sesi pelacakan performa boot

Permintaan

Anda dapat menghentikan sesi pelacakan WPR boot dengan menggunakan format permintaan berikut. Ini juga dikenal sebagai sesi pelacakan performa.

Metode	URI Permintaan
GET	/api/wpr/boottrace

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Tidak ada. Catatan: Ini adalah operasi jangka panjang. Ini akan kembali ketika ETL selesai menulis ke disk.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Memulai sesi pelacakan performa

Permintaan

Anda dapat memulai sesi pelacakan WPR dengan menggunakan format permintaan berikut. Ini juga dikenal sebagai sesi pelacakan performa. Hanya satu jejak yang dapat berjalan pada satu waktu.

Metode	URI Permintaan
POST	/api/wpr/trace

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
profil	(wajib) Nama profil yang harus memulai sesi pelacakan performa. Profil yang mungkin disimpan dalam perfprofiles/profiles.json.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Pada awalnya, API ini mengembalikan status sesi WPR dalam format berikut.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal)
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Menghentikan sesi pelacakan performa

Permintaan

Anda dapat menghentikan sesi pelacakan WPR dengan menggunakan format permintaan berikut. Ini juga dikenal sebagai sesi pelacakan performa.

Metode	URI Permintaan
GET	/api/wpr/trace

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Tidak ada. Catatan: Ini adalah operasi jangka panjang. Ini akan kembali ketika ETL selesai menulis ke disk.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Mengambil status sesi pelacakan

Permintaan

Anda dapat mengambil status sesi WPR saat ini dengan menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/wpr/status

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Status sesi pelacakan WPR dalam format berikut.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal or boot)
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Mencantumkan sesi pelacakan yang selesai (ETL)

Permintaan

Anda bisa mendapatkan daftar jejak ETL pada perangkat menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/wpr/tracefiles

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Daftar sesi pelacakan yang selesai disediakan dalam format berikut.

{"Items": [{
    "CurrentDir": string (filepath),
    "DateCreated": int (File CreationTime),
    "FileSize": int (bytes),
    "Id": string (filename),
    "Name": string (filename),
    "SubPath": string (filepath),
    "Type": int
}]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Mengunduh sesi pelacakan (ETL)

Permintaan

Anda dapat mengunduh tracefile (jejak boot atau jejak mode pengguna) menggunakan format permintaan berikut.

Metode	URI Permintaan
GET	/api/wpr/tracefile

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
filename	(wajib) Nama jejak ETL yang akan diunduh. Ini dapat ditemukan di /api/wpr/tracefiles

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Mengembalikan file ETL jejak.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Menghapus sesi pelacakan (ETL)

Permintaan

Anda dapat menghapus tracefile (jejak boot atau jejak mode pengguna) menggunakan format permintaan berikut.

Metode	URI Permintaan
DELETE	/api/wpr/tracefile

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan:

Parameter URI	Deskripsi
filename	(wajib) Nama jejak ETL yang akan dihapus. Ini dapat ditemukan di /api/wpr/tracefiles

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Mengembalikan file ETL jejak.

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
IoT

Tag DNS-SD

Tampilkan Tag

Permintaan

Lihat tag yang saat ini diterapkan untuk perangkat. Ini diiklankan melalui catatan DNS-SD TXT di kunci T.

Metode	URI Permintaan
GET	/api/dns-sd/tags

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons Tag yang saat ini diterapkan dalam format berikut.

 {
    "tags": [
        "tag1", 
        "tag2", 
        ...
     ]
}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
5XX	Kesalahan Server

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Hapus Tag

Permintaan

Hapus semua tag yang saat ini diiklankan oleh DNS-SD.

Metode	URI Permintaan
DELETE	/api/dns-sd/tags

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Tidak

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
5XX	Kesalahan Server

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Hapus Tag

Permintaan

Hapus tag yang saat ini diiklankan oleh DNS-SD.

Metode	URI Permintaan
DELETE	/api/dns-sd/tag

Parameter URI

Parameter URI	Deskripsi
tagValue	(wajib) Tag yang akan dihapus.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Tidak

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

Menambahkan Tag

Permintaan

Tambahkan tag ke iklan DNS-SD.

Metode	URI Permintaan
POST	/api/dns-sd/tag

Parameter URI

Parameter URI	Deskripsi
tagValue	(wajib) Tag yang akan ditambahkan.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Tidak

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
401	Ruang tag Luapan. Hasil ketika tag yang diusulkan terlalu panjang untuk catatan layanan DNS-SD yang dihasilkan.

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
Xbox
HoloLens
IoT

App File Explorer

Mendapatkan folder yang diketahui

Permintaan

Dapatkan daftar folder tingkat atas yang dapat diakses.

Metode	URI Permintaan
GET	/api/filesystem/apps/knownfolders

Parameter URI

Tidak

Header permintaan

Tidak

Badan permintaan

Tidak

Respons Folder yang tersedia dalam format berikut.

 {"KnownFolders": [
    "folder0",
    "folder1",...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	Menyebarkan permintaan yang diterima dan sedang diproses
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
Xbox
IoT

Mendapatkan file

Permintaan

Dapatkan daftar file dalam folder.

Metode	URI Permintaan
GET	/api/filesystem/apps/files

Parameter URI

Parameter URI	Deskripsi
knownfolderid	(wajib) Direktori tingkat atas tempat Anda menginginkan daftar file. Gunakan LocalAppData untuk akses ke aplikasi yang dimuat samping.
packagefullname	(*diperlukan jika knownfolderid* == LocalAppData**) Nama lengkap paket aplikasi yang Anda minati.
jalan	(opsional) Sub-direktori dalam folder atau paket yang ditentukan di atas.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons Folder yang tersedia dalam format berikut.

{"Items": [
    {
        "CurrentDir": string (folder under the requested known folder),
        "DateCreated": int,
        "FileSize": int (bytes),
        "Id": string,
        "Name": string,
        "SubPath": string (present if this item is a folder, this is the name of the folder),
        "Type": int
    },...
]}

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
Xbox
IoT

Unduh file

Permintaan

Dapatkan file dari folder atau appLocalData yang diketahui.

Metode	URI Permintaan
GET	/api/filesystem/apps/file

Parameter URI

Parameter URI	Deskripsi
knownfolderid	(wajib) Direktori tingkat atas tempat Anda ingin mengunduh file. Gunakan LocalAppData untuk akses ke aplikasi yang dimuat samping.
filename	(wajib) Nama file yang sedang diunduh.
packagefullname	(*diperlukan jika knownfolderid* == LocalAppData**) Nama lengkap paket yang Anda minati.
jalan	(opsional) Sub-direktori dalam folder atau paket yang ditentukan di atas.

Header permintaan

Tidak

Badan permintaan

File yang diminta, jika ada

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	File yang diminta
404	File tidak ditemukan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
Xbox
IoT

Mengganti nama file

Permintaan

Mengganti nama file dalam folder.

Metode	URI Permintaan
POST	/api/filesystem/apps/rename

Parameter URI

Parameter URI	Deskripsi
knownfolderid	(wajib) Direktori tingkat atas tempat file berada. Gunakan LocalAppData untuk akses ke aplikasi yang dimuat samping.
filename	(wajib) Nama asli file yang diganti namanya.
namafile baru	(wajib) Nama baru file.
packagefullname	(*diperlukan jika knownfolderid* == LocalAppData**) Nama lengkap paket aplikasi yang Anda minati.
jalan	(opsional) Sub-direktori dalam folder atau paket yang ditentukan di atas.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Tidak

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK. File diganti namanya
404	File tidak ditemukan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
Xbox
IoT

Hapus file

Permintaan

Menghapus file dalam folder.

Metode	URI Permintaan
DELETE	/api/filesystem/apps/file

Parameter URI

Parameter URI	Deskripsi
knownfolderid	(wajib) Direktori tingkat atas tempat Anda ingin menghapus file. Gunakan LocalAppData untuk akses ke aplikasi yang dimuat samping.
filename	(wajib) Nama file yang sedang dihapus.
packagefullname	(*diperlukan jika knownfolderid* == LocalAppData**) Nama lengkap paket aplikasi yang Anda minati.
jalan	(opsional) Sub-direktori dalam folder atau paket yang ditentukan di atas.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Tidak

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK. File dihapus
404	File tidak ditemukan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
Xbox
IoT

Mengunggah file

Permintaan

Unggah file ke folder. Ini akan menimpa file yang ada dengan nama yang sama, tetapi tidak akan membuat folder baru.

Metode	URI Permintaan
POST	/api/filesystem/apps/file

Parameter URI

Parameter URI	Deskripsi
knownfolderid	(wajib) Direktori tingkat atas tempat Anda ingin mengunggah file. Gunakan LocalAppData untuk akses ke aplikasi yang dimuat samping.
packagefullname	(*diperlukan jika knownfolderid* == LocalAppData**) Nama lengkap paket aplikasi yang Anda minati.
ekstrak	(wajib) Benar atau salah. Ini menunjukkan apakah file harus diekstrak setelah diunggah.
jalan	(opsional) Sub-direktori dalam folder atau paket yang ditentukan di atas.

Header permintaan

Tidak

Badan permintaan

Tidak

Respons

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP	Deskripsi
200	OK. File diunggah
4XX	Kode kesalahan
5XX	Kode kesalahan

Keluarga perangkat yang tersedia

Windows Mobile
Desktop Windows
HoloLens
Xbox
IoT

Bagikan melalui

Referensi REST API inti Portal Perangkat Windows

Penyebaran aplikasi

Menginstal aplikasi

Menginstal set terkait

Mendaftarkan aplikasi di folder longgar

Mendaftarkan set terkait dalam folder file longgar

Mendapatkan status penginstalan aplikasi

Menghapus instalan aplikasi

Dapatkan aplikasi yang terinstal

Bluetooth

Dapatkan radio Bluetooth di komputer

Nyalakan atau matikan radio Bluetooth

Mendapatkan daftar perangkat Bluetooth yang dipasangkan

Mendapatkan daftar perangkat Bluetooth yang tersedia

Menyambungkan perangkat Bluetooth

Memutuskan sambungan perangkat Bluetooth

Manajer perangkat

Mendapatkan perangkat yang terinstal di komputer

Mendapatkan data tentang Perangkat/Hub USB yang terhubung

Koleksi cadangan

Mendapatkan daftar semua crash dump untuk aplikasi

Mendapatkan pengaturan pengumpulan crash dump untuk aplikasi

Menghapus crash dump untuk aplikasi yang dimuat samping

Menonaktifkan crash dump untuk aplikasi yang dimuat samping

Mengunduh crash dump untuk aplikasi yang dimuat samping

Mengaktifkan crash dump untuk aplikasi yang dimuat samping

Mendapatkan daftar file bugcheck

Mengunduh file cadangan bugcheck

Mendapatkan pengaturan kontrol crash bugcheck

Dapatkan cadangan kernel langsung

Mendapatkan cadangan dari proses pengguna langsung

Mengatur pengaturan kontrol crash bugcheck

ETW

Membuat sesi ETW realtime melalui websocket

Perintah WebSocket ETW

Menghitung penyedia ETW terdaftar

Menghitung penyedia ETW kustom yang diekspos oleh platform.

Lokasi

Mendapatkan mode penimpaan lokasi

Mengatur mode penimpaan lokasi

Dapatkan posisi yang disuntikkan

Mengatur posisi yang disuntikkan

Informasi OS

Mendapatkan nama komputer

Mendapatkan informasi sistem operasi

Dapatkan keluarga perangkat

Mengatur nama komputer

Informasi pengguna

Mendapatkan pengguna aktif

Data performa

Mendapatkan daftar proses yang sedang berjalan

Mendapatkan statistik performa sistem

Power

Dapatkan status baterai saat ini

Mendapatkan skema daya aktif

Mendapatkan subnilai untuk skema daya

Mendapatkan status daya sistem

Mengatur skema daya aktif

Mengatur sub-nilai untuk skema daya

Dapatkan laporan studi tidur

Menghitung laporan studi tidur yang tersedia

Dapatkan transformasi studi tidur

Kontrol jauh

Mulai ulang komputer target

Matikan komputer target

Manajer tugas

Memulai aplikasi modern

Menghentikan aplikasi modern

Mematikan proses oleh PID

Jaringan

Mendapatkan konfigurasi IP saat ini

Mengatur alamat IP statis (konfigurasi IPV4)

Menghitung antarmuka jaringan nirkabel

Menghitung jaringan nirkabel

Sambungkan dan putuskan sambungan ke jaringan Wi-Fi.

Menghapus profil Wi-Fi

Pelaporan Galat Windows (WER)

Mengunduh file pelaporan kesalahan Windows (WER)

Menghitung file dalam laporan pelaporan kesalahan Windows (WER)