Windows 裝置入口網站核心 REST API 參考資料

發行項
09/13/2023

所有 Windows 裝置入口網站 (WDP) 功能都是以 REST API 建置，開發人員可直接呼叫這些 API 來存取資源，並透過程式設計的方式控制其裝置。

應用程式部署

安裝應用程式

要求

您可以使用下列要求格式來安裝 App。

方法	要求 URI
POST	/api/app/packagemanager/package

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
套件	(必要) 所要安裝套件的檔案名稱。

要求標頭

要求本文

.appx 或 .appxbundle 檔案，以及 App 所需的任何相依性。
用來簽署 App 的憑證 (如果裝置是 IoT 或 Windows Desktop)。其他平台並不需要憑證。

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	部署要求已受理並正在處理
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

注意

Windows Mixed Reality 會在一般桌面上執行，因此是與桌面相同的入口網站。

要求

您可以使用下列要求格式來安裝相關集合。

方法	要求 URI
POST	/api/app/packagemanager/package

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
套件	(必要) 要安裝的套件檔案名稱。

要求標頭

要求本文

指定為參數時，將 ".opt" 新增至選用的套件檔案名稱，如下所示："foo.appx.opt" 或 "bar.appxbundle.opt"。
.appx 或 .appxbundle 檔案，以及 App 所需的任何相依性。
用來簽署 App 的憑證 (如果裝置是 IoT 或 Windows Desktop)。其他平台並不需要憑證。

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	部署要求已受理並正在處理
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

登錄鬆散資料夾中的 App

要求

您可以使用下列要求格式登錄鬆散資料夾中的 App。

方法	要求 URI
POST	/api/app/packagemanager/networkapp

URI 參數

要求標頭

要求本文

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

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	部署要求已受理並正在處理
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
Xbox
HoloLens
IoT

要求

您可以使用下列要求格示，在鬆散資料夾中登錄相關集合。

方法	要求 URI
POST	/api/app/packagemanager/networkapp

URI 參數

要求標頭

要求本文

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

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	部署要求已受理並正在處理
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
Xbox
HoloLens
IoT

取得 App 安裝狀態

要求

您可以使用下列要求格式，以取得目前正在進行的 App 安裝狀態。

方法	要求 URI
GET	/api/app/packagemanager/state

URI 參數

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	最後部署的結果
204	正在執行安裝
404	找不到安裝動作

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

解除安裝 App

要求

您可以使用下列要求格式，將 App 解除安裝。

方法	要求 URI
DELETE	/api/app/packagemanager/package

URI 參數

URI 參數	描述
套件	(必要) 目標 App 的 PackageFullName (來自 GET /api/app/packagemanager/packages)

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

取得已安裝的 App

要求

您可以使用下列要求格式，以取得系統上已安裝 App 的清單。

方法	要求 URI
GET	/api/app/packagemanager/packages

URI 參數

要求標頭

要求本文

回應

回應會包含一份已安裝套件與其相關詳細資料的清單。適用於此回應的範本如下所示。

{"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
     },...
     ]
    },...
]}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

藍牙

取得電腦上的藍牙無線電

要求

您可以透過使用下列要求格式，取得已安裝在電腦上的藍牙無線電清單。也可以使用相同的 JSON 資料，升級至 WebSocket 連線。

方法	要求 URI
GET	/api/bt/getradios
GET/WebSocket	/api/bt/getradios

URI 參數

要求標頭

要求本文

回應

此回應包含連結至裝置的藍牙無線電 JSON 陣列。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

開啟或關閉藍牙無線電

要求

將特定藍牙無線電設為開啟或關閉。

方法	要求 URI
POST	/api/bt/setradio

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
識別碼	(必要) 藍牙無線電的裝置識別碼，而且必須是 Base-64 編碼。
州/省	(必要) 這可以是 `"On"` 或 `"Off"`。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

取得配對的藍牙裝置清單

要求

您可以使用以下要求格式，取得目前配對的藍芽裝置清單。可以使用相同的 JSON 資料，升級至 WebSocket 連線。在 WebSocket 連線的存留期內，裝置清單可能會變更。每當有更新時，會透過 WebSocket 連線傳送完整的裝置清單。

方法	要求 URI
GET	/api/bt/getpaired
GET/WebSocket	/api/bt/getpaired

URI 參數

要求標頭

要求本文

回應

回應包含目前配對藍牙裝置的 JSON 陣列。

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

如果裝置可用於此系統上的音訊，則會顯示 [AudioConnectionStatus] 欄位。 (原則與選用元件可能會對此產生影響。)AudioConnectionStatus 將會是 "Connected" 或 "Disconnected"。

取得可用的藍芽裝置清單

要求

您可以使用以下要求格式，取得目前配對的可用藍芽裝置清單。可以使用相同的 JSON 資料，升級至 WebSocket 連線。在 WebSocket 連線的存留期內，裝置清單可能會變更。每當有更新時，會透過 WebSocket 連線傳送完整的裝置清單。

方法	要求 URI
GET	/api/bt/getavailable
GET/WebSocket	/api/bt/getavailable

URI 參數

要求標頭

要求本文

回應

回應包含目前可用於配對之藍牙裝置的 JSON 陣列。

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

連線藍牙裝置

要求

如果裝置可用於此系統上的音訊，將會連線到裝置。 (原則與選用元件可能會對此產生影響。)

方法	要求 URI
POST	/api/bt/connectdevice

URI 參數

URI 參數	描述
識別碼	(必要) 藍牙裝置的「關聯端點識別碼」，而且必須是 Base64 編碼。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

中斷藍牙裝置的連線

要求

如果裝置可用於此系統上的音訊，將會中斷裝置連線。 (原則與選用元件可能會對此產生影響。)

方法	要求 URI
POST	/api/bt/disconnectdevice

URI 參數

URI 參數	描述
識別碼	(必要) 藍牙裝置的「關聯端點識別碼」，而且必須是 Base64 編碼。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

裝置管理員

取得電腦上已安裝的裝置

要求

您可以使用下列要求格式，以取得電腦上已安裝裝置的清單。

方法	要求 URI
GET	/api/devicemanager/devices

URI 參數

要求標頭

要求本文

回應

此回應包含附加至裝置的裝置 JSON 陣列。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
IoT

在連接的 USB 裝置/中樞上取得資料

要求

您可以使用下列要求格式，取得已連接 USB 裝置和中樞的 USB 描述項清單。

方法	要求 URI
GET	/ext/devices/usbdevices

URI 參數

要求標頭

要求本文

回應

回應是 JSON，包括 USB 裝置的 DeviceID 以及中樞的 USB 描述項和連接埠資訊。

{
    "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
        },
        ...
    ]
}

範例傳回資料

{
    "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
    }]
}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

傾印集合

取得 App 的所有損毀傾印清單

要求

您可以使用下列要求格式，以取得所有側載 App 的所有可用損毀傾印清單。

方法	要求 URI
GET	/api/debug/dump/usermode/dumps

URI 參數

要求標頭

要求本文

回應

回應會包含每個側載應用程式的損毀傾印清單。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile (位於 Windows 測試人員計畫中)
Windows 桌面
HoloLens
IoT

取得 App 的損毀傾印集合設定

要求

您可以使用下列要求格式，以取得側載 App 的損毀傾印集合設定。

方法	要求 URI
GET	/api/debug/dump/usermode/crashcontrol

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
packageFullName	(必要) 側載 App 的完整套件名稱。

要求標頭

要求本文

回應

回應具有下列格式。

{"CrashDumpEnabled": bool}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile (位於 Windows 測試人員計畫中)
Windows 桌面
HoloLens
IoT

刪除側載 App 的損毀傾印

要求

您可以使用下列要求格式，以刪除側載 App 的損毀傾印。

方法	要求 URI
DELETE	/api/debug/dump/usermode/crashdump

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
packageFullName	(必要) 側載 App 的完整套件名稱。
fileName	(必要) 應該刪除的傾印檔案名稱。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile (位於 Windows 測試人員計畫中)
Windows 桌面
HoloLens
IoT

停用側載 App 的損毀傾印

要求

您可以使用下列要求格式，以停用側載 App 的損毀傾印。

方法	要求 URI
DELETE	/api/debug/dump/usermode/crashcontrol

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
packageFullName	(必要) 側載 App 的完整套件名稱。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile (位於 Windows 測試人員計畫中)
Windows 桌面
HoloLens
IoT

下載側載 App 的損毀傾印

要求

您可以使用下列要求格式來下載側載應用程式的損毀傾印。

方法	要求 URI
GET	/api/debug/dump/usermode/crashdump

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
packageFullName	(必要) 側載 App 的完整套件名稱。
fileName	(必要) 您所要下載傾印檔案的名稱。

要求標頭

要求本文

回應

回應會包含傾印檔案。您可以使用 WinDbg 或 Visual Studio 檢查傾印檔案。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile (位於 Windows 測試人員計畫中)
Windows 桌面
HoloLens
IoT

啟用側載 App 的損毀傾印

要求

您可以使用下列要求格式，以啟用側載 App 的損毀傾印。

方法	要求 URI
POST	/api/debug/dump/usermode/crashcontrol

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
packageFullName	(必要) 側載 App 的完整套件名稱。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows Mobile (位於 Windows 測試人員計畫中)
Windows 桌面
HoloLens
IoT

取得錯誤檢查檔案的清單

要求

您可以使用下列要求格式，以取得錯誤檢查小型傾印檔案的清單。

方法	要求 URI
GET	/api/debug/dump/kernel/dumplist

URI 參數

要求標頭

要求本文

回應

回應會包含一份傾印檔案名稱和這些檔案大小的清單。此清單將使用下列格式。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows 桌面
IoT

下載錯誤檢查傾印檔案

要求

您可以使用下列要求格式，以下載錯誤檢查傾印檔案。

方法	要求 URI
GET	/api/debug/dump/kernel/dump

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
filename	(必要) 傾印檔案的檔案名稱。您可以使用 API 來取得傾印清單，以找到此項目。

要求標頭

要求本文

回應

回應會包含傾印檔案。您可以使用 WinDbg 來檢查此檔案。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

取得錯誤檢查損毀控制設定

要求

您可以使用下列要求格式，以取得錯誤檢查損毀控制設定。

方法	要求 URI
GET	/api/debug/dump/kernel/crashcontrol

URI 參數

要求標頭

要求本文

回應

回應會包含損毀控制設定。如需有關 CrashControl 的詳細資訊，請參閱 CrashControl 文章。適用於回應的範本如下所示。

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

傾印類型

0：已停用

1：完整記憶體傾印 (收集所有使用中記憶體)

2：核心記憶體傾印 (忽略使用者模式記憶體)

3：有限的核心小型傾印

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

取得即時核心傾印

要求

您可以使用下列要求格式，以取得即時核心傾印。

方法	要求 URI
GET	/api/debug/dump/livekernel

URI 參數

要求標頭

要求本文

回應

回應會包含完整的核心模式傾印。您可以使用 WinDbg 來檢查此檔案。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

取得即時使用者處理序的傾印

要求

您可以使用下列要求格式，以取得即時使用者處理序的傾印。

方法	要求 URI
GET	/api/debug/dump/usermode/live

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
pid	(必要) 您感興趣的處理程序唯一處理程序識別碼。

要求標頭

要求本文

回應

回應會包含處理程序傾印。您可以使用 WinDbg 或 Visual Studio 來檢查此檔案。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

設定錯誤檢查損毀控制設定

要求

您可以使用下列要求格式，以設定要用於收集錯誤檢查資料的設定。

方法	要求 URI
POST	/api/debug/dump/kernel/crashcontrol

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
autoreboot	(選用) True 或 False。這指出系統失敗或遭鎖定之後，是否會自動重新啟動。
dumptype	(選用) 傾印類型。如需支援的值，請參閱 CrashDumpType 列舉。
maxdumpcount	(選用) 要儲存的傾印數目上限。
overwrite	(選用) True 或 False。這指出在達到 maxdumpcount 指定的傾印計數器限制時，是否會覆寫舊的傾印。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

ETW

透過 WebSocket 建立即時 ETW 工作階段

要求

您可以使用下列要求格式，以建立即時 ETW 工作階段。這將會透過 Websocket 進行管理。 ETW 事件會在伺服器上進行批次處理，並每秒傳送至用戶端一次。

方法	要求 URI
GET/WebSocket	/api/etw/session/realtime

URI 參數

要求標頭

要求本文

回應

回應會包含來自已啟用提供者的 ETW 事件。請參閱下方的 ETW WebSocket 命令。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

ETW WebSocket 命令

這些命令會從用戶端傳送至伺服器。

Command	描述
provider {guid} enable {level}	在指定層級啟用標示為 {guid} (不含括號) 的提供者。 {level} 是介於 1 (粗略) 至 5 (詳細) 之間的 int。
provider {guid} disable	停用標示為 {guid} (不含括號) 的提供者。

此回應會從伺服器傳送至用戶端。此回應會傳送為文字，而您可透過剖析 JSON 取得下列格式。

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

承載物件為原始 ETW 事件中提供的額外機碼值組 (字串︰字串)。

範例：

{
    "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"
}

列舉已登錄的 ETW 提供者

要求

您可以使用下列要求格式，列舉已登錄的提供者。

方法	要求 URI
GET	/api/etw/providers

URI 參數

要求標頭

要求本文

回應

回應會包含 ETW 提供者的清單。清單會包含每個提供者的易記名稱與 GUID，且使用下列格式。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

列舉由平台公開的自訂 ETW 提供者。

要求

您可以使用下列要求格式，列舉已登錄的提供者。

方法	要求 URI
GET	/api/etw/customproviders

URI 參數

要求標頭

要求本文

回應

200 確定。回應會包含 ETW 提供者的清單。清單會包含每個提供者的易記名稱與 GUID。

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

狀態碼

標準狀態碼。

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

地點

取得位置覆寫模式

要求

您可以使用下列要求格式，取得裝置的位置堆疊覆寫狀態。開發人員模式必須已開啟，才能讓這個呼叫成功。

方法	要求 URI
GET	/ext/location/override

URI 參數

要求標頭

要求本文

回應

回應包含下列格式的裝置覆寫狀態。

{"Override" : bool}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

設定位置覆寫模式

要求

您可以使用下列要求格式，設定裝置的位置堆疊覆寫狀態。啟用時，位置堆疊允許位置插入。開發人員模式必須已開啟，才能讓這個呼叫成功。

方法	要求 URI
PUT	/ext/location/override

URI 參數

要求標頭

要求本文

{"Override" : bool}

回應

回應包含已用下列格式將裝置設定成的覆寫狀態。

{"Override" : bool}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

取得插入位置

要求

您可以使用下列要求格式，取得裝置的插入 (偽裝) 位置。必須設定插入位置，否則將會擲回錯誤。

方法	要求 URI
GET	/ext/location/position

URI 參數

要求標頭

要求本文

回應

回應包含下列格式的目前插入緯度及經度值。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

設定插入位置

要求

您可以使用下列要求格式，設定裝置的插入 (偽裝) 位置。必須先在裝置上啟用位置覆寫模式，而且設定的位置必須是有效的位置，否則會擲回錯誤。

方法	要求 URI
PUT	/ext/location/override

URI 參數

要求標頭

要求本文

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

回應

回應包含已設定為下列格式的位置。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

OS 資訊

取得電腦名稱

要求

您可以使用下列要求格式，以取得電腦的名稱。

方法	要求 URI
GET	/api/os/machinename

URI 參數

要求標頭

要求本文

回應

回應包含下列格式的電腦名稱。

{"ComputerName": string}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

取得作業系統資訊

要求

您可以使用下列要求格式，以取得電腦的 OS 資訊。

方法	要求 URI
GET	/api/os/info

URI 參數

要求標頭

要求本文

回應

回應包含下列格式的作業系統資訊。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

取得裝置系列

要求

您可以使用下列要求格式取得裝置系列 (Xbox、手機、桌上型電腦等)。

方法	要求 URI
GET	/api/os/devicefamily

URI 參數

要求標頭

要求本文

回應

回應包含裝置系列 (SKU - Desktop、Xbox 等)。

{
   "DeviceType" : string
}

DeviceType 看起來會像 "Windows.Xbox"、"Windows.Desktop" 等。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

設定電腦名稱

要求

您可以使用下列要求格式，以設定電腦的名稱。

方法	要求 URI
POST	/api/os/machinename

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
NAME	(必要) 電腦的新名稱。此應為 base64 編碼。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

使用者資訊

取得使用中使用者

要求

您可以使用下列要求格式，取得裝置上使用中使用者的名稱。

方法	要求 URI
GET	/api/users/activeuser

URI 參數

要求標頭

要求本文

回應

回應包含下列格式的使用者資訊。

成功時：

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

失敗時：

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

效能資料

取得執行中的處理程序清單

要求

您可以使用下列要求格式，以取得目前執行中的處理程序清單。此清單亦可升級至 WebSocket 連線，且每秒會將相同的 JSON 資料推送至用戶端一次。

方法	要求 URI
GET	/api/resourcemanager/processes
GET/WebSocket	/api/resourcemanager/processes

URI 參數

要求標頭

要求本文

回應

回應會包含一份處理程序與每個處理程序詳細資料的清單。此資訊採用 JSON 格式，並具有下列範本。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

取得系統效能統計資料

要求

您可以使用下列要求格式，以取得系統效能統計資料。此類資訊包含讀取和寫入週期以及已使用多少記憶體。

方法	要求 URI
GET	/api/resourcemanager/systemperf
GET/WebSocket	/api/resourcemanager/systemperf

此項目亦可升級至 WebSocket 連線。其每秒會提供一次與下方相同的 JSON 資料。

URI 參數

要求標頭

要求本文

回應

回應會包含系統的效能統計資料，例如 CPU 與 GPU 使用量、記憶體存取以及網路存取。此資訊採用 JSON 格式，並具有下列範本。

{
    "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
    }
}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

Power

取得目前的電池狀態

要求

您可以使用下列要求格式，以取得目前的電池狀態。

方法	要求 URI
GET	/api/power/battery

URI 參數

要求標頭

要求本文

回應

使用以下格式傳回目前的電池狀態資訊。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

取得使用中電源配置

要求

您可以使用下列要求格式，以取得使用中電源配置。

方法	要求 URI
GET	/api/power/activecfg

URI 參數

要求標頭

要求本文

回應

使用中電源配置具有下列格式。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

取得電源配置的子值

要求

您可以使用下列要求格式，以取得電源配置的子值。

方法	要求 URI
GET	/api/power/cfg/<電源配置路徑>

選項：

SCHEME_CURRENT

URI 參數

要求標頭

要求本文

根據每個應用程式與設定提供完整電源狀態清單，以標示諸如電池電力偏低或嚴重不足等各種電力狀態。

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

取得系統的電源狀態

要求

您可以使用下列要求格式，以檢查系統的電源狀態。這可讓您檢查是否處於低電源狀態。

方法	要求 URI
GET	/api/power/state

URI 參數

要求標頭

要求本文

回應

電源狀態資訊具有下列範本。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

設定使用中電源配置

要求

您可以使用下列要求格式，以設定使用中電源配置。

方法	要求 URI
POST	/api/power/activecfg

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
scheme	(必要) 您要為系統設定的使用中電源配置的配置 GUID。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

設定電源配置的子值

要求

您可以使用下列要求格式，以設定電源配置的子值。

方法	要求 URI
POST	/api/power/cfg/<電源配置路徑>

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
valueAC	(必要) 要用於 A/C 電源的值。
valueDC	(必要) 用於電池電源的值。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows 桌面
IoT

取得睡眠研究報告

要求

方法	要求 URI
GET	/api/power/sleepstudy/report

您可以使用下列要求格式，以取得睡眠研究報告。

URI 參數 | URI 參數 | 說明 | | :------ | :------ | | FileName | (必要) 您所要下載檔案的完整名稱。此值應該是 hex64 編碼。 |

要求標頭

要求本文

回應

回應為包含休眠研究的檔案。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

列舉可用的睡眠研究報告

要求

您可以使用下列要求格式，以列舉可用的睡眠研究報告。

方法	要求 URI
GET	/api/power/sleepstudy/reports

URI 參數

要求標頭

要求本文

回應

可用的報告清單具有下列範本。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

取得睡眠研究轉換

要求

您可以使用下列要求格式，以取得睡眠研究轉換。此轉換是 XSLT，其可將睡眠研究報告轉換成人們可以讀取的 XML 格式。

方法	要求 URI
GET	/api/power/sleepstudy/transform

URI 參數

要求標頭

要求本文

回應

回應包含休眠研究轉換。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
IoT

遠端控制

重新啟動目標電腦

要求

您可以使用下列要求格式，以重新啟動目標電腦。

方法	要求 URI
POST	/api/control/restart

URI 參數

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

將目標電腦關機

要求

您可以使用下列要求格式，以將目標電腦關機。

方法	要求 URI
POST	/api/control/shutdown

URI 參數

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

工作管理員

啟動現代化 App

要求

您可以使用下列要求格式，以啟動現代化 App。

方法	要求 URI
POST	/api/taskmanager/app

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
appid	(必要) 您所要啟動 App 的 PRAID。此值應該是 hex64 編碼。
套件	(必要) 您所要啟動應用程式套件的完整名稱。此值應該是 hex64 編碼。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

停止現代化 App

要求

您可以使用下列要求格式，以停止現代化 App。

方法	要求 URI
DELETE	/api/taskmanager/app

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
套件	(必要) 您所要停止應用程式套件的完整名稱。此值應該是 hex64 編碼。
forcestop	(選用) yes 的值表示系統應該強制停止所有處理程序。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

依 PID 終止處理序

要求

您可以使用下列要求格式來終止處理序。

方法	要求 URI
DELETE	/api/taskmanager/process

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
pid	(必要) 要停止的處理序的唯一處理序識別碼。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

網路

取得目前的 IP 設定

要求

您可以使用下列要求格式，以取得目前的 IP 設定。

方法	要求 URI
GET	/api/networking/ipconfig

URI 參數

要求標頭

要求本文

回應

回應包含下列範本中的 IP 設定。

{"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"
            },...
        ]
    },...
]}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

設定靜態 IP 位址 (IPV4 組態)

要求

設定具有靜態 IP 和 DNS 的 IPV4 組態。如果未指定靜態 IP，則會啟用 DHCP。如果已指定靜態 IP，則必須也指定 DNS。

方法	要求 URI
PUT	/api/networking/ipv4config

URI 參數

URI 參數	描述
AdapterName	(必要) 網路介面 GUID。
IPAddress	要設定的靜態 IP 位址。
SubnetMask	(必要如果 IPAddress 不是 null) 靜態子網路遮罩。
DefaultGateway	(必要如果 IPAddress 不是 null) 靜態預設閘道。
PrimaryDNS	(必要如果 IPAddress 不是 null) 要設定的靜態主要 DNS。
SecondayDNS	(必要如果 PrimaryDNS 不是 null) 要設定的靜態次要 DNS。

為了清楚起見，若要將介面設為 DHCP，請將纜線上的 AdapterName 序列化：

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

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

列舉無線網路介面

要求

您可以使用下列要求格式，以列舉可用的無線網路介面。

方法	要求 URI
GET	/api/wifi/interfaces

URI 參數

要求標頭

要求本文

回應

具有詳細資料的可用無線介面清單，使用下列格式。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

列舉無線網路

要求

您可以使用下列要求格式，以列舉指定介面上的無線網路清單。

方法	要求 URI
GET	/api/wifi/networks

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
interface	(必要) 可用來搜尋無線網路的網路介面 GUID，不含括號。

要求標頭

要求本文

回應

可在提供的 interface 上找到的無線網路清單。這包括網路的詳細資料，使用下列格式。

{"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,...]
    },...
]}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

連線到 Wi-Fi 網路和與其中斷連線。

要求

您可以使用下列要求格式，以連線到 Wi-Fi 網路或與其中斷連線。

方法	要求 URI
POST	/api/wifi/network

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
interface	(必要) 可用來連線到網路的網路介面 GUID。
op	(必要) 指出要採取的動作。可能的值是 connect 或 disconnect。
ssid	(如果 op == connect，則為必要) 要連線的 SSID。
key	(如果 op == connect 且網路需要授權，則為必要) 共用金鑰。
createprofile	(必要) 在裝置上建立網路設定檔。這會導致裝置日後會自動連線至網路。此項目可為是或否。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

刪除 Wi-Fi 設定檔

要求

您可以使用下列要求格式，以刪除與特定介面上的網路關聯的設定檔。

方法	要求 URI
DELETE	/api/wifi/profile

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
interface	(必要) 與所要刪除設定檔關聯的網路介面 GUID。
profile	(必要) 要刪除的設定檔名稱。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

Windows 錯誤報告 (WER)

下載 Windows 錯誤報告 (WER) 檔案

要求

您可以使用下列要求格式，以下載 WER 檔案。

方法	要求 URI
GET	/api/wer/report/file

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
使用者	(必要) 與報告關聯的使用者名稱。
type	(必要) 報告的類型。這可以是 queried 或 archived。
NAME	(必要) 報告的名稱。此應為 base64 編碼。
檔案	(必要) 要從報告下載檔案的名稱。此應為 base64 編碼。

要求標頭

要求本文

回應

回應包含所要求的檔案。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

列舉 Windows 錯誤報告 (WER) 報告中的檔案

要求

您可以使用下列要求格式，以列舉 WER 報告中的檔案。

方法	要求 URI
GET	/api/wer/report/files

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
使用者	(必要) 與報告關聯的使用者。
type	(必要) 報告的類型。這可以是 queried 或 archived。
NAME	(必要) 報告的名稱。此應為 base64 編碼。

要求標頭

要求本文

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

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

列出 Windows 錯誤報告 (WER) 報告

要求

您可以使用下列要求格式來取得 WER 報告。

方法	要求 URI
GET	/api/wer/reports

URI 參數

要求標頭

要求本文

回應

WER 報告使用下列格式。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows 桌面
HoloLens
IoT

Windows Performance Recorder (WPR)

使用自訂設定檔開始追蹤

要求

您可以使用下列要求格式，以上傳 WPR 設定檔，並使用該設定檔開始追蹤。一次僅可執行一個追蹤。此設定檔不會保留在裝置上。

方法	要求 URI
POST	/api/wpr/customtrace

URI 參數

要求標頭

要求本文

包含自訂 WPR 設定檔的多部分合格 http 主體。

回應

WPR 工作階段狀態使用下列格式。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

啟動開機效能追蹤工作階段

要求

您可以使用下列要求格式，以啟動開機 WPR 追蹤工作階段。這也稱為效能追蹤工作階段。

方法	要求 URI
POST	/api/wpr/boottrace

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
profile	(必要) 啟動時一定要有此參數。應啟動效能追蹤工作階段設定檔的名稱。可能的設定檔儲存在 perfprofiles/profiles.json 中。

要求標頭

要求本文

回應

啟動時，此 API 會傳回使用下列格式的 WPR 工作階段狀態。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

停止開機效能追蹤工作階段

要求

您可以使用下列要求格式，以停止開機 WPR 追蹤工作階段。這也稱為效能追蹤工作階段。

方法	要求 URI
GET	/api/wpr/boottrace

URI 參數

要求標頭

要求本文

回應

無。 注意：這是長時間執行的作業。其在 ETL 完成寫入至磁碟後才會傳回。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

啟動效能追蹤工作階段

要求

您可以使用下列要求格式，以啟動 WPR 追蹤工作階段。這也稱為效能追蹤工作階段。一次僅可執行一個追蹤。

方法	要求 URI
POST	/api/wpr/trace

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
profile	(必要) 應啟動效能追蹤工作階段的設定檔名稱。可能的設定檔儲存在 perfprofiles/profiles.json 中。

要求標頭

要求本文

回應

啟動時，此 API 會傳回使用下列格式的 WPR 工作階段狀態。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

停止效能追蹤工作階段

要求

您可以使用下列要求格式，以停止 WPR 追蹤工作階段。這也稱為效能追蹤工作階段。

方法	要求 URI
GET	/api/wpr/trace

URI 參數

要求標頭

要求本文

回應

無。 注意：這是長時間執行的作業。其在 ETL 完成寫入至磁碟後才會傳回。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

擷取追蹤工作階段的狀態

要求

您可以使用下列要求格式，以擷取目前的 WPR 工作階段狀態。

方法	要求 URI
GET	/api/wpr/status

URI 參數

要求標頭

要求本文

回應

WPR 追蹤工作階段的狀態，使用下列格式。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

列出已完成的追蹤工作階段 (ETL)

要求

您可以使用下列要求格式取得裝置上 ETL 追蹤的清單。

方法	要求 URI
GET	/api/wpr/tracefiles

URI 參數

要求標頭

要求本文

回應

已完成的追蹤工作階段清單將以下列格式提供。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

下載追蹤工作階段 (ETL)

要求

您可以使用下列要求格式來下載 Tracefile (開機追蹤或使用者模式追蹤)。

方法	要求 URI
GET	/api/wpr/tracefile

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
filename	(必要) 要下載之 ETL 追蹤的名稱。可以在 /api/wpr/tracefiles 找到

要求標頭

要求本文

回應

傳回追蹤 ETL 檔案。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

刪除追蹤工作階段 (ETL)

要求

您可以使用下列要求格式刪除 Tracefile (開機追蹤或使用者模式追蹤)。

方法	要求 URI
DELETE	/api/wpr/tracefile

URI 參數

您可以在要求 URI 上指定下列其他參數：

URI 參數	描述
filename	(必要) 所要刪除 ETL 追蹤的名稱。可以在 /api/wpr/tracefiles 找到

要求標頭

要求本文

回應

傳回追蹤 ETL 檔案。

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
IoT

DNS-SD 標記

檢視標記

要求

檢視裝置目前套用的標記。這些標記會透過 T 索引鍵中的 DNS-SD TXT 公告。

方法	要求 URI
GET	/api/dns-sd/tags

URI 參數

要求標頭

要求本文

回應目前以下列格式套用的標記。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
5XX	伺服器錯誤

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

刪除標記

要求

刪除目前由 DNS-SD 公告的所有標記。

方法	要求 URI
DELETE	/api/dns-sd/tags

URI 參數

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
5XX	伺服器錯誤

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

刪除標記

要求

刪除目前由 DNS-SD 公告的標記。

方法	要求 URI
DELETE	/api/dns-sd/tag

URI 參數

URI 參數	描述
tagValue	(必要) 要移除的標記。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

新增標記

要求

將標記新增到 DNS-SD 廣告。

方法	要求 URI
POST	/api/dns-sd/tag

URI 參數

URI 參數	描述
tagValue	(必要) 要新增的標記。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
401	標記空間溢位。當建議標記對於產生的 DNS-SD 服務記錄過長時的結果。

可用裝置系列

Windows Mobile
Windows 桌面
Xbox
HoloLens
IoT

App 檔案總管

取得已知的資料夾

要求

取得可存取的最上層資料夾清單。

方法	要求 URI
GET	/api/filesystem/apps/knownfolders

URI 參數

要求標頭

要求本文

回應以下列格式呈現的可用資料夾。

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

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	部署要求已受理並正在處理
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
Xbox
IoT

取得檔案

要求

取得資料夾中的檔案清單。

方法	要求 URI
GET	/api/filesystem/apps/files

URI 參數

URI 參數	描述
knownfolderid	(必要) 您希望取得檔案清單的最上層目錄。使用 LocalAppData 存取側載 App。
packagefullname	(*如果 knownfolderid* == LocalAppData**，則為必要) 您感興趣的應用程式套件完整名稱。
path	(選用) 資料夾內的子目錄或上方所指定的套件。

要求標頭

要求本文

回應以下列格式呈現的可用資料夾。

{"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
    },...
]}

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	確定
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
Xbox
IoT

下載檔案

要求

從已知資料夾或 appLocalData 取得檔案。

方法	要求 URI
GET	/api/filesystem/apps/file

URI 參數

URI 參數	描述
knownfolderid	(必要) 您希望下載檔案的最上層目錄。使用 LocalAppData 存取側載 App。
filename	(必要) 要下載檔案的名稱。
packagefullname	(*如果 knownfolderid* == LocalAppData，則為必要**) 您感興趣的套件完整名稱。
path	(選用) 資料夾內的子目錄或上方所指定的套件。

要求標頭

要求本文

要求的檔案 (若有的話)

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	要求的檔案
404	找不到檔案
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
Xbox
IoT

重新命名檔案

要求

重新命名資料夾中的檔案。

方法	要求 URI
POST	/api/filesystem/apps/rename

URI 參數

URI 參數	描述
knownfolderid	(必要) 檔案所在的最上層目錄。使用 LocalAppData 存取側載 App。
filename	(必要) 所要重新命名檔案的原始名稱。
newfilename	(必要) 檔案的新名稱。
packagefullname	(*如果 knownfolderid* == LocalAppData**，則為必要) 您感興趣的應用程式套件完整名稱。
path	(選用) 資料夾內的子目錄或上方所指定的套件。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	OK. 檔案已重新命名
404	找不到檔案
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
Xbox
IoT

刪除檔案

要求

刪除資料夾中的檔案。

方法	要求 URI
DELETE	/api/filesystem/apps/file

URI 參數

URI 參數	描述
knownfolderid	(必要) 您希望刪除檔案的最上層目錄。使用 LocalAppData 存取側載 App。
filename	(必要) 所要刪除檔案的名稱。
packagefullname	(*如果 knownfolderid* == LocalAppData**，則為必要) 您感興趣的應用程式套件完整名稱。
path	(選用) 資料夾內的子目錄或上方所指定的套件。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	OK. 檔案已刪除
404	找不到檔案
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
Xbox
IoT

上傳檔案

要求

將檔案上傳至資料夾。這將會使用相同名稱覆寫現有的檔案，但不會建立新的資料夾。

方法	要求 URI
POST	/api/filesystem/apps/file

URI 參數

URI 參數	描述
knownfolderid	(必要) 您希望上傳檔案的最上層目錄。使用 LocalAppData 存取側載 App。
packagefullname	(*如果 knownfolderid* == LocalAppData**，則為必要) 您感興趣的應用程式套件完整名稱。
extract (擷取)	(必要) True 或 False。這表示是否應該在上傳之後擷取檔案。
path	(選用) 資料夾內的子目錄或上方所指定的套件。

要求標頭

要求本文

回應

狀態碼

此 API 具有下列預期狀態碼。

HTTP 狀態碼	描述
200	OK. 檔案已上傳
4XX	錯誤碼
5XX	錯誤碼

可用裝置系列

Windows Mobile
Windows 桌面
HoloLens
Xbox
IoT

共用方式為

Windows 裝置入口網站核心 REST API 參考資料

應用程式部署

安裝應用程式

安裝相關集合

登錄鬆散資料夾中的 App

在鬆散檔案資料夾中登錄相關集合

取得 App 安裝狀態

解除安裝 App

取得已安裝的 App

藍牙

取得電腦上的藍牙無線電

開啟或關閉藍牙無線電

取得配對的藍牙裝置清單

取得可用的藍芽裝置清單

連線藍牙裝置

中斷藍牙裝置的連線

裝置管理員

取得電腦上已安裝的裝置

在連接的 USB 裝置/中樞上取得資料

傾印集合

取得 App 的所有損毀傾印清單

取得 App 的損毀傾印集合設定

刪除側載 App 的損毀傾印

停用側載 App 的損毀傾印

下載側載 App 的損毀傾印

啟用側載 App 的損毀傾印

取得錯誤檢查檔案的清單

下載錯誤檢查傾印檔案

取得錯誤檢查損毀控制設定

取得即時核心傾印

取得即時使用者處理序的傾印

設定錯誤檢查損毀控制設定

ETW

透過 WebSocket 建立即時 ETW 工作階段

ETW WebSocket 命令

列舉已登錄的 ETW 提供者

列舉由平台公開的自訂 ETW 提供者。

地點

取得位置覆寫模式

設定位置覆寫模式

取得插入位置

設定插入位置

OS 資訊

取得電腦名稱

取得作業系統資訊

取得裝置系列

設定電腦名稱

使用者資訊

取得使用中使用者

效能資料

取得執行中的處理程序清單

取得系統效能統計資料

Power

取得目前的電池狀態

取得使用中電源配置

取得電源配置的子值

取得系統的電源狀態

設定使用中電源配置

設定電源配置的子值

取得睡眠研究報告

列舉可用的睡眠研究報告

取得睡眠研究轉換

遠端控制

重新啟動目標電腦

將目標電腦關機

工作管理員

啟動現代化 App

停止現代化 App

依 PID 終止處理序

網路

取得目前的 IP 設定

設定靜態 IP 位址 (IPV4 組態)

列舉無線網路介面

列舉無線網路

連線到 Wi-Fi 網路和與其中斷連線。

刪除 Wi-Fi 設定檔

Windows 錯誤報告 (WER)

下載 Windows 錯誤報告 (WER) 檔案

列舉 Windows 錯誤報告 (WER) 報告中的檔案