Referência de API REST básica do Portal de Dispositivos do Windows

Artigo
07/13/2023

Toda a funcionalidade do WDP (Portal de Dispositivos do Windows) foi criada com base nas APIs REST, que os desenvolvedores podem chamar diretamente para acessar os recursos e controlar os dispositivos de modo programático.

Implantação de aplicativos

Instalar um aplicativo

Solicitação

Você pode instalar um aplicativo usando o formato de solicitação a seguir.

Método	URI da solicitação
POST	/api/app/packagemanager/package

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
pacote	(necessário) O nome do arquivo do pacote a ser instalado.

Cabeçalhos da solicitação

Não

Corpo da solicitação

O arquivo .appx ou. appxbundle, bem como quaisquer dependências que exigem o aplicativo.
O certificado usado para assinar o aplicativo, se o dispositivo for IoT ou área de trabalho do Windows. Outras plataformas não exigem o certificado.

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	Implantar solicitação aceita e em processamento
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Observação

O Windows Mixed Reality é executado em uma área de trabalho normal. Portanto, ele usa o mesmo portal da Área de Trabalho.

Solicitação

Você pode instalar um conjunto relacionado usando o formato de solicitação a seguir.

Método	URI da solicitação
POST	/api/app/packagemanager/package

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
pacote	(necessário) Os nomes do arquivo dos pacotes a serem instalados.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Adicione ".opt" aos nomes de arquivo de pacote opcional ao especificá-los como parâmetro, da seguinte forma: "foo.appx.opt" ou "bar.appxbundle.opt".
O arquivo .appx ou. appxbundle, bem como quaisquer dependências que exigem o aplicativo.
O certificado usado para assinar o aplicativo, se o dispositivo for IoT ou área de trabalho do Windows. Outras plataformas não exigem o certificado.

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	Implantar solicitação aceita e em processamento
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Registre um aplicativo em uma pasta flexível

Solicitação

Você pode registrar um aplicativo em uma pasta flexível usando o formato de solicitação a seguir.

Método	URI da solicitação
POST	/api/app/packagemanager/networkapp

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

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

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	Implantar solicitação aceita e em processamento
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
Xbox
HoloLens
IoT

Solicitação

Você pode registrar um conjunto relacionado em pastas flexíveis usando o formato de solicitação a seguir.

Método	URI da solicitação
POST	/api/app/packagemanager/networkapp

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

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

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	Implantar solicitação aceita e em processamento
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
Xbox
HoloLens
IoT

Obter o status de instalação do aplicativo

Solicitação

Você pode obter o status de uma instalação de aplicativo que esteja em andamento usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/app/packagemanager/state

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	O resultado da última implantação
204	A instalação está em execução.
404	Nenhuma ação de instalação foi encontrada

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Desinstalar um aplicativo

Solicitação

Você pode desinstalar um aplicativo usando o seguinte formato de solicitação:

Método	URI da solicitação
DELETE	/api/app/packagemanager/package

Parâmetros do URI

Parâmetro do URI	Descrição
pacote	(necessário) O PackageFullName (de GET/api/app/packagemanager/packages) do aplicativo de destino

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Obter aplicativos instalados

Solicitação

Você pode obter uma lista de aplicativos instalados no sistema usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/app/packagemanager/packages

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui uma lista de pacotes instalados com os detalhes associados. O modelo dessa resposta é o seguinte.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Bluetooth

Ouça rádios Bluetooth no computador

Solicitação

Você pode obter uma lista de rádios Bluetooth instalados no computador usando o formato de solicitação a seguir. Isso pode ser atualizado para uma conexão WebSocket também, com os mesmos dados JSON.

Método	URI da solicitação
GET	/api/bt/getradios
GET/WebSocket	/api/bt/getradios

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui uma matriz JSON das rádios Bluetooth conectadas ao dispositivo.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Ativar ou desativar a rádio Bluetooth

Solicitação

Define uma rádio Bluetooth específica como ativada ou desativada.

Método	URI da solicitação
POST	/api/bt/setradio

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
ID	(obrigatório) A ID do dispositivo para rádio Bluetooth e deve ter codificação na base 64.
Estado	(obrigatório) Isso pode ser `"On"` ou `"Off"`.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Obter uma lista de dispositivos Bluetooth emparelhados

Solicitação

Você pode obter uma lista dos dispositivos Bluetooth emparelhados no momento usando o formato de solicitação a seguir. Isso pode ser atualizado para uma conexão WebSocket com os mesmos dados JSON. Durante o tempo de vida da conexão WebSocket, a lista de dispositivos pode ser alterada. Uma lista completa de dispositivos será enviada pela conexão WebSocket toda vez que houver uma atualização.

Método	URI da solicitação
GET	/api/bt/getpaired
GET/WebSocket	/api/bt/getpaired

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui uma matriz JSON de dispositivos Bluetooth que estão emparelhados no momento.

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

O campo AudioConnectionStatus estará presente se o dispositivo puder ser usado para áudio neste sistema. (As políticas e os componentes opcionais podem afetar isso.) AudioConnectionStatus será "Conectado" ou "Desconectado".

Obter uma lista de dispositivos Bluetooth disponíveis

Solicitação

Você pode obter uma lista dos dispositivos Bluetooth disponíveis para emparelhamento usando o formato de solicitação a seguir. Isso pode ser atualizado para uma conexão WebSocket com os mesmos dados JSON. Durante o tempo de vida da conexão WebSocket, a lista de dispositivos pode ser alterada. Uma lista completa de dispositivos será enviada pela conexão WebSocket toda vez que houver uma atualização.

Método	URI da solicitação
GET	/api/bt/getavailable
GET/WebSocket	/api/bt/getavailable

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui uma matriz JSON de dispositivos Bluetooth que estão disponíveis no momento para emparelhamento.

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

Conectar um dispositivo Bluetooth

Solicitação

Fará conexão com o dispositivo se o dispositivo puder ser usado para áudio neste sistema. (As políticas e os componentes opcionais podem afetar isso.)

Método	URI da solicitação
POST	/api/bt/connectdevice

Parâmetros do URI

Parâmetro do URI	Descrição
ID	(obrigatório) A ID do ponto de extremidade de associação para o dispositivo Bluetooth e deve ser codificada em Base64.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Desconectar um dispositivo Bluetooth

Solicitação

Fará desconexão do dispositivo, se o dispositivo puder ser usado para áudio neste sistema. (As políticas e os componentes opcionais podem afetar isso.)

Método	URI da solicitação
POST	/api/bt/disconnectdevice

Parâmetros do URI

Parâmetro do URI	Descrição
ID	(obrigatório) A ID do ponto de extremidade de associação para o dispositivo Bluetooth e deve ser codificada em Base64.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Gerenciador de dispositivos

Obter os dispositivos instalados no computador

Solicitação

Você pode obter uma lista de dispositivos que estão instalados no computador usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/devicemanager/devices

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui uma matriz JSON dos dispositivos conectados ao dispositivo.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
IoT

Obter dados em dispositivos USB/Hubs conectados

Solicitação

Você pode obter uma lista de descritores USB para os dispositivos USB e Hubs conectados usando o formato de solicitação a seguir.

Método	URI da solicitação
GET	/ext/devices/usbdevices

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta é o JSON que inclui DeviceID para o dispositivo USB, juntamente com os descritores de USB e as informações de porta para 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
        },
        ...
    ]
}

Dados de retorno de exemplo

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Coleta de despejo

Obter a lista de todos os despejos de memória para aplicativos

Solicitação

Você pode obter a lista de todos os despejos de memória disponíveis para todos os aplicativos de sideload usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/debug/dump/usermode/dumps

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui uma lista de despejos de memória para cada aplicativo de sideload.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile (no Programa Windows Insider)
Windows Desktop
HoloLens
IoT

Obter configurações da coleta de despejo de memória para um app

Solicitação

Você pode obter as configurações da coleta de despejo de memória para um aplicativo de sideload usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/debug/dump/usermode/crashcontrol

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
packageFullName	(necessário) O nome completo do pacote para o aplicativo de sideload.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta tem o formato a seguir.

{"CrashDumpEnabled": bool}

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile (no Programa Windows Insider)
Windows Desktop
HoloLens
IoT

Excluir um despejo de memória para um app de sideload

Solicitação

Você pode excluir um despejo de memória de um aplicativo de sideload usando o seguinte formato de solicitação:

Método	URI da solicitação
DELETE	/api/debug/dump/usermode/crashdump

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
packageFullName	(necessário) O nome completo do pacote para o aplicativo de sideload.
fileName	(necessário) O nome do arquivo de despejo que deve ser excluído.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile (no Programa Windows Insider)
Windows Desktop
HoloLens
IoT

Desabilitar despejos de memória para um app de sideload

Solicitação

Você pode desabilitar despejos de memória para um aplicativo de sideload usando o seguinte formato de solicitação:

Método	URI da solicitação
DELETE	/api/debug/dump/usermode/crashcontrol

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
packageFullName	(necessário) O nome completo do pacote para o aplicativo de sideload.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile (no Programa Windows Insider)
Windows Desktop
HoloLens
IoT

Baixar o despejo de memória para um app de sideload

Solicitação

Você pode baixar um despejo de memória de um aplicativo de sideload usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/debug/dump/usermode/crashdump

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
packageFullName	(necessário) O nome completo do pacote para o aplicativo de sideload.
fileName	(necessário) O nome do arquivo de despejo que você deseja baixar.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui um arquivo de despejo. Você pode usar o WinDbg ou o Visual Studio para examinar o arquivo de despejo.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile (no Programa Windows Insider)
Windows Desktop
HoloLens
IoT

Habilitar despejos de memória para um app de sideload

Solicitação

Você pode habilitar despejos de memória para um aplicativo de sideload usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/debug/dump/usermode/crashcontrol

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
packageFullName	(necessário) O nome completo do pacote para o aplicativo de sideload.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Mobile (no Programa Windows Insider)
Windows Desktop
HoloLens
IoT

Obter a lista de arquivos de verificação de erro

Solicitação

Você pode obter a lista de arquivos de minidespejo de verificação de erro usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/debug/dump/kernel/dumplist

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui uma lista de nomes de arquivos de despejo e os tamanhos desses arquivos. Essa lista estará no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Baixar um arquivo de despejo de verificação de erro

Solicitação

Você pode baixar um arquivo de despejo de verificação de erro usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/debug/dump/kernel/dump

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
filename	(necessário) O nome do arquivo de despejo de memória. Você pode descobrir isso usando a API para obter a lista de despejo.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui o arquivo de despejo. Você pode inspecionar esse arquivo usando o WinDbg.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Obter as configurações de controle de falhas de verificação de erro

Solicitação

Você pode obter essas configurações de controle de falhas de verificação de erro usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/debug/dump/kernel/crashcontrol

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui as configurações de controle de falhas. Para saber mais sobre CrashControl, consulte o artigo CrashControl. O modelo da resposta é como está a seguir.

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

Tipos de despejo

0: Desabilitado

1: despejo de memória completo (coleta toda a memória em uso)

2: despejo de memória do kernel (ignora a memória do modo de usuário)

3: minidespejo de kernel limitado

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Obter um despejo de kernel dinâmico

Solicitação

Você pode obter um despejo de kernel dinâmico usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/debug/dump/livekernel

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui o despejo no modo kernel completo. Você pode inspecionar esse arquivo usando o WinDbg.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Obter um despejo de um processo de usuário dinâmico

Solicitação

Você pode obter o despejo para o processo de usuário dinâmico usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/debug/dump/usermode/live

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
pid	(necessário) A ID de processo exclusiva do processo no qual você está interessado.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui o despejo do processo. Você pode inspecionar esse arquivo usando o WinDbg ou o Visual Studio.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Definir as configurações de controle de falhas de verificação de erro

Solicitação

Você pode definir as configurações para coletar dados de verificação de erro usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/debug/dump/kernel/crashcontrol

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
autoreboot	(opcional) True ou false. Isso indica se o sistema reinicia automaticamente após alguma falha ou bloqueio.
dumptype	(opcional) O tipo de despejo. Para os valores aceitos, consulte Enumeração de CrashDumpType.
maxdumpcount	(opcional) O número máximo de despejos para salvar.
overwrite	(opcional) True ou false. Isso indica a substituição ou não de despejos antigos quando o limite do contador de despejos especificado pelo maxdumpcount foi atingido.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

ETW

Criar uma sessão ETW em tempo real por um Websocket

Solicitação

Você pode criar uma sessão ETW em tempo real usando o seguinte formato de solicitação: Isso será gerenciado por um Websocket. Os eventos ETW são enviados em lote no servidor e enviados para o cliente uma vez por segundo.

Método	URI da solicitação
GET/WebSocket	/api/etw/session/realtime

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui os eventos ETW de provedores habilitados. Veja comandos do ETW WebSocket a seguir.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Comandos do ETW WebSocket

Esses comandos são enviados do cliente para o servidor.

Comando	Descrição
provider {guid} enable {level}	Habilita o provedor marcado por {guid} (sem colchetes) no nível especificado. {level} é um int de 1 (menos detalhes) a 5 (detalhado).
provider {guid} disable	Desabilita o provedor marcado por {guid} (sem colchetes).

Estas respostas são enviadas do servidor para o cliente. Isso é enviado como texto e você obtém o formato a seguir analisando o JSON.

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

Objetos de carga são pares de chave-valor extras (string:string) fornecidos no evento ETW original.

Exemplo:

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

Enumerar os provedores ETW registrados

Solicitação

Você pode enumerar os provedores registrados usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/etw/providers

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui a lista de provedores ETW. A lista incluirá o nome amigável e o GUID de cada provedor no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Enumere os provedores ETW personalizados expostos pela plataforma.

Solicitação

Você pode enumerar os provedores registrados usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/etw/customproviders

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

200 OK. A resposta inclui a lista de provedores ETW. A lista incluirá o nome amigável e o GUID para cada provedor.

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

Código de status

Códigos de status padrão.

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Local

Obter modo de substituição de localização

Solicitação

Você pode obter o status da substituição de pilha de localização do dispositivo usando o formato de solicitação a seguir. O modo de desenvolvedor deve estar ativado para que esta chamada seja bem-sucedida.

Método	URI da solicitação
GET	/ext/location/override

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui o estado de substituição do dispositivo no formato a seguir.

{"Override" : bool}

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Definir modo de substituição de localização

Solicitação

Você pode definir o status da substituição de pilha de localização do dispositivo usando o formato de solicitação a seguir. Quando habilitada, a pilha de localização permite a injeção de posição. O modo de desenvolvedor deve estar ativado para que esta chamada seja bem-sucedida.

Método	URI da solicitação
PUT	/ext/location/override

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

{"Override" : bool}

Resposta

A resposta inclui o estado de substituição para o qual o dispositivo foi definido no formato a seguir.

{"Override" : bool}

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Obter a posição injetada

Solicitação

Você pode obter a localização injetada (falsificada) do dispositivo usando o formato de solicitação a seguir. Uma localização injetada deve ser definida; caso contrário, um erro será lançado.

Método	URI da solicitação
GET	/ext/location/position

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui os valores atuais de longitude e latitude injetados no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Definir a posição injetada

Solicitação

Você pode definir a localização injetada (falsificada) do dispositivo usando o formato de solicitação a seguir. O modo de substituição de localização deve ser habilitado primeiro no dispositivo e a localização definida deve ser válida, caso contrário, um erro será lançado.

Método	URI da solicitação
PUT	/ext/location/override

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

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

Resposta

A resposta inclui a localização definida no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Informações do sistema operacional

Obter o nome do computador

Solicitação

Você pode obter o nome de um computador usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/os/machinename

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui o nome do computador no formato a seguir.

{"ComputerName": string}

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Obter as informações do sistema operacional

Solicitação

Você pode obter as informações do sistema operacional de um computador usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/os/info

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui as informações do sistema operacional no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Obter a família de dispositivos

Solicitação

Você pode obter a família de dispositivos (Xbox, telefone, área de trabalho etc.) usando o seguinte formato de solicitação.

Método	URI da solicitação
GET	/api/os/devicefamily

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui a família de dispositivos (SKU - Desktop, Xbox etc.).

{
   "DeviceType" : string
}

DeviceType aparecerá como "Windows.Xbox", "Windows.Desktop" etc.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Definir o nome do computador

Solicitação

Você pode definir o nome de um computador usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/os/machinename

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
name	(necessário) O novo nome para o computador. Isso deve ser codificado em base64.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Informações do usuário

Obter o usuário ativo

Solicitação

Você pode obter o nome do usuário ativo no dispositivo usando o formato de solicitação a seguir.

Método	URI da solicitação
GET	/api/users/activeuser

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui as informações do usuário no formato a seguir.

Em caso de êxito:

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

Em caso de falha:

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Dados de desempenho

Obter a lista de processos em execução

Solicitação

Você pode obter a lista de processos atualmente em execução usando o seguinte formato de solicitação: isso pode ser atualizado para uma conexão WebSocket também, com os mesmos dados JSON sendo enviados ao cliente uma vez por segundo.

Método	URI da solicitação
GET	/api/resourcemanager/processes
GET/WebSocket	/api/resourcemanager/processes

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui uma lista de processos com detalhes para cada um deles. As informações estão no formato JSON e têm o modelo a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Obter as estatísticas de desempenho do sistema

Solicitação

Você pode obter as estatísticas de desempenho do sistema usando o seguinte formato de solicitação: Isso inclui informações como ciclos de leitura e gravação e a quantidade de memória que foi usada.

Método	URI da solicitação
GET	/api/resourcemanager/systemperf
GET/WebSocket	/api/resourcemanager/systemperf

Isso também pode ser atualizado para uma conexão WebSocket. Isso fornece os mesmos dados JSON a seguir uma vez por segundo.

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui as estatísticas de desempenho do sistema como CPU e uso de GPU, acesso à memória e acesso à rede. Essas informações estão no formato JSON e têm o modelo a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Energia

Obter o estado atual da bateria

Solicitação

Você pode obter o estado atual da bateria usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/power/battery

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

As informações do estado atual da bateria são retornadas usando o formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Obter o esquema de energia ativo

Solicitação

Você pode obter o esquema de energia ativo usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/power/activecfg

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

O esquema de energia ativo tem o formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Obter o subvalor para um esquema de energia

Solicitação

Você pode obter o subvalor para um esquema de energia usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/power/cfg/<demarcador do esquema de energia>

Opções:

SCHEME_CURRENT

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Uma listagem completa de estados de energia disponíveis por aplicativo e as configurações para sinalizar vários estados de energia como bateria crítica e baixa.

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Obter o estado de energia do sistema

Solicitação

Você pode verificar o estado de energia do sistema usando o seguinte formato de solicitação: Isso permitirá que você verifique se ele está em um estado de baixo consumo de energia.

Método	URI da solicitação
GET	/api/power/state

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

As informações de estado de energia têm o modelo a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Definir o esquema de energia ativo

Solicitação

Você pode definir o esquema de energia ativo usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/power/activecfg

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
scheme	(necessário) O GUID do esquema que você deseja definir como o esquema de energia ativo para o sistema.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Definir o subvalor para um esquema de energia

Solicitação

Você pode definir o subvalor para um esquema de energia usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/power/cfg/<demarcador do esquema de energia>

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
valueAC	(necessário) O valor a ser usado para energia CA.
valueDC	(necessário) O valor a ser usado para energia da bateria.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Obter um relatório de estudo de suspensão

Solicitação

Método	URI da solicitação
GET	/api/power/sleepstudy/report

Você pode obter um relatório de estudo de suspensão usando o seguinte formato de solicitação:

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta é um arquivo que contém o estudo de suspensão.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Enumerar os relatórios de estudo de suspensão disponíveis

Solicitação

Você pode enumerar os relatórios de estudo de suspensão disponíveis usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/power/sleepstudy/reports

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A lista de relatórios disponíveis tem o modelo a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Obter a transformação de estudo de suspensão

Solicitação

Você pode obter o relatório de estudo de suspensão usando o seguinte formato de solicitação: Essa transformação é um XSLT que converte o relatório de estudo de suspensão em um formato XML que possa ser lido por uma pessoa.

Método	URI da solicitação
GET	/api/power/sleepstudy/transform

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta contém a transformação do estudo de suspensão.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
IoT

Controle remoto

Reiniciar o computador de destino

Solicitação

Você pode reiniciar o computador de destino usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/control/restart

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Desligar o computador de destino

Solicitação

Você pode desligar o computador de destino usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/control/shutdown

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Gerenciador de tarefas

Iniciar um aplicativo moderno

Solicitação

Você pode iniciar um aplicativo moderno usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/taskmanager/app

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
appid	(necessário) O PRAID do aplicativo que você deseja iniciar. Esse valor deve ser codificado em hex64.
pacote	(necessário) O nome completo do pacote do aplicativo que você deseja iniciar. Esse valor deve ser codificado em hex64.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Parar um aplicativo moderno

Solicitação

Você pode parar um aplicativo moderno usando o seguinte formato de solicitação:

Método	URI da solicitação
DELETE	/api/taskmanager/app

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
pacote	(necessário) O nome completo dos pacotes do aplicativo que você deseja parar. Esse valor deve ser codificado em hex64.
forcestop	(opcional) Um valor yes indica que o sistema deve forçar todos os processos a parar.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Interromper o processo por PID

Solicitação

Você pode interromper um processo usando o formato de solicitação a seguir.

Método	URI da solicitação
DELETE	/api/taskmanager/process

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
pid	(obrigatório) A ID de processo exclusiva do processo a ser interrompido.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Rede

Obter a configuração de IP atual

Solicitação

Você pode obter a configuração de IP atual usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/networking/ipconfig

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta inclui a configuração de IP no modelo a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Definir um endereço IP estático (configuração de IPV4)

Solicitação

Define a configuração de IPV4 com IP estático e DNS. Se um IP estático não for especificado, ele habilitará o DHCP. Se um IP estático for especificado, o DNS também deverá ser especificado.

Método	URI da solicitação
PUT	/api/networking/ipv4config

Parâmetros do URI

Parâmetro do URI	Descrição
AdapterName	(obrigatório) O GUID do adaptador de rede.
IPAddress	O endereço IP estático a ser definido.
SubnetMask	(obrigatório se IPAddress não for nulo) A máscara de sub-rede estática.
DefaultGateway	(obrigatório se IPAddress não for nulo) O gateway padrão estático.
PrimaryDNS	(obrigatório se IPAddress não for nulo) O DNS primário estático a ser definido.
SecondayDNS	(obrigatório se PrimaryDNS não for nulo) O DNS secundário estático a ser definido.

Para maior clareza, para definir uma interface para DHCP, serialize apenas AdapterName na conexão:

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

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Enumerar as interfaces de rede sem fio

Solicitação

Você pode enumerar as interfaces de rede sem fio disponíveis usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/wifi/interfaces

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Uma lista das interfaces sem fio disponíveis com detalhes no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Enumerar as redes sem fio

Solicitação

Você pode enumerar a lista de redes sem fio na interface especificada usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/wifi/networks

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
interface	(necessário) O GUID da interface de rede a ser usado para procurar redes sem fio, sem colchetes.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A lista de redes sem fio encontradas na interface fornecida. Isso inclui detalhes das redes no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Conectar-se a uma rede Wi-Fi e desconectar-se dela

Solicitação

Você pode se conectar a uma rede Wi-Fi ou se desconectar dela usando o seguinte formato de solicitação:

Método	URI da solicitação
POST	/api/wifi/network

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
interface	(necessário) O GUID da interface de rede que você usa para se conectar à rede.
op	(necessário) Indica a ação a ser executada. Valores possíveis são connect ou disconnect.
ssid	(necessário se op = = connect) O SSID ao qual se conectar.
key	(obrigatório se op = = conectar e rede requer autenticação) A chave compartilhada.
createprofile	(necessário) Crie um perfil de rede no dispositivo. Isso fará o dispositivo se conectar automaticamente à rede no futuro. Isso pode ser sim ou não.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Excluir um perfil de Wi-Fi

Solicitação

Você pode excluir um perfil associado a uma rede em uma interface específica usando o seguinte formato de solicitação:

Método	URI da solicitação
DELETE	/api/wifi/profile

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
interface	(necessário) O GUID da interface de rede associada ao perfil a ser excluído.
perfil	(necessário) O nome do perfil a ser excluído.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Relatório de Erros do Windows (WER)

Baixar um arquivo de relatório de erros do Windows (WER)

Solicitação

Você pode baixar um arquivo relacionado a WER usando o formato de solicitação a seguir:

Método	URI da solicitação
GET	/api/wer/report/file

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
usuário	(necessário) O nome de usuário associado ao relatório.
tipo	(necessário) O tipo de relatório. Pode ser queried ou archived.
name	(necessário) O nome do relatório. Isso deve ser codificado em base64.
arquivo	(necessário) O nome do arquivo a ser baixado do relatório. Isso deve ser codificado em base64.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A resposta contém o arquivo solicitado.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Enumerar arquivos em um relatório de erros do Windows (WER)

Solicitação

Você pode enumerar os arquivos em um relatório WER usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/wer/report/files

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
usuário	(necessário) O usuário associado ao relatório.
tipo	(necessário) O tipo de relatório. Pode ser queried ou archived.
name	(necessário) O nome do relatório. Isso deve ser codificado em base64.

Cabeçalhos da solicitação

Não

Corpo da solicitação

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

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Listar os relatórios WER (Relatório de Erros do Windows)

Solicitação

Você pode obter os relatórios WER usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/wer/reports

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Os relatórios WER no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Desktop
HoloLens
IoT

Windows Performance Recorder (WPR)

Inicie o rastreamento com um perfil personalizado

Solicitação

Você pode carregar um perfil WPR e iniciar o rastreamento com esse perfil usando o seguinte formato de solicitação: Somente um rastreamento pode ser executado por vez. O perfil não permanecerá no dispositivo.

Método	URI da solicitação
POST	/api/wpr/customtrace

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Um corpo http correspondente a várias partes, que contém o perfil WPR personalizado.

Resposta

O status da sessão WPR no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Iniciar uma sessão de rastreamento de desempenho de inicialização

Solicitação

Você pode iniciar uma sessão de rastreamento de WPR de inicialização usando o seguinte formato de solicitação: Isso também é conhecido como uma sessão de rastreamento de desempenho.

Método	URI da solicitação
POST	/api/wpr/boottrace

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
perfil	(necessário) Esse parâmetro é necessário no início. O nome do perfil que deve iniciar uma sessão de rastreamento de desempenho. Os perfis possíveis estão armazenados em perfprofiles/profiles.json.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

No início, essa API retorna o status da sessão WPR no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Parar uma sessão de rastreamento de desempenho de inicialização

Solicitação

Você pode parar uma sessão WPR de rastreamento de inicialização usando o seguinte formato de solicitação: Isso também é conhecido como uma sessão de rastreamento de desempenho.

Método	URI da solicitação
GET	/api/wpr/boottrace

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Nenhum. Observação: é uma operação execução prolongada. Ela retornará quando ETL terminar de gravar em disco.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Iniciar uma sessão de rastreamento de desempenho

Solicitação

Você pode iniciar uma sessão WPR de rastreamento usando o seguinte formato de solicitação: Isso também é conhecido como uma sessão de rastreamento de desempenho. Somente um rastreamento pode ser executado por vez.

Método	URI da solicitação
POST	/api/wpr/trace

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro do URI	Descrição
perfil	(necessário) O nome do perfil que deve iniciar uma sessão de rastreamento de desempenho. Os perfis possíveis estão armazenados em perfprofiles/profiles.json.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

No início, essa API retorna o status da sessão WPR no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Parar uma sessão de rastreamento de desempenho

Solicitação

Você pode parar uma sessão WPR de rastreamento usando o seguinte formato de solicitação: Isso também é conhecido como uma sessão de rastreamento de desempenho.

Método	URI da solicitação
GET	/api/wpr/trace

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Nenhum. Observação: é uma operação execução prolongada. Ela retornará quando ETL terminar de gravar em disco.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Recuperar o status de uma sessão de rastreamento

Solicitação

Você pode recuperar o status da sessão WPR atual usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/wpr/status

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

O status da sessão de rastreamento de WPR no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Listar sessões de rastreamento concluídas (ETLs)

Solicitação

Você pode obter uma lista dos rastreamentos de ETL no dispositivo usando o seguinte formato de solicitação:

Método	URI da solicitação
GET	/api/wpr/tracefiles

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

A listagem de sessões de rastreamento concluídas é fornecida no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Baixar uma sessão de rastreamento (ETL)

Solicitação

Você pode baixar um arquivo de rastreamento (rastreamento de inicialização ou rastreamento de modo de usuário) usando o seguinte formato de solicitação.

Método	URI da solicitação
GET	/api/wpr/tracefile

Parâmetros do URI

Você pode especificar o seguinte parâmetro adicional no URI da solicitação:

Parâmetro do URI	Descrição
filename	(obrigatório) O nome do rastreamento de ETL a ser baixado. Podem ser encontrados em /api/wpr/tracefiles

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Retorna o arquivo de rastreamento ETL.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Excluir uma sessão de rastreamento (ETL)

Solicitação

Você pode excluir um arquivo de rastreamento (rastreamento de inicialização ou rastreamento de modo de usuário) usando o seguinte formato de solicitação.

Método	URI da solicitação
DELETE	/api/wpr/tracefile

Parâmetros do URI

Você pode especificar o seguinte parâmetro adicional no URI da solicitação:

Parâmetro do URI	Descrição
filename	(obrigatório) O nome do rastreamento de ETL a ser excluído. Podem ser encontrados em /api/wpr/tracefiles

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Retorna o arquivo de rastreamento ETL.

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
IoT

Marcas de DNS-SD

Exibir Marcas

Solicitação

Veja as marcas atualmente aplicadas para o dispositivo. Elas são anunciadas por meio de registros DNS-SD TXT na chave T.

Método	URI da solicitação
GET	/api/dns-sd/tags

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta as marcas atualmente aplicadas no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
5XX	Erro do Servidor

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Excluir Marcas

Solicitação

Exclua todas as marcas atualmente anunciadas pelo DNS-SD.

Método	URI da solicitação
DELETE	/api/dns-sd/tags

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Não

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
5XX	Erro do Servidor

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Excluir Marca

Solicitação

Exclua uma marca atualmente anunciada pelo DNS-SD.

Método	URI da solicitação
DELETE	/api/dns-sd/tag

Parâmetros do URI

Parâmetro do URI	Descrição
tagValue	(obrigatório) A marca a ser removida.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Não

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Adicionar uma Marca

Solicitação

Adicione uma marca do anúncio DNS-SD.

Método	URI da solicitação
POST	/api/dns-sd/tag

Parâmetros do URI

Parâmetro do URI	Descrição
tagValue	(obrigatório) A marca a ser adicionada.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Não

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
401	Espaço de marca excedente. Resultado de quando a marca proposta é muito longa para o registro de serviço DNS-SD resultante.

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Aplicativo Explorador de Arquivos

Obter pastas conhecidas

Solicitação

Obtenha uma lista de pastas de nível superior acessíveis.

Método	URI da solicitação
GET	/api/filesystem/apps/knownfolders

Parâmetros do URI

Não

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta As pastas disponíveis no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	Implantar solicitação aceita e em processamento
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Obter arquivos

Solicitação

Obtenha uma lista de arquivos em uma pasta.

Método	URI da solicitação
GET	/api/filesystem/apps/files

Parâmetros do URI

Parâmetro do URI	Descrição
knownfolderid	(obrigatório) O diretório de nível superior onde você deseja a lista de arquivos. Use LocalAppData para acessar aplicativos de sideload.
packagefullname	(*obrigatório se knownfolderid* == LocalAppData**) O nome completo do pacote do aplicativo em que você está interessado.
path	(opcional) O subdiretório dentro da pasta ou do pacote especificados acima.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta As pastas disponíveis no formato a seguir.

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

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Baixar um arquivo

Solicitação

Obtenha um arquivo de uma pasta conhecida ou appLocalData.

Método	URI da solicitação
GET	/api/filesystem/apps/file

Parâmetros do URI

Parâmetro do URI	Descrição
knownfolderid	(obrigatório) O diretório de nível superior onde você deseja baixar arquivos. Use LocalAppData para acessar aplicativos de sideload.
filename	(necessário) O nome do arquivo que está sendo baixado.
packagefullname	(*obrigatório se knownfolderid* == LocalAppData**) O nome completo do pacote em que você está interessado.
path	(opcional) O subdiretório dentro da pasta ou do pacote especificados acima.

Cabeçalhos da solicitação

Não

Corpo da solicitação

O arquivo solicitado, se presente

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	O arquivo solicitado
404	Arquivo não encontrado
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Renomear um arquivo

Solicitação

Renomeie um arquivo em uma pasta.

Método	URI da solicitação
POST	/api/filesystem/apps/rename

Parâmetros do URI

Parâmetro do URI	Descrição
knownfolderid	(necessário) O diretório de nível superior onde o arquivo está localizado. Use LocalAppData para acessar aplicativos de sideload.
filename	(necessário) O nome original do arquivo que está sendo renomeado.
newfilename	(necessário) O novo nome do arquivo.
packagefullname	(*obrigatório se knownfolderid* == LocalAppData**) O nome completo do pacote do aplicativo em que você está interessado.
path	(opcional) O subdiretório dentro da pasta ou do pacote especificados acima.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Não

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK. O arquivo será excluído
404	Arquivo não encontrado
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Excluir um arquivo

Solicitação

Exclua um arquivo em uma pasta.

Método	URI da solicitação
DELETE	/api/filesystem/apps/file

Parâmetros do URI

Parâmetro do URI	Descrição
knownfolderid	(obrigatório) O diretório de nível superior onde você deseja excluir arquivos. Use LocalAppData para acessar aplicativos de sideload.
filename	(necessário) O nome do arquivo que está sendo excluído.
packagefullname	(*obrigatório se knownfolderid* == LocalAppData**) O nome completo do pacote do aplicativo em que você está interessado.
path	(opcional) O subdiretório dentro da pasta ou do pacote especificados acima.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Não

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK. O arquivo será excluído
404	Arquivo não encontrado
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Carregar um arquivo

Solicitação

Carregue um arquivo em uma pasta. Isso sobrescreverá um arquivo existente com o mesmo nome, mas não criará novas pastas.

Método	URI da solicitação
POST	/api/filesystem/apps/file

Parâmetros do URI

Parâmetro do URI	Descrição
knownfolderid	(obrigatório) O diretório de nível superior onde você deseja carregar arquivos. Use LocalAppData para acessar aplicativos de sideload.
packagefullname	(*obrigatório se knownfolderid* == LocalAppData**) O nome completo do pacote do aplicativo em que você está interessado.
extract	(obrigatório) True ou false. Isso indica se o arquivo deve ser extraído após o carregamento.
path	(opcional) O subdiretório dentro da pasta ou do pacote especificados acima.

Cabeçalhos da solicitação

Não

Corpo da solicitação

Não

Resposta

Código de status

Esta API tem os códigos de status esperados a seguir.

Código de status HTTP	Descrição
200	OK. O arquivo é carregado
4XX	Códigos de erro
5XX	Códigos de erro

Famílias de dispositivos disponíveis

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Partilhar via

Referência de API REST básica do Portal de Dispositivos do Windows

Implantação de aplicativos

Instalar um aplicativo

Instalar um conjunto relacionado

Registre um aplicativo em uma pasta flexível

Registrar um conjunto relacionado em pastas de arquivos flexíveis

Obter o status de instalação do aplicativo

Desinstalar um aplicativo

Obter aplicativos instalados

Bluetooth

Ouça rádios Bluetooth no computador

Ativar ou desativar a rádio Bluetooth

Obter uma lista de dispositivos Bluetooth emparelhados

Obter uma lista de dispositivos Bluetooth disponíveis

Conectar um dispositivo Bluetooth

Desconectar um dispositivo Bluetooth

Gerenciador de dispositivos

Obter os dispositivos instalados no computador

Obter dados em dispositivos USB/Hubs conectados

Coleta de despejo

Obter a lista de todos os despejos de memória para aplicativos

Obter configurações da coleta de despejo de memória para um app

Excluir um despejo de memória para um app de sideload

Desabilitar despejos de memória para um app de sideload

Baixar o despejo de memória para um app de sideload

Habilitar despejos de memória para um app de sideload

Obter a lista de arquivos de verificação de erro

Baixar um arquivo de despejo de verificação de erro

Obter as configurações de controle de falhas de verificação de erro

Obter um despejo de kernel dinâmico

Obter um despejo de um processo de usuário dinâmico

Definir as configurações de controle de falhas de verificação de erro

ETW

Criar uma sessão ETW em tempo real por um Websocket

Comandos do ETW WebSocket

Enumerar os provedores ETW registrados

Enumere os provedores ETW personalizados expostos pela plataforma.

Local

Obter modo de substituição de localização

Definir modo de substituição de localização

Obter a posição injetada

Definir a posição injetada

Informações do sistema operacional

Obter o nome do computador

Obter as informações do sistema operacional

Obter a família de dispositivos

Definir o nome do computador

Informações do usuário

Obter o usuário ativo

Dados de desempenho

Obter a lista de processos em execução

Obter as estatísticas de desempenho do sistema

Energia

Obter o estado atual da bateria

Obter o esquema de energia ativo

Obter o subvalor para um esquema de energia

Obter o estado de energia do sistema

Definir o esquema de energia ativo

Definir o subvalor para um esquema de energia

Obter um relatório de estudo de suspensão

Enumerar os relatórios de estudo de suspensão disponíveis

Obter a transformação de estudo de suspensão

Controle remoto

Reiniciar o computador de destino

Desligar o computador de destino

Gerenciador de tarefas

Iniciar um aplicativo moderno

Parar um aplicativo moderno

Interromper o processo por PID

Rede

Obter a configuração de IP atual

Definir um endereço IP estático (configuração de IPV4)

Enumerar as interfaces de rede sem fio

Enumerar as redes sem fio

Conectar-se a uma rede Wi-Fi e desconectar-se dela

Excluir um perfil de Wi-Fi

Relatório de Erros do Windows (WER)

Baixar um arquivo de relatório de erros do Windows (WER)

Enumerar arquivos em um relatório de erros do Windows (WER)