Informations de référence sur les API REST principales de Windows Device Portal

Article
07/13/2023

Toutes les fonctionnalités de Windows Device Portal (WDP) sont basées sur des API REST que les développeurs peuvent appeler directement pour accéder aux ressources et contrôler leurs appareils programmatiquement.

Déploiement des applications

Installer une application

Demande

Vous pouvez installer une application en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/app/packagemanager/package

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
package	(requis) Nom de fichier du package à installer.

En-têtes de demande

Aucune

Corps de demande

Fichier .appx ou .appxbundle, ainsi que toutes les dépendances dont l’application a besoin.
Certificat utilisé pour signer l’application, s’il s’agit d’un appareil IoT ou de bureau Windows. Les autres plateformes n’exigent pas le certificat.

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	Requête de déploiement acceptée et traitée
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Notes

Windows Mixed Reality s’exécute sur un ordinateur de bureau standard : c’est donc le même portail que celui pour les postes de travail.

Demande

Vous pouvez installer un ensemble connexe en utilisant le format de demande suivant.

Méthode	URI de demande
POST	/api/app/packagemanager/package

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
package	(obligatoire) Noms de fichiers des packages à installer.

En-têtes de demande

Aucune

Corps de demande

Ajoutez « .opt » aux noms des fichiers de packages facultatifs lorsque vous les spécifiez en tant que paramètre, comme suit : « foo.appx.opt » ou « bar.appxbundle.opt ».
Fichier .appx ou .appxbundle, ainsi que toutes les dépendances dont l’application a besoin.
Certificat utilisé pour signer l’application, s’il s’agit d’un appareil IoT ou de bureau Windows. Les autres plateformes n’exigent pas le certificat.

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	Requête de déploiement acceptée et traitée
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Inscrire une application dans un dossier isolé

Demande

Vous pouvez inscrire une application dans un dossier isolé en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/app/packagemanager/networkapp

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

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

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	Requête de déploiement acceptée et traitée
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
Xbox
HoloLens
IoT

Demande

Vous pouvez inscrire un ensemble connexe dans des dossiers isolés en utilisant le format de demande suivant.

Méthode	URI de demande
POST	/api/app/packagemanager/networkapp

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

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

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	Requête de déploiement acceptée et traitée
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
Xbox
HoloLens
IoT

Obtenir l’état de l’installation de l’application

Demande

Vous pouvez obtenir l’état d’installation d’une application actuellement en cours d’exécution en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/app/packagemanager/state

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	Le résultat du dernier déploiement
204	L’installation est en cours d’exécution
404	Aucune action d’installation n’a été détectée

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Désinstaller une application

Demande

Vous pouvez désinstaller une application en utilisant le format de requête suivant.

Méthode	URI de demande
DELETE	/api/app/packagemanager/package

Paramètres d’URI

Paramètre d’URI	Description
package	(obligatoire) PackageFullName (à partir de GET /api/app/packagemanager/packages) de l’application cible

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Obtenir des applications installées

Demande

Vous pouvez obtenir une liste des applications installées sur le système en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/app/packagemanager/packages

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend une liste des packages installés avec les détails associés. Le modèle de cette réponse est le suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Bluetooth

Obtenir les radios Bluetooth sur l’ordinateur

Demande

Vous pouvez obtenir la liste des radios Bluetooth installées sur l’ordinateur en utilisant le format de demande suivant. Celle-ci peut être mise à niveau vers une connexion WebSocket, avec les mêmes données JSON.

Méthode	URI de demande
GET	/api/bt/getradios
GET/WebSocket	/api/bt/getradios

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse inclut un tableau JSON des radios Bluetooth connectées à l’appareil.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Activer ou désactiver la radio Bluetooth

Demande

Active ou désactive une radio Bluetooth.

Méthode	URI de demande
POST	/api/bt/setradio

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
ID	(obligatoire) ID d’appareil de la radio Bluetooth ; doit être codé en base 64.
État	(obligatoire) Il peut s’agir de `"On"` ou `"Off"`.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Obtenir la liste des appareils Bluetooth couplés

Demande

Vous pouvez obtenir la liste des appareils Bluetooth couplés en utilisant le format de demande suivant. Celle-ci peut être mise à niveau vers une connexion WebSocket, avec les mêmes données JSON. Pendant la durée de vie de la connexion WebSocket, la liste des appareils peut changer. Une liste complète des appareils est envoyée via la connexion WebSocket à chaque mise à jour.

Méthode	URI de demande
GET	/api/bt/getpaired
GET/WebSocket	/api/bt/getpaired

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend un tableau JSON d’appareils Bluetooth couplés.

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

Le champ AudioConnectionStatus est présent si l’appareil peut être utilisé pour l’audio sur ce système (des stratégies et des composants facultatifs peuvent affecter cela). La valeur d’AudioConnectionStatus est « connecté » ou « déconnecté ».

Obtenir la liste des appareils Bluetooth disponibles

Demande

Vous pouvez obtenir la liste des appareils Bluetooth disponibles pour couplage en utilisant le format de demande suivant. Celle-ci peut être mise à niveau vers une connexion WebSocket, avec les mêmes données JSON. Pendant la durée de vie de la connexion WebSocket, la liste des appareils peut changer. Une liste complète des appareils est envoyée via la connexion WebSocket à chaque mise à jour.

Méthode	URI de demande
GET	/api/bt/getavailable
GET/WebSocket	/api/bt/getavailable

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend un tableau JSON d’appareils Bluetooth actuellement disponibles pour couplage.

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

Connecter un appareil Bluetooth

Demande

Se connectera à l’appareil si celui-ci peut être utilisé pour l’audio sur ce système (des stratégies et des composants facultatifs peuvent affecter cela).

Méthode	URI de demande
POST	/api/bt/connectdevice

Paramètres d’URI

Paramètre d’URI	Description
ID	(obligatoire) ID de point de terminaison d’association pour l’appareil Bluetooth ; doit être encodé en base64.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Déconnecter un appareil Bluetooth

Demande

Se déconnectera de l’appareil si celui-ci peut être utilisé pour l’audio sur ce système (des stratégies et des composants facultatifs peuvent affecter cela).

Méthode	URI de demande
POST	/api/bt/disconnectdevice

Paramètres d’URI

Paramètre d’URI	Description
ID	(obligatoire) ID de point de terminaison d’association pour l’appareil Bluetooth ; doit être encodé en base64.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Gestionnaire de périphériques

Obtenir les périphériques installés sur l’ordinateur

Demande

Vous pouvez obtenir une liste des périphériques installés sur l’ordinateur en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/devicemanager/devices

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse inclut un tableau d’appareils JSON joint à l’appareil.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
IoT

Obtenir des données sur des appareils/hubs USB connectés

Demande

Vous pouvez obtenir la liste des descripteurs USB des hubs et appareils USB connectés en utilisant le format de demande suivant.

Méthode	URI de demande
GET	/ext/devices/usbdevices

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse est un JSON incluant un DeviceID pour l’appareil USB, ainsi que les descripteurs USB et les informations de port pour les hubs.

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

Exemple de données renvoyées

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Collection de vidages

Obtenir la liste de tous les vidages sur incident pour les applications

Demande

Vous pouvez obtenir la liste de tous les vidages sur incident disponibles pour toutes les applications chargées de manière indépendante en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/debug/dump/usermode/dumps

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend une liste des vidages sur incident pour chaque application chargée de manière indépendante.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile (dans le programme Windows Insider)
Bureau Windows
HoloLens
IoT

Obtenir les paramètres de collection de vidage sur incident pour une application

Demande

Vous pouvez obtenir les paramètres de collection de vidage sur incident d’une application chargée de manière indépendante en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/debug/dump/usermode/crashcontrol

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
packageFullName	(requis) Nom complet du package pour l’application chargée de manière indépendante.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse a le format suivant.

{"CrashDumpEnabled": bool}

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile (dans le programme Windows Insider)
Bureau Windows
HoloLens
IoT

Supprimer un vidage sur incident pour une application chargée de manière indépendante

Demande

Vous pouvez supprimer le vidage sur incident d’une application chargée de manière indépendante en utilisant le format de requête suivant.

Méthode	URI de demande
DELETE	/api/debug/dump/usermode/crashdump

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
packageFullName	(requis) Nom complet du package pour l’application chargée de manière indépendante.
fileName	(requis) Nom du fichier de vidage à supprimer.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile (dans le programme Windows Insider)
Bureau Windows
HoloLens
IoT

Désactiver les vidages sur incident pour une application chargée de manière indépendante

Demande

Vous pouvez désactiver les vidages sur incident pour une application chargée de manière indépendante en utilisant le format de requête suivant.

Méthode	URI de demande
DELETE	/api/debug/dump/usermode/crashcontrol

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
packageFullName	(requis) Nom complet du package pour l’application chargée de manière indépendante.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile (dans le programme Windows Insider)
Bureau Windows
HoloLens
IoT

Télécharger le vidage sur incident pour une application chargée de manière indépendante

Demande

Vous pouvez télécharger le vidage sur incident d’une application chargée de manière indépendante en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/debug/dump/usermode/crashdump

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
packageFullName	(requis) Nom complet du package pour l’application chargée de manière indépendante.
fileName	(requis) Nom du fichier de vidage à télécharger.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend un fichier de vidage. Vous pouvez utiliser WinDbg ou Visual Studio pour examiner le fichier de vidage.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile (dans le programme Windows Insider)
Bureau Windows
HoloLens
IoT

Désactiver les vidages sur incident pour une application chargée de manière indépendante

Demande

Vous pouvez activer les vidages sur incident pour une application chargée de manière indépendante en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/debug/dump/usermode/crashcontrol

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
packageFullName	(requis) Nom complet du package pour l’application chargée de manière indépendante.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Windows Mobile (dans le programme Windows Insider)
Bureau Windows
HoloLens
IoT

Obtenir la liste des fichiers de vérification d’erreur

Demande

Vous pouvez obtenir la liste des fichiers minidump de vérification d’erreur en utilisant le format de demande suivant.

Méthode	URI de demande
GET	/api/debug/dump/kernel/dumplist

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend une liste des noms de fichier de vidage et leur taille. Cette liste doit avoir le format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Bureau Windows
IoT

Télécharger un fichier de vidage de vérification d’erreur

Demande

Vous pouvez télécharger un fichier de vidage de vérification d’erreur en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/debug/dump/kernel/dump

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
nom_fichier	(requis) Nom du fichier de vidage. Vous pouvez le rechercher à l’aide de l’API pour obtenir la liste de vidage.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend le fichier de vidage. Vous pouvez examiner ce fichier à l’aide de WinDbg.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir les paramètres de contrôle d’incident de la vérification d’erreur

Demande

Vous pouvez obtenir la liste des paramètres de contrôle d’incident de la vérification d’erreur en utilisant le format de demande suivant.

Méthode	URI de demande
GET	/api/debug/dump/kernel/crashcontrol

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend les paramètres de contrôle d’incident. Pour plus d’informations sur CrashControl, voir l’article CrashControl. Le modèle de la réponse est le suivant.

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

Types de vidage

0 : Désactivé

1 : image mémoire complète (collecte toute la mémoire utilisée)

2 : image mémoire du noyau (ignore la mémoire en mode utilisateur)

3 : minividage limité du noyau

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir un vidage du noyau dynamique

Demande

Vous pouvez obtenir un vidage du noyau dynamique en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/debug/dump/livekernel

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend le vidage en mode noyau complet. Vous pouvez examiner ce fichier à l’aide de WinDbg.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir un vidage à partir d’un processus utilisateur dynamique

Demande

Vous pouvez obtenir le vidage pour le processus utilisateur dynamique en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/debug/dump/usermode/live

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
pid	(requis) Id unique du processus qui vous intéresse.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend le fichier de vidage du processus. Vous pouvez examiner ce fichier à l’aide de WinDbg ou de Visual Studio.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir les paramètres de contrôle d’incident de la vérification d’erreur

Demande

Vous pouvez définir les paramètres de la collecte de données de vérification d’erreur en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/debug/dump/kernel/crashcontrol

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
autoreboot	(facultatif) True ou false. Cette valeur indique si le système redémarre automatiquement suite à un échec ou à un verrouillage.
dumptype	(facultatif) Type de vidage. Pour les valeurs prises en charge, consultez Énumération CrashDumpType.
maxdumpcount	(facultatif) Le nombre maximal de vidages à enregistrer.
overwrite	(facultatif) True ou false. Cela indique s’il convient d’écraser ou non les anciens vidages lorsque le seuil du nombre de vidages défini par maxdumpcount est atteint.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

ETW

Créer une session ETW en temps réel via un websocket

Demande

Vous pouvez créer une session ETW en temps réel en utilisant le format de requête suivant. Cette opération est gérée via un websocket. Les événements ETW sont regroupés sur le serveur et envoyés vers le client une fois par seconde.

Méthode	URI de requête
GET/WebSocket	/api/etw/session/realtime

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend les événements ETW issus des fournisseurs activés. Voir les commandes WebSocket ETW ci-dessous.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Commandes WebSocket ETW

Ces commandes sont envoyées du client vers le serveur.

Commande	Description
provider {guid} enable {level}	Activez le fournisseur marqué par {guid} (sans crochets) au niveau spécifié. {level} est un entier int de 1 (peu détaillé) à 5 (très détaillé).
provider {guid} disable	Désactivez le fournisseur marqué par {guid} (sans crochets).

Cette réponse est envoyée du serveur vers le client. Elle est envoyée sous forme de texte et vous obtenez le format suivant en analysant le JSON.

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

Les objets de charge utile sont des paires clé-valeur supplémentaires (chaîne:chaîne) qui sont fournies dans l’événement ETW d’origine.

Exemple :

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

Énumérer les fournisseurs ETW enregistrés

Demande

Vous pouvez énumérer les fournisseurs enregistrés en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/etw/providers

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend la liste des fournisseurs ETW. La liste comprend le nom convivial et le GUID de chaque fournisseur au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Énumérez les fournisseurs ETW personnalisés exposés par la plate-forme.

Demande

Vous pouvez énumérer les fournisseurs enregistrés en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/etw/customproviders

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

200 OK. La réponse comprend la liste des fournisseurs ETW. La liste comprend le nom convivial et le GUID de chaque fournisseur.

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

Code d’état

Codes d’état standard.

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Emplacement

Obtenir le mode remplacement de l’emplacement

Demande

Vous pouvez obtenir l’état de remplacement de la pile d’emplacements de l’appareil en utilisant le format de demande suivant. Le mode développeur doit être activé pour que cet appel aboutisse.

Méthode	URI de demande
GET	/ext/location/override

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse inclut l’état de remplacement de l’appareil au format suivant.

{"Override" : bool}

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Définir le mode remplacement de l’emplacement

Demande

Vous pouvez définir l’état de remplacement de la pile d’emplacements de l’appareil en utilisant le format de demande suivant. Lorsqu’elle est activée, la pile d’emplacements permet l’injection de position. Le mode développeur doit être activé pour que cet appel aboutisse.

Méthode	URI de requête
PUT	/ext/location/override

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

{"Override" : bool}

Réponse

La réponse inclut l’état de remplacement sur lequel l’appareil a été défini, au format suivant.

{"Override" : bool}

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Obtenir la position injectée

Demande

Vous pouvez obtenir l’emplacement injecté (falsifié) de l’appareil en utilisant le format de demande suivant. Un emplacement injecté doit être défini, ou une erreur est levée.

Méthode	URI de demande
GET	/ext/location/position

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend les valeurs de longitude et de latitude actuelles injectées au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Définir la position injectée

Demande

Vous pouvez définir l’emplacement injecté (falsifié) de l’appareil en utilisant le format de demande suivant. Le mode de remplacement de l’emplacement doit tout d’abord être activé sur l’appareil et l’emplacement défini doit être un emplacement valide, sans quoi une erreur est levée.

Méthode	URI de requête
PUT	/ext/location/override

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

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

Réponse

La réponse inclut l’emplacement qui a été défini au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Informations sur le système d’exploitation

Obtenir le nom de l’ordinateur

Demande

Vous pouvez obtenir le nom d’un ordinateur en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/os/machinename

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse inclut le nom de l’ordinateur au format suivant.

{"ComputerName": string}

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Obtenir les informations du système d’exploitation

Demande

Vous pouvez obtenir les informations du système d’exploitation pour un ordinateur en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/os/info

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse inclut des informations sur le système d’exploitation au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Obtenir la famille d’appareils

Demande

Vous pouvez obtenir la famille d’appareils (Xbox, téléphone, ordinateur de bureau, etc.) en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/os/devicefamily

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend la famille d’appareils (référence : ordinateur de bureau, Xbox, etc.).

{
   "DeviceType" : string
}

DeviceType aura pour valeur une chaîne du type « Windows.Xbox », « Windows.Desktop », etc.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Obtenir le nom de l’ordinateur

Demande

Vous pouvez définir le nom d’un ordinateur en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/os/machinename

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
name	(requis) Nouveau nom de l’ordinateur. Doit être codé en base64.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Informations utilisateur

Obtenir l’utilisateur actif

Demande

Vous pouvez obtenir le nom de l’utilisateur actif en utilisant le format de demande suivant.

Méthode	URI de demande
GET	/api/users/activeuser

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse inclut des informations sur l’utilisateur au format suivant.

En cas de succès :

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

En cas d’échec :

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Données relatives aux performances

Obtenir la liste des processus en cours d’exécution

Demande

Vous pouvez obtenir la liste des processus en cours d’exécution en utilisant le format de requête suivant. Il peut également être mis à niveau vers une connexion WebSocket, avec les mêmes données JSON transmises au client une fois par seconde.

Méthode	URI de demande
GET	/api/resourcemanager/processes
GET/WebSocket	/api/resourcemanager/processes

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend une liste des processus et les détails associés. Les informations sont au format JSON et suivent le modèle suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Obtenir les statistiques des performances du système

Demande

Vous pouvez obtenir les statistiques des performances du système en utilisant le format de requête suivant. Cela comprend des informations relatives aux cycles de lecture et d’écriture, par exemple, et la quantité de mémoire utilisée.

Méthode	URI de demande
GET	/api/resourcemanager/systemperf
GET/WebSocket	/api/resourcemanager/systemperf

Ce format peut être mis à niveau vers une connexion WebSocket. Il fournit les mêmes données JSON ci-dessous une fois toutes les secondes.

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse comprend les statistiques relatives aux performances du système, notamment sur l’utilisation du processeur et du GPU, ainsi que sur l’accès à la mémoire et au réseau. Ces informations sont au format JSON et suivent le modèle suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Avancé

Obtenir l’état actuel de la batterie

Demande

Vous pouvez obtenir l’état actuel de la batterie en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/power/battery

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Les informations d’état actuel de la batterie sont renvoyées à l’aide du format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Obtenir le schéma d’alimentation actif

Demande

Vous pouvez obtenir le schéma d’alimentation actif en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/power/activecfg

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Le schéma d’alimentation actif a le format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir la sous-valeur pour un schéma d’alimentation

Demande

Vous pouvez obtenir la sous-valeur pour un schéma d’alimentation actif en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/power/cfg/<power scheme path>

Options :

SCHEME_CURRENT

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Liste complète des états d’alimentation disponibles déterminée par application et paramètres de marquage des différents états d’alimentation comme le niveau faible ou critique de la batterie.

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir l’état d’alimentation du système

Demande

Vous pouvez obtenir l’état d’alimentation du système en utilisant le format de requête suivant. Cela vous permet de vérifier s’il se trouve en mode de faible consommation d’énergie.

Méthode	URI de demande
GET	/api/power/state

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Les informations sur l’état d’alimentation suivent le modèle suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Définir le schéma d’alimentation actif

Demande

Vous pouvez définir le schéma d’alimentation actif en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/power/activecfg

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
scheme	(requis) GUID du schéma que vous voulez définir en tant que schéma d’alimentation actif pour le système.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir la sous-valeur pour un schéma d’alimentation

Demande

Vous pouvez obtenir la sous-valeur pour un schéma d’alimentation en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/power/cfg/<power scheme path>

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
valueAC	(requis) Valeur à utiliser pour l’alimentation secteur.
valueDC	(requis) Valeur à utiliser pour l’alimentation de la batterie.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir un rapport d’étude sur la suspension d’activité

Demande

Méthode	URI de demande
GET	/api/power/sleepstudy/report

Vous pouvez obtenir un rapport d’étude sur la suspension d’activité en utilisant le format de requête suivant.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse est un fichier contenant l’étude de veille.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Énumérer les rapports d’étude sur la suspension d’activité disponibles

Demande

Vous pouvez obtenir les rapports d’étude sur la suspension d’activité disponibles en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/power/sleepstudy/reports

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La liste des rapports disponibles suit le modèle suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Obtenir la transformation de l’étude sur la suspension d’activité

Demande

Vous pouvez obtenir la transformation de l’étude sur la suspension d’activité en utilisant le format de requête suivant. Il s’agit d’une XSLT qui convertit le rapport d’étude sur la suspension d’activité en un format XML pouvant être lu par une personne.

Méthode	URI de demande
GET	/api/power/sleepstudy/transform

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse contient la transformation de l’étude de veille.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
IoT

Contrôle à distance

Redémarrer l’ordinateur cible.

Demande

Vous pouvez redémarrer l’ordinateur cible en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/control/restart

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Arrêter l’ordinateur cible

Demande

Vous pouvez éteindre l’ordinateur cible en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/control/shutdown

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Gestionnaire des tâches

Démarrer une application moderne

Demande

Vous pouvez démarrer une application moderne en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/taskmanager/app

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
appid	(requis) PRAID de l’application que vous voulez démarrer. Cette valeur doit être codée en hex64.
package	(requis)Nom complet du package d’application que vous voulez démarrer. Cette valeur doit être codée en hex64.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Arrêter une application moderne

Demande

Vous pouvez arrêter une application moderne en utilisant le format de requête suivant.

Méthode	URI de demande
DELETE	/api/taskmanager/app

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
package	(requis) Nom complet du package d’application que vous voulez arrêter. Cette valeur doit être codée en hex64.
forcestop	(facultatif) La valeur yes indique que le système doit forcer tous les processus à s’arrêter.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Arrêter le processus par PID

Demande

Vous pouvez arrêter un processus en utilisant le format de demande suivant.

Méthode	URI de demande
DELETE	/api/taskmanager/process

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
pid	(obligatoire) ID unique du processus à arrêter.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Mise en réseau

Obtenir la configuration IP actuelle

Demande

Vous pouvez obtenir la configuration IP actuelle en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/networking/ipconfig

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse inclut la configuration IP dans le modèle suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Définir une adresse IP statique (configuration IPV4)

Demande

Définit la configuration IPV4 avec une adresse IP statique et un DNS. Si aucune adresse IP statique n’est spécifiée, active le protocole DHCP. Si une adresse IP statique est spécifiée, le DNS doit également être spécifié.

Méthode	URI de requête
PUT	/api/networking/ipv4config

Paramètres d’URI

Paramètre d’URI	Description
AdapterName	(obligatoire) GUID de l’interface réseau.
AdresseIP	Adresse IP statique à définir.
SubnetMask	(obligatoire si IPAddress n’a pas la valeur null) Masque de sous-réseau statique.
DefaultGateway	(obligatoire si IPAddress n’a pas la valeur null) Passerelle par défaut statique.
PrimaryDNS	(obligatoire si IPAddress n’a pas la valeur null) DNS principal statique à définir.
SecondayDNS	(obligatoire si PrimaryDNS n’a pas la valeur null) DNS secondaire statique à définir.

Pour plus de clarté, pour définir une interface sur DHCP, sérialisez uniquement AdapterName sur le réseau :

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

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Énumérer les interfaces réseau sans fil

Demande

Vous pouvez énumérer les interfaces sans fil disponibles en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/wifi/interfaces

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Liste des interfaces sans fil disponibles et leurs détails au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Énumérer les réseaux sans fil

Demande

Vous pouvez énumérer la liste des réseaux sans fil disponibles sur l’interface spécifiée en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/wifi/networks

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
interface	(requis) GUID de l’interface réseau à utiliser pour rechercher des réseaux sans fil, sans crochets.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Liste des réseaux sans fil détectés sur l’interface fournie. Cela comprend les détails pour les réseaux au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Se connecter à un réseau Wi-Fi et se déconnecter

Demande

Vous pouvez vous connecter à un réseau Wi-Fi ou vous déconnecter en utilisant le format de requête suivant.

Méthode	URI de demande
POST	/api/wifi/network

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
interface	(requis) GUID de l’interface réseau à utiliser pour se connecter au réseau.
op	(requis) Indique l’action à entreprendre. Les valeurs possibles sont connect ou disconnect.
ssid	(obligatoire si op == connect) SSID auquel se connecter.
key	(obligatoire si op == connect et le réseau exige une authentification) Clé partagée.
createprofile	(requis) Créez un profil pour le réseau sur l’appareil. Cela obligera l’appareil à se connecter automatiquement au réseau à l’avenir. Cela peut être yes ou no.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Supprimer un profil Wi-Fi

Demande

Vous pouvez supprimer un profil associé à un réseau sur une interface spécifique en utilisant le format de requête suivant.

Méthode	URI de demande
DELETE	/api/wifi/profile

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
interface	(requis) GUID de l’interface réseau associée au profil à supprimer.
profile	(requis) Nom du profil à supprimer.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Rapport d’erreurs Windows

Télécharger un fichier de rapport d’erreurs Windows

Demande

Vous pouvez télécharger un fichier associé à un rapport d’erreurs Windows en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/wer/report/file

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
utilisateur	(requis) Nom d’utilisateur associé au rapport.
type	(requis) Type de rapport. Il peut s’agir du type queried ou archived.
name	(requis) Nom du rapport. Doit être codé en base64.
fichier	(requis) Nom du fichier à télécharger à partir du rapport. Doit être codé en base64.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La réponse contient le fichier demandé.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Énumérer les fichiers dans un rapport d’erreurs Windows

Demande

Vous pouvez énumérer les fichiers dans un rapport d’erreurs Windows en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/wer/report/files

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
utilisateur	(requis) Utilisateur associé au rapport.
type	(requis) Type de rapport. Il peut s’agir du type queried ou archived.
name	(requis) Nom du rapport. Doit être codé en base64.

En-têtes de demande

Aucune

Corps de demande

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

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Répertorier les rapports d’erreurs Windows

Demande

Vous pouvez obtenir les rapports d’erreurs Windows en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/wer/reports

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Les rapports d’erreur suivants sont présentés au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Bureau Windows
HoloLens
IoT

Enregistreur de performance Windows (WPR)

Démarrer le suivi avec un profil personnalisé

Demande

Vous pouvez charger un profil WPR et démarrer le suivi à l’aide de ce profil en utilisant le format de requête suivant. Une seule trace peut s’exécuter à la fois. Le profil ne restera pas sur l’appareil.

Méthode	URI de demande
POST	/api/wpr/customtrace

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Corps HTTP à parties multiples conforme contenant le profil WPR personnalisé.

Réponse

L’état de session WPR au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Démarrer une session de suivi des performances de démarrage

Demande

Vous pouvez démarrer une session de suivi WPR en utilisant le format de requête suivant. Également connue sous le nom de session de suivi des performances.

Méthode	URI de demande
POST	/api/wpr/boottrace

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
profile	(requis) Ce paramètre est requis au démarrage. Nom du profil devant démarrer une session de suivi des performances. Les profils possibles sont stockés dans perfprofiles/profiles.json.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Au démarrage, cette API renvoie l’état de session WPR au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Arrêter une session de suivi des performances de démarrage

Demande

Vous pouvez arrêter une session de suivi WPR en utilisant le format de requête suivant. Également connue sous le nom de session de suivi des performances.

Méthode	URI de demande
GET	/api/wpr/boottrace

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Aucune. Remarque : il s’agit d’une opération longue. Elle renverra une réponse à la fin de l’écriture de l’ETL sur le disque.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Démarrer une session de suivi des performances

Demande

Vous pouvez démarrer une session de suivi WPR en utilisant le format de requête suivant. Également connue sous le nom de session de suivi des performances. Une seule trace peut s’exécuter à la fois.

Méthode	URI de demande
POST	/api/wpr/trace

Paramètres d’URI

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :

Paramètre d’URI	Description
profile	(requis) Nom du profil devant démarrer une session de suivi des performances. Les profils possibles sont stockés dans perfprofiles/profiles.json.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Au démarrage, cette API renvoie l’état de session WPR au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Arrêter une session de suivi des performances

Demande

Vous pouvez arrêter une session de suivi WPR en utilisant le format de requête suivant. Également connue sous le nom de session de suivi des performances.

Méthode	URI de demande
GET	/api/wpr/trace

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Aucune. Remarque : il s’agit d’une opération longue. Elle renverra une réponse à la fin de l’écriture de l’ETL sur le disque.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Récupérer l’état d’une session de suivi

Demande

Vous pouvez récupérer l’état de la session WPR actuelle en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/wpr/status

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

L’état de la session de suivi WPR au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Répertorier les sessions de suivi terminées (ETL)

Demande

Vous pouvez obtenir une liste des traces ETL sur l’appareil en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/wpr/tracefiles

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

La liste des sessions de suivi terminées est fournie dans le format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Télécharger une session de suivi (ETL)

Demande

Vous pouvez télécharger un fichier de suivi (suivi de démarrage ou suivi en mode utilisateur) en utilisant le format de requête suivant.

Méthode	URI de demande
GET	/api/wpr/tracefile

Paramètres d’URI

Vous pouvez spécifier le paramètre supplémentaire suivant dans l’URI de requête :

Paramètre d’URI	Description
nom_fichier	(requis) Nom de la trace ETL à télécharger. Les traces ETL se trouvent dans /api/wpr/tracefiles.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Renvoie le fichier ETL de suivi.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Supprimer une session de suivi (ETL)

Demande

Vous pouvez supprimer un fichier de suivi (suivi de démarrage ou suivi en mode utilisateur) en utilisant le format de requête suivant.

Méthode	URI de demande
DELETE	/api/wpr/tracefile

Paramètres d’URI

Vous pouvez spécifier le paramètre supplémentaire suivant dans l’URI de requête :

Paramètre d’URI	Description
nom_fichier	(requis) Nom de la trace ETL à supprimer. Les traces ETL se trouvent dans /api/wpr/tracefiles.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Renvoie le fichier ETL de suivi.

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
IoT

Balises DNS-SD

Afficher les balises

Demande

Affichez les balises actuellement appliquées pour l’appareil. Ces balises sont annoncées par le biais d’enregistrements DNS-SD TXT dans la clé T.

Méthode	URI de demande
GET	/api/dns-sd/tags

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse Balises actuellement appliquées au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
5XX	Erreur de serveur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Supprimer des balises

Demande

Supprimez toutes les balises actuellement signalées par DNS-SD.

Méthode	URI de demande
DELETE	/api/dns-sd/tags

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Aucune

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
5XX	Erreur de serveur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Supprimer une balise

Demande

Supprimez une balise actuellement signalée par DNS-SD.

Méthode	URI de demande
DELETE	/api/dns-sd/tag

Paramètres d’URI

Paramètre d’URI	Description
tagValue	(requis) Balise à supprimer.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Aucune

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Ajouter une balise

Demande

Ajoutez une balise à l’annonce DNS-SD.

Méthode	URI de demande
POST	/api/dns-sd/tag

Paramètres d’URI

Paramètre d’URI	Description
tagValue	(requis) Balise à ajouter.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Aucune

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
401	Dépassement de capacité pour l’espace de balise. Survient lorsque la balise proposée est trop longue pour l’enregistrement de service DNS-SD résultant.

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
Xbox
HoloLens
IoT

Explorateur de fichiers de l’application

Obtenir les dossiers connus

Demande

Obtenez la liste des dossiers de niveau supérieur accessibles.

Méthode	URI de demande
GET	/api/filesystem/apps/knownfolders

Paramètres d’URI

Aucune

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse Dossiers disponibles au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	Requête de déploiement acceptée et traitée
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
Xbox
IoT

Obtenir des fichiers

Demande

Obtenez la liste des fichiers d’un dossier.

Méthode	URI de demande
GET	/api/filesystem/apps/files

Paramètres d’URI

Paramètre d’URI	Description
knownfolderid	(requis) Répertoire de niveau supérieur dans lequel vous voulez faire apparaître la liste des fichiers. Utilisez LocalAppData pour accéder aux applications avec chargement indépendant.
packagefullname	(*obligatoire si knownfolderid* == LocalAppData**) Nom complet du package de l’application qui vous intéresse.
path	(facultatif) Sous-répertoire du dossier ou du package spécifié ci-dessus.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse Dossiers disponibles au format suivant.

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

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
Xbox
IoT

Télécharger un fichier

Demande

Obtenir un fichier à partir d’un dossier connu ou d’appLocalData.

Méthode	URI de demande
GET	/api/filesystem/apps/file

Paramètres d’URI

Paramètre d’URI	Description
knownfolderid	(requis) Répertoire de niveau supérieur dans lequel vous voulez télécharger les fichiers. Utilisez LocalAppData pour accéder aux applications avec chargement indépendant.
nom_fichier	(requis) Nom du fichier en cours de téléchargement.
packagefullname	(*obligatoire si knownfolderid* == LocalAppData**) Nom complet du package qui vous intéresse.
path	(facultatif) Sous-répertoire du dossier ou du package spécifié ci-dessus.

En-têtes de demande

Aucune

Corps de demande

Fichier demandé, le cas échéant

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	Fichier demandé
404	Fichier introuvable
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
Xbox
IoT

Renommer un fichier

Demande

Renommez un fichier dans un dossier.

Méthode	URI de demande
POST	/api/filesystem/apps/rename

Paramètres d’URI

Paramètre d’URI	Description
knownfolderid	(obligatoire) Répertoire de niveau supérieur dans lequel se trouve le fichier. Utilisez LocalAppData pour accéder aux applications avec chargement indépendant.
nom_fichier	(obligatoire) Nom d’origine du fichier renommé.
newfilename	(obligatoire) Nouveau nom du fichier.
packagefullname	(*obligatoire si knownfolderid* == LocalAppData**) Nom complet du package de l’application qui vous intéresse.
path	(facultatif) Sous-répertoire du dossier ou du package spécifié ci-dessus.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Aucune

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK. Le fichier est renommé
404	Fichier introuvable
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
Xbox
IoT

Supprimer un fichier

Demande

Supprimez un fichier dans un dossier.

Méthode	URI de demande
DELETE	/api/filesystem/apps/file

Paramètres d’URI

Paramètre d’URI	Description
knownfolderid	(requis) Répertoire de niveau supérieur dans lequel vous voulez supprimer des fichiers. Utilisez LocalAppData pour accéder aux applications avec chargement indépendant.
nom_fichier	(requis) Nom du fichier en cours de suppression.
packagefullname	(*obligatoire si knownfolderid* == LocalAppData**) Nom complet du package de l’application qui vous intéresse.
path	(facultatif) Sous-répertoire du dossier ou du package spécifié ci-dessus.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Aucune

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK. Le fichier est supprimé.
404	Fichier introuvable
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
Xbox
IoT

Charger un fichier

Demande

Chargez un fichier dans un dossier. Ce fichier remplace un fichier existant du même nom, mais ne crée pas de dossier.

Méthode	URI de demande
POST	/api/filesystem/apps/file

Paramètres d’URI

Paramètre d’URI	Description
knownfolderid	(requis) Répertoire de niveau supérieur dans lequel vous voulez charger les fichiers. Utilisez LocalAppData pour accéder aux applications avec chargement indépendant.
packagefullname	(*obligatoire si knownfolderid* == LocalAppData**) Nom complet du package de l’application qui vous intéresse.
extract	(obligatoire) True ou false. Cela indique si le fichier doit être extrait après avoir été chargé.
path	(facultatif) Sous-répertoire du dossier ou du package spécifié ci-dessus.

En-têtes de demande

Aucune

Corps de demande

Aucune

Réponse

Code d’état

Cette API comporte les codes d’état attendus suivants.

Code d’état HTTP	Description
200	OK. Le fichier est chargé
4XX	Codes d’erreur
5XX	Codes d’erreur

Familles d’appareils disponibles

Windows Mobile
Bureau Windows
HoloLens
Xbox
IoT

Partager via

Informations de référence sur les API REST principales de Windows Device Portal

Déploiement des applications

Installer une application

Installer un ensemble connexe

Inscrire une application dans un dossier isolé

Inscrire un ensemble connexe dans des dossiers de fichiers isolés

Obtenir l’état de l’installation de l’application

Désinstaller une application

Obtenir des applications installées

Bluetooth

Obtenir les radios Bluetooth sur l’ordinateur

Activer ou désactiver la radio Bluetooth

Obtenir la liste des appareils Bluetooth couplés

Obtenir la liste des appareils Bluetooth disponibles

Connecter un appareil Bluetooth

Déconnecter un appareil Bluetooth

Gestionnaire de périphériques

Obtenir les périphériques installés sur l’ordinateur

Obtenir des données sur des appareils/hubs USB connectés

Collection de vidages

Obtenir la liste de tous les vidages sur incident pour les applications

Obtenir les paramètres de collection de vidage sur incident pour une application

Supprimer un vidage sur incident pour une application chargée de manière indépendante

Désactiver les vidages sur incident pour une application chargée de manière indépendante

Télécharger le vidage sur incident pour une application chargée de manière indépendante

Désactiver les vidages sur incident pour une application chargée de manière indépendante

Obtenir la liste des fichiers de vérification d’erreur

Télécharger un fichier de vidage de vérification d’erreur

Obtenir les paramètres de contrôle d’incident de la vérification d’erreur

Obtenir un vidage du noyau dynamique

Obtenir un vidage à partir d’un processus utilisateur dynamique

Obtenir les paramètres de contrôle d’incident de la vérification d’erreur

ETW

Créer une session ETW en temps réel via un websocket

Commandes WebSocket ETW

Énumérer les fournisseurs ETW enregistrés

Énumérez les fournisseurs ETW personnalisés exposés par la plate-forme.

Emplacement

Obtenir le mode remplacement de l’emplacement

Définir le mode remplacement de l’emplacement

Obtenir la position injectée

Définir la position injectée

Informations sur le système d’exploitation

Obtenir le nom de l’ordinateur

Obtenir les informations du système d’exploitation

Obtenir la famille d’appareils

Obtenir le nom de l’ordinateur

Informations utilisateur

Obtenir l’utilisateur actif

Données relatives aux performances

Obtenir la liste des processus en cours d’exécution

Obtenir les statistiques des performances du système

Avancé

Obtenir l’état actuel de la batterie

Obtenir le schéma d’alimentation actif

Obtenir la sous-valeur pour un schéma d’alimentation

Obtenir l’état d’alimentation du système

Définir le schéma d’alimentation actif

Obtenir la sous-valeur pour un schéma d’alimentation

Obtenir un rapport d’étude sur la suspension d’activité

Énumérer les rapports d’étude sur la suspension d’activité disponibles

Obtenir la transformation de l’étude sur la suspension d’activité

Contrôle à distance

Redémarrer l’ordinateur cible.

Arrêter l’ordinateur cible

Gestionnaire des tâches

Démarrer une application moderne

Arrêter une application moderne

Arrêter le processus par PID

Mise en réseau

Obtenir la configuration IP actuelle

Définir une adresse IP statique (configuration IPV4)

Énumérer les interfaces réseau sans fil

Énumérer les réseaux sans fil

Se connecter à un réseau Wi-Fi et se déconnecter

Supprimer un profil Wi-Fi

Rapport d’erreurs Windows

Télécharger un fichier de rapport d’erreurs Windows

Énumérer les fichiers dans un rapport d’erreurs Windows