Windows Device Portal 코어 REST API 참조

아티클
07/05/2024

모든 WDP(Windows Device Portal)의 기능은 개발자가 직접 액세스 리소스를 호출하고 디바이스를 프로그래밍 방식으로 컨트롤할 수 있는 REST API를 기반으로 구축되어 있습니다.

앱 배포

앱 설치하기

요청

다음의 요청 형식을 사용하여 앱을 설치할 수 있습니다.

메서드	요청 URI
게시	/api/app/packagemanager/package

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
패키지	(필수) 설치할 패키지의 파일 이름입니다.

요청 헤더

없음

요청 본문

앱에는 종속성뿐만 아니라 .appx 또는 .appxbundle 파일도 필요합니다.
디바이스가 IoT 또는 Windows 데스크톱인 경우, 인증서는 앱에 서명하는 데 사용됩니다. 다른 플랫폼은 인증서를 요구하지 않습니다.

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	수락되어 처리 중인 요청 배포하기
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

참고

Windows Mixed Reality는 일반 데스크톱에서 실행되므로 데스크톱과 동일한 포털입니다.

요청

관련 세트를 다음의 요청 형식을 사용하여 설치할 수 있습니다.

메서드	요청 URI
게시	/api/app/packagemanager/package

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
패키지	(필수) 설치할 패키지의 파일 이름입니다.

요청 헤더

없음

요청 본문

"foo.appx.opt" 또는 "bar.appxbundle.opt" 같은 매개 변수로 지정하는 경우, 선택적 패키지 파일 이름에 ".opt"를 추가합니다.
앱에는 종속성뿐만 아니라 .appx 또는 .appxbundle 파일도 필요합니다.
디바이스가 IoT 또는 Windows 데스크톱인 경우, 인증서는 앱에 서명하는 데 사용됩니다. 다른 플랫폼은 인증서를 요구하지 않습니다.

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	수락되어 처리 중인 요청 배포하기
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

느슨한 폴더에 앱 등록하기

요청

느슨한 폴더에 다음의 요청 형식을 사용하여 앱을 등록할 수 있습니다.

메서드	요청 URI
게시	/api/app/packagemanager/networkapp

URI 매개 변수

없음

요청 헤더

없음

요청 본문

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

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	수락되어 처리 중인 요청 배포하기
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
Xbox
HoloLens
IoT

요청

느슨한 폴더에 관련 세트를 등록할 때 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
게시	/api/app/packagemanager/networkapp

URI 매개 변수

없음

요청 헤더

없음

요청 본문

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

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	수락되어 처리 중인 요청 배포하기
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
Xbox
HoloLens
IoT

앱 설치 상태 가져오기

요청

현재 진행 중인 앱 설치의 상태를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/app/packagemanager/state

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	마지막 배포의 결과
204	설치 실행 중
404	설치 작업을 찾을 수 없음

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

앱 제거하기

요청

앱을 제거하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
DELETE	/api/app/packagemanager/package

URI 매개 변수

URI 매개 변수	설명
패키지	(필수) 대상 앱의 PackageFullName(GET /api/app/packagemanager/packages에서 사용)

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

설치된 앱 가져오기

요청

시스템에 설치된 앱 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/app/packagemanager/packages

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

관련된 세부 정보가 있는 설치된 패키지 목록이 응답에 포함됩니다. 다음은 이 응답에 대한 템플릿입니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Bluetooth

머신의 Bluetooth 송수신 장치 가져오기

요청

머신에 설치된 Bluetooth 송수신 장치 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다. WebSocket 연결로 업그레이드하기 위해 동일한 JSON 데이터를 사용할 수 있습니다.

메서드	요청 URI
GET	/api/bt/getradios
GET/WebSocket	/api/bt/getradios

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

디바이스에 연결된 Bluetooth 송수신 장치 JSON 배열이 응답에 포함됩니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

Bluetooth 송수신 장치 켜기 또는 끄기

요청

특정 Bluetooth 송수신 장치를 On 또는 Off로 설정합니다.

메서드	요청 URI
게시	/api/bt/setradio

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
ID	(필수) Bluetooth 송수신 장치의 디바이스 ID이며 Base 64로 인코딩되어야 합니다.
상태	(필수) 이는 `"On"` 또는 `"Off"`일 수 있습니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

페어링된 Bluetooth 디바이스 목록 가져오기

요청

현재 페어링된 Bluetooth 디바이스 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다. WebSocket 연결로 업그레이드하기 위해 동일한 JSON 데이터를 사용할 수 있습니다. 디바이스 목록은 WebSocket 연결의 수명 주기 동안 변경될 수 있습니다. 전체 디바이스 목록은 업데이트가 있을 때마다 WebSocket 연결을 통해 전송됩니다.

메서드	요청 URI
GET	/api/bt/getpaired
GET/WebSocket	/api/bt/getpaired

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

현재 페어링된 Bluetooth 디바이스의 JSON 배열이 응답에 포함됩니다.

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

디바이스를 이 시스템의 오디오에 사용할 수 있는 경우 AudioConnectionStatus 필드가 표시됩니다. (이는 정책 및 선택적 구성 요소에 따라 달라질 수 있습니다.) AudioConnectionStatus는 "Connected"이거나 "Disconnected"입니다.

사용 가능한 Bluetooth 디바이스 목록 가져오기

요청

페어링에 사용 가능한 Bluetooth 디바이스 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다. WebSocket 연결로 업그레이드하기 위해 동일한 JSON 데이터를 사용할 수 있습니다. 디바이스 목록은 WebSocket 연결의 수명 주기 동안 변경될 수 있습니다. 전체 디바이스 목록은 업데이트가 있을 때마다 WebSocket 연결을 통해 전송됩니다.

메서드	요청 URI
GET	/api/bt/getavailable
GET/WebSocket	/api/bt/getavailable

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

현재 페어링에 사용 가능한 Bluetooth 디바이스의 JSON 배열이 응답에 포함됩니다.

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

Bluetooth 디바이스 연결하기

요청

이 시스템의 오디오에 디바이스를 사용할 수 있으면 디바이스에 연결합니다. (이는 정책 및 선택적 구성 요소에 따라 달라질 수 있습니다.)

메서드	요청 URI
게시	/api/bt/connectdevice

URI 매개 변수

URI 매개 변수	설명
ID	(필수) Bluetooth 디바이스의 연결 엔드포인트 ID이며 Base64로 인코딩해야 합니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

Bluetooth 디바이스 연결 해제하기

요청

이 시스템의 오디오에 디바이스를 사용할 수 있으면 디바이스를 연결 해제합니다. (이는 정책 및 선택적 구성 요소에 따라 달라질 수 있습니다.)

메서드	요청 URI
게시	/api/bt/disconnectdevice

URI 매개 변수

URI 매개 변수	설명
ID	(필수) Bluetooth 디바이스의 연결 엔드포인트 ID이며 Base64로 인코딩해야 합니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

디바이스 관리자

머신에 설치된 디바이스 가져오기

요청

컴퓨터에 설치된 디바이스 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/devicemanager/devices

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

디바이스에 연결된 디바이스 JSON 배열이 응답에 포함됩니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
IoT

연결된 USB 디바이스/허브의 데이터 가져오기

요청

연결된 USB 디바이스 및 허브에 대한 USB 설명자 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/ext/devices/usbdevices

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

응답은 USB 디바이스의 DeviceID, USB 설명자, 허브 포트 정보를 포함하는 JSON입니다.

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

샘플 반환 데이터

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	OK
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

덤프 수집

앱에 대한 모든 크래시 덤프 목록 가져오기

요청

사이드로드된 모든 앱에 대한 사용 가능한 모든 크래시 덤프 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/debug/dump/usermode/dumps

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

사이드로드된 각 애플리케이션의 크래시 덤프 목록이 응답에 포함됩니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile (Windows Insider Program 내)
Windows Desktop
HoloLens
IoT

앱에 대한 크래시 덤프 수집 설정 가져오기

요청

사이드로드된 앱의 크래시 덤프 수집 설정을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/debug/dump/usermode/crashcontrol

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
packageFullName	(필수) 사이드로드된 앱 패키지의 전체 이름입니다.

요청 헤더

없음

요청 본문

없음

응답

응답은 다음의 형식을 따릅니다.

{"CrashDumpEnabled": bool}

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile (Windows Insider Program 내)
Windows Desktop
HoloLens
IoT

사이드로드된 앱의 크래시 덤프 삭제하기

요청

사이드로드된 앱의 크래시 덤프를 삭제하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
DELETE	/api/debug/dump/usermode/crashdump

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
packageFullName	(필수) 사이드로드된 앱 패키지의 전체 이름입니다.
fileName	(필수) 삭제해야 하는 덤프 파일의 이름입니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile (Windows Insider Program 내)
Windows Desktop
HoloLens
IoT

사이드로드된 앱의 크래시 덤프를 사용하지 않음

요청

사이드로드된 앱의 크래시 덤프를 사용하지 않도록 설정하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
DELETE	/api/debug/dump/usermode/crashcontrol

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
packageFullName	(필수) 사이드로드된 앱 패키지의 전체 이름입니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile (Windows Insider Program 내)
Windows Desktop
HoloLens
IoT

사이드로드된 앱의 크래시 덤프 다운로드하기

요청

사이드로드된 앱의 크래시 덤프를 다운로드하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/debug/dump/usermode/crashdump

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
packageFullName	(필수) 사이드로드된 앱 패키지의 전체 이름입니다.
fileName	(필수) 다운로드하려는 덤프 파일의 이름입니다.

요청 헤더

없음

요청 본문

없음

응답

응답은 덤프 파일을 포함합니다. 덤프 파일을 검사하기 위해 WinDbg 또는 Visual Studio를 사용할 수 있습니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile (Windows Insider Program 내)
Windows Desktop
HoloLens
IoT

사이드로드된 앱의 크래시 덤프 사용하기

요청

사이드로드된 앱의 크래시 덤프를 사용하도록 설정하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
POST	/api/debug/dump/usermode/crashcontrol

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
packageFullName	(필수) 사이드로드된 앱 패키지의 전체 이름입니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Mobile (Windows Insider Program 내)
Windows Desktop
HoloLens
IoT

버그 검사 파일 목록 가져오기

요청

버그 검사 미니 덤프 파일 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/debug/dump/kernel/dumplist

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

덤프 파일의 이름 및 크기 목록이 응답에 포함됩니다. 이 목록은 다음의 형식을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

버그 검사 덤프 파일 다운로드하기

요청

버그 검사 덤프 파일을 다운로드하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/debug/dump/kernel/dump

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
filename	(필수) 덤프 파일의 파일 이름입니다. 이 파일을 찾기 위해 API를 사용하여 덤프 목록을 가져올 수 있습니다.

요청 헤더

없음

요청 본문

없음

응답

응답에는 덤프 파일이 포함됩니다. 이 파일을 검사하기 위해 WinDbg를 사용할 수 있습니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

버그 검사 크래시 제어 설정 가져오기

요청

버그 검사 크래시 제어 설정을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/debug/dump/kernel/crashcontrol

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

응답은 크래시 제어 설정을 포함합니다. CrashControl에 대한 자세한 정보는 CrashControl 문서를 참조하세요. 다음은 응답에 대한 템플릿입니다.

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

덤프 형식

0: 사용 안 함

1: 전체 메모리 덤프(사용 중 메모리 모두 수집)

2: 커널 메모리 덤프(사용자 모드 메모리 무시)

3: 제한된 커널 미니덤프

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

라이브 커널 덤프 가져오기

요청

라이브 커널 덤프를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/debug/dump/livekernel

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

전체 커널 모드 덤프가 응답에 포함됩니다. 이 파일을 검사하기 위해 WinDbg를 사용할 수 있습니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

라이브 사용자 프로세스에서 덤프 가져오기

요청

라이브 사용자 프로세스 덤프를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/debug/dump/usermode/live

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
pid	(필수) 관심 있는 프로세스의 고유 프로세스 ID입니다.

요청 헤더

없음

요청 본문

없음

응답

응답은 프로세스 덤프를 포함합니다. 이 파일을 검사하기 위해 WinDbg 또는 Visual Studio를 사용할 수 있습니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

버그 검사 크래시 제어 설정 지정하기

요청

버그 검사 데이터를 수집하기 위한 설정을 지정하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
게시	/api/debug/dump/kernel/crashcontrol

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
autoreboot	(선택적) True 또는 false입니다. 이는 시스템이 실패하거나 잠긴 뒤 자동으로 다시 시작되는지 여부를 나타냅니다.
dumptype	(선택적) 덤프 형식입니다. 지원되는 값에 대한 정보는 CrashDumpType 열거형을 참조하세요.
maxdumpcount	(선택적) 저장할 최대 덤프 수입니다.
overwrite	(선택적) True 또는 false입니다. 이는 maxdumpcount에 의해 지정된 덤프 카운터 한도에 도달했을 때 이전 덤프를 덮어쓸지 여부를 나타냅니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

ETW

Websocket을 통해 실시간 ETW 세션 만들기

요청

실시간 ETW 세션을 만들기 위해 다음의 요청 형식을 사용할 수 있습니다. 이 세션은 Websocket을 통해 관리됩니다. ETW 이벤트는 서버에서 일괄 처리되며 1초에 한 번씩 클라이언트로 전송됩니다.

메서드	요청 URI
GET/WebSocket	/api/etw/session/realtime

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

활성화된 공급자의 ETW 이벤트가 응답에 포함됩니다. 아래의 ETW WebSocket 명령을 참조하세요.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

ETW WebSocket 명령

이러한 명령은 클라이언트에서 서버로 전송됩니다.

명령	설명
공급자 {guid}가 {level}을 사용하도록 설정합니다.	지정된 수준에서 {guid}(괄호 없음)로 표시된 공급자를 사용하도록 설정합니다. 여기서 {level}은 1(가장 대략적인 정보)부터 5(자세한 정보)까지의 int입니다.
공급자 {guid} 사용 안 함	{guid}(괄호 없음)로 표시된 공급자를 사용하지 않도록 설정합니다.

이 응답은 서버에서 클라이언트로 전송됩니다. 이는 텍스트로 전송되며 JSON을 구문 분석하여 다음의 형식을 가져옵니다.

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

페이로드 개체는 원래 ETW 이벤트에서 제공되는 추가 키-값 쌍(string:string)입니다.

예시:

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

등록된 ETW 공급자 열거하기

요청

등록된 공급자를 열거하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/etw/providers

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

ETW 공급자 목록이 응답에 포함됩니다. 각 공급자의 이름과 GUID는 다음의 형식으로 목록에 포함됩니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

플랫폼에 의해 노출된 사용자 지정 ETW 공급자를 열거합니다.

요청

등록된 공급자를 열거하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/etw/customproviders

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

200 OK. ETW 공급자 목록이 응답에 포함됩니다. 각 공급자의 식별 이름 및 GUID가 목록에 포함됩니다.

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

상태 코드

표준 상태 코드입니다.

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

위치

위치 재정의 모드 가져오기

요청

디바이스의 위치 스택 재정의 상태를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다. 개발자 모드가 켜져 있어야 이 호출이 성공할 수 있습니다.

메서드	요청 URI
GET	/ext/location/override

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

다음과 같은 형식의 디바이스 재정의 상태가 응답에 포함됩니다.

{"Override" : bool}

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

위치 재정의 모드 설정하기

요청

디바이스의 위치 스택 재정의 상태를 설정하기 위해 다음의 요청 형식을 사용할 수 있습니다. 활성화되면, 위치 스택은 위치 삽입을 허용합니다. 개발자 모드가 켜져 있어야 이 호출이 성공할 수 있습니다.

메서드	요청 URI
PUT	/ext/location/override

URI 매개 변수

없음

요청 헤더

없음

요청 본문

{"Override" : bool}

응답

다음과 같은 형식으로 설정된 디바이스의 재정의 상태가 응답에 포함됩니다.

{"Override" : bool}

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

삽입 위치 가져오기

요청

디바이스의 삽입(스푸핑) 위치를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다. 삽입 위치를 설정해야 하며, 설정하지 않으면 오류가 발생합니다.

메서드	요청 URI
GET	/ext/location/position

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

다음과 같은 형식으로 삽입된 현재의 위도 및 경도 값이 응답에 포함됩니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

삽입 위치 설정하기

요청

디바이스의 삽입(스푸핑) 위치를 설정하기 위해 다음의 요청 형식을 사용할 수 있습니다. 먼저 디바이스에서 위치 재정의 모드를 활성화해야 하며, 설정 위치는 유효한 위치여야 합니다. 그렇지 않으면 오류가 발생합니다.

메서드	요청 URI
PUT	/ext/location/override

URI 매개 변수

없음

요청 헤더

없음

요청 본문

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

응답

다음과 같은 형식으로 설정된 위치가 응답에 포함됩니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

OS 정보

컴퓨터 이름 가져오기

요청

컴퓨터의 이름을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/os/machinename

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

다음과 같은 형식의 컴퓨터 이름이 응답에 포함됩니다.

{"ComputerName": string}

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

운영 체제 정보 가져오기

요청

컴퓨터의 OS 정보를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/os/info

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

다음과 같은 형식의 OS 정보가 응답에 포함됩니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

디바이스 패밀리 가져오기

요청

디바이스 패밀리(Xbox, 휴대폰, 데스크톱 등)를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/os/devicefamily

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

디바이스 패밀리(SKU - 데스크톱, Xbox 등)가 응답에 포함됩니다.

{
   "DeviceType" : string
}

DeviceType은 "Windows.Xbox", "Windows.Desktop" 등과 같이 표시됩니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

컴퓨터 이름 설정하기

요청

컴퓨터의 이름을 설정하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
게시	/api/os/machinename

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
이름	(필수) 컴퓨터의 새 이름입니다. base64로 인코딩되어야 합니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

사용자 정보

활성 사용자 가져오기

요청

디바이스의 현재 사용자 이름을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/users/activeuser

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

다음과 같은 형식의 사용자 정보가 응답에 포함됩니다.

성공 시:

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

실패 시:

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

성능 데이터

실행 중인 프로세스 목록 가져오기

요청

현재 실행 중인 프로세스의 목록을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다. 또한 WebSocket 연결로 업그레이드될 수 있으며, 초당 한 번씩 동일한 JSON 데이터가 클라이언트에 푸시됩니다.

메서드	요청 URI
GET	/api/resourcemanager/processes
GET/WebSocket	/api/resourcemanager/processes

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

각 프로세스에 대한 세부 정보가 있는 프로세스의 목록이 응답에 포함됩니다. 정보는 JSON 형식이며 다음과 같은 템플릿이 있습니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

시스템 성능 통계 가져오기

요청

시스템 성능 통계를 가져오기 위해 다음과 같은 요청 형식을 사용할 수 있습니다. 이는 읽기 및 쓰기 주기와 사용된 메모리 양과 같은 정보를 포함합니다.

메서드	요청 URI
GET	/api/resourcemanager/systemperf
GET/WebSocket	/api/resourcemanager/systemperf

또한 WebSocket 연결로 업그레이드될 수 있습니다. 아래와 동일한 JSON 데이터를 1초에 한 번씩 제공합니다.

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

CPU 및 GPU 사용량, 메모리 액세스 및 네트워크 액세스와 같은 시스템에 대한 성능 통계가 응답에 포함됩니다. 이 정보는 JSON 형식이며 다음과 같은 템플릿이 있습니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Power

현재 배터리 상태 가져오기

요청

배터리의 현재 상태를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/power/battery

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

현재 배터리 상태 정보를 다음의 형식을 사용하여 반환합니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

활성 전원 구성표 가져오기

요청

현재 전원 구성표를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/power/activecfg

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

활성 전원 구성표는 다음과 같은 형식을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

전원 구성표에 대한 하위 값 가져오기

요청

전원 구성표에 대한 하위 값을 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/power/cfg/<전원 구성표 경로>

옵션:

SCHEME_CURRENT

URI 매개 변수

없음

요청 헤더

없음

요청 본문

사용할 수 있는 전원 상태의 전체 목록은 애플리케이션을 기반으로 하며 낮거나 위험한 배터리 수준과 같은 다양한 전원 상태의 플래그를 지정하기 위한 설정입니다.

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

시스템의 전원 상태 가져오기

요청

시스템의 전원 상태를 확인하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다. 이를 통해 시스템이 절전 상태인지 확인할 수 있습니다.

메서드	요청 URI
GET	/api/power/state

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

전원 상태 정보는 다음과 같은 템플릿을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

활성 전원 구성표 설정하기

요청

현재 전원 구성표를 설정하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
게시	/api/power/activecfg

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
구성표	(필수) 시스템의 활성 전원 구성표로 설정하려는 구성표의 GUID입니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

전원 구성표의 하위 값 설정하기

요청

전원 구성표에 대한 하위 값을 설정하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
게시	/api/power/cfg/<전원 구성표 경로>

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
valueAC	(필수) A/C 전원에 사용할 값입니다.
valueDC	(필수) 배터리 전원에 사용할 값입니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

절전 연구 보고서 가져오기

요청

메서드	요청 URI
GET	/api/power/sleepstudy/report

절전 연구 보고서를 가져오기 위해 다음의 요청 형식을 사용할 수 있습니다.

URI 매개 변수 | URI 매개 변수 | 설명 | | :------ | :------ | | FileName | (필수) 다운로드하려는 파일의 전체 이름입니다. 이 값은 hex64로 인코딩되어야 합니다. |

요청 헤더

없음

요청 본문

없음

응답

응답은 절전 연구를 포함하는 파일입니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

사용 가능한 절전 연구 보고서 열거

요청

사용 가능한 절전 연구 보고서를 열거하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/power/sleepstudy/reports

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

사용 가능한 보고서의 목록은 다음과 같은 템플릿을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

절전 연구 변환 가져오기

요청

절전 연구 변환을 가져오기 위해 다음과 같은 요청 형식을 사용할 수 있습니다. 이 변환은 절전 연구 보고서를 사람이 읽을 수 있는 XML 형식으로 변환하는 XSLT입니다.

메서드	요청 URI
GET	/api/power/sleepstudy/transform

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

절전 연구 변환이 응답에 포함됩니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
IoT

원격 제어

대상 컴퓨터를 다시 시작합니다.

요청

대상 컴퓨터를 다시 시작하기 위해 다음의 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
게시	/api/control/restart

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

대상 컴퓨터 종료하기

요청

대상 컴퓨터를 종료하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
게시	/api/control/shutdown

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

작업 관리자

PID를 사용하여 프로세스 중단하기

요청

프로세스를 중단하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
DELETE	/api/taskmanager/process

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
pid	(필수) 중단할 프로세스의 고유한 프로세스 ID입니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

네트워킹

현재 IP 구성 가져오기

요청

현재의 IP 구성을 가져오기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/networking/ipconfig

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

다음과 같은 템플릿의 IP 구성이 응답에 포함됩니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

고정 IP 주소 설정하기(IPV4 구성)

요청

고정 IP 및 DNS를 사용하여 IPV4 구성을 설정합니다. 고정 IP를 지정하지 않으면 DHCP가 사용됩니다. 고정 IP가 지정되면, DNS도 지정되어야 합니다.

메서드	요청 URI
PUT	/api/networking/ipv4config

URI 매개 변수

URI 매개 변수	설명
AdapterName	(필수) 네트워크 인터페이스 GUID입니다.
IPAddress	설정할 고정 IP 주소입니다.
SubnetMask	(필수 IPAddress가 null이 아닌 경우의) 정적 서브넷 마스크입니다.
DefaultGateway	(필수 IPAddress가 null이 아닌 경우의) 정적 기본 게이트웨이입니다.
PrimaryDNS	(필수 IPAddress가 null이 아닌 경우) 설정할 기본 DNS입니다.
SecondayDNS	(필수 PrimaryDNS가 null이 아닌 경우) 설정할 정적 보조 DNS입니다.

명확하게 하기 위해 인터페이스를 DHCP로 설정하려면, 다음처럼 네트워크의 AdapterName만 직렬화합니다.

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

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

무선 네트워크 인터페이스 열거하기

요청

사용 가능한 무선 네트워크 인터페이스를 열거하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/wifi/interfaces

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

세부 정보가 있는 사용 가능한 무선 인터페이스 목록은 다음과 같은 형식을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

무선 네트워크 열거하기

요청

지정된 인터페이스에 무선 네트워크의 목록을 열거하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/wifi/networks

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
interface	(필수) 무선 네트워크 검색에 사용할 괄호가 없는 네트워크 인터페이스의 GUID입니다.

요청 헤더

없음

요청 본문

없음

응답

제공된 인터페이스에서 찾은 무선 네트워크의 목록입니다. 여 목록에 포함된 네트워크 세부 정보는 다음과 같은 형식을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Wi-Fi 네트워크에 연결하고 연결을 해제합니다.

요청

Wi-Fi 네트워크에 연결하거나 연결을 해제하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
게시	/api/wifi/network

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
인터페이스	(필수) 네트워크 연결에 사용할 네트워크 인터페이스에 대한 GUID입니다.
op	(필수) 수행할 작업을 나타냅니다. 가능한 값은 연결 또는 연결 해제입니다.
ssid	(op == connect인 경우 필수) 연결할 SSID입니다.
키	(op == connect이고 네트워크에 인증이 필요한 경우 필수) 공유 키입니다.
createprofile	(필수) 디바이스에서 네트워크에 대한 프로필을 만듭니다. 이를 통해 다음부터 디바이스에서 네트워크에 자동 연결할 수 있습니다. 이는 yes 또는 no일 수 있습니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Wi-Fi 프로필 삭제하기

요청

특정 인터페이스의 네트워크와 연결된 프로필을 삭제하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
DELETE	/api/wifi/profile

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
인터페이스	(필수) 삭제할 프로필과 연결된 네트워크 인터페이스의 GUID입니다.
프로필	(필수) 삭제할 프로필의 이름입니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

WER(Windows 오류 보고)

WER(Windows 오류 보고) 파일 다운로드하기

요청

WER 관련 파일을 다운로드하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/wer/report/file

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
사용자	(필수) 보고서와 연결된 사용자 이름입니다.
형식	(필수) 보고서의 형식입니다. 이는 queried 또는 archived가 될 수 있습니다.
이름	(필수) 보고서의 이름입니다. base64로 인코딩되어야 합니다.
file	(필수) 보고서에서 다운로드할 파일의 이름입니다. base64로 인코딩되어야 합니다.

요청 헤더

없음

요청 본문

없음

응답

응답은 요청된 파일을 포함합니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

WER(Windows 오류 보고) 보고서에 파일 열거하기

요청

WER 보고서에 파일을 열거하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/wer/report/files

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
사용자	(필수) 보고서와 연결된 사용자입니다.
형식	(필수) 보고서의 형식입니다. 이는 queried 또는 archived가 될 수 있습니다.
이름	(필수) 보고서의 이름입니다. base64로 인코딩되어야 합니다.

요청 헤더

없음

요청 본문

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

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

WER(Windows 오류 보고) 보고서 나열하기

요청

WER 보고서를 가져오기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/wer/reports

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

WER 보고서는 다음과 같은 형식을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Desktop
HoloLens
IoT

WPR(Windows Performance Recorder)

사용자 지정 프로필을 사용하여 추적 시작하기

요청

WPR 프로필을 업로드하고 해당 프로필을 사용하여 추적을 시작하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다. 추적은 한 번에 하나만 실행할 수 있습니다. 프로필은 디바이스에서 유지되지 않습니다.

메서드	요청 URI
POST	/api/wpr/customtrace

URI 매개 변수

없음

요청 헤더

없음

요청 본문

사용자 지정 WPR 프로필을 포함하는 http 본문을 준수하는 다중 파트입니다.

응답

WPR 세션 상태는 다음과 같은 형식을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

부팅 성능 추적 세션 시작하기

요청

부팅 WPR 추적 세션을 시작하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다. 이는 성능 추적 세션이라고도 합니다.

메서드	요청 URI
POST	/api/wpr/boottrace

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
프로필	(필수) 시작 시 이 매개 변수가 필요합니다. 성능 추적 세션을 시작해야 하는 프로필의 이름입니다. 가능한 프로필은 perfprofiles/profiles.json에 저장됩니다.

요청 헤더

없음

요청 본문

없음

응답

이 API는 시작 시에 다음과 같은 형식의 WPR 세션 상태를 반환합니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

부팅 성능 추적 세션 중지하기

요청

부팅 WPR 추적 세션을 중지하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다. 이는 성능 추적 세션이라고도 합니다.

메서드	요청 URI
GET	/api/wpr/boottrace

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

없음. 참고: 이 작업은 장기 실행 작업입니다. ETL에서 디스크에 쓰기가 완료되면 반환됩니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

성능 추적 세션 시작하기

요청

WPR 추적 세션을 시작하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다. 이는 성능 추적 세션이라고도 합니다. 추적은 한 번에 하나만 실행할 수 있습니다.

메서드	요청 URI
POST	/api/wpr/trace

URI 매개 변수

다음과 같은 추가 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
프로필	(필수) 성능 추적 세션을 시작해야 하는 프로필의 이름입니다. 가능한 프로필은 perfprofiles/profiles.json에 저장됩니다.

요청 헤더

없음

요청 본문

없음

응답

이 API는 시작 시에 다음과 같은 형식의 WPR 세션 상태를 반환합니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

성능 추적 세션 중지하기

요청

WPR 추적 세션을 중지하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다. 이는 성능 추적 세션이라고도 합니다.

메서드	요청 URI
GET	/api/wpr/trace

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

없음. 참고: 이 작업은 장기 실행 작업입니다. ETL에서 디스크에 쓰기가 완료되면 반환됩니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

추적 세션의 상태 검색하기

요청

현재 WPR 세션의 상태를 검색하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/wpr/status

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

WPR 추적 세션 상태는 다음과 같은 형식을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

완료된 추적 세션(ETL) 나열하기

요청

디바이스의 ETL 추적 목록을 가져오기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/wpr/tracefiles

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

완료된 추적 세션의 목록은 다음과 같은 형식으로 제공됩니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

추적 세션(ETL) 다운로드하기

요청

추적 파일(부팅 추적 또는 사용자 모드 추적)을 다운로드하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
GET	/api/wpr/tracefile

URI 매개 변수

다음과 같은 추가적인 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
filename	(필수) 다운로드할 ETL 추적의 이름입니다. /api/wpr/tracefiles에서 찾을 수 있습니다.

요청 헤더

없음

요청 본문

없음

응답

추적 ETL 파일을 반환합니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

추적 세션(ETL) 삭제하기

요청

추적 파일(부팅 추적 또는 사용자 모드 추적)을 삭제하기 위해 다음과 같은 요청 형식을 사용할 수 있습니다.

메서드	요청 URI
DELETE	/api/wpr/tracefile

URI 매개 변수

다음과 같은 추가적인 매개 변수를 요청 URI에 지정할 수 있습니다.

URI 매개 변수	설명
filename	(필수) 삭제할 ETL 추적의 이름입니다. /api/wpr/tracefiles에서 찾을 수 있습니다.

요청 헤더

없음

요청 본문

없음

응답

추적 ETL 파일을 반환합니다.

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
IoT

DNS-SD 태그

태그 보기

요청

현재 디바이스에 적용되어 있는 태그를 봅니다. 이러한 태그는 T 키의 DNS-SD TXT 레코드를 통해 보급됩니다.

메서드	요청 URI
GET	/api/dns-sd/tags

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답 현재 적용된 태그는 다음과 같은 형식을 따릅니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	OK
5XX	서버 오류

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

태그 삭제하기

요청

DNS-SD에 의해 현재 보급된 모든 태그를 삭제합니다.

메서드	요청 URI
DELETE	/api/dns-sd/tags

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답

없음

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	OK
5XX	서버 오류

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

태그 삭제하기

요청

DNS-SD에 의해 현재 보급된 태그를 삭제합니다.

메서드	요청 URI
DELETE	/api/dns-sd/tag

URI 매개 변수

URI 매개 변수	설명
tagValue	(필수) 제거할 태그입니다.

요청 헤더

없음

요청 본문

없음

응답

없음

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

태그 추가하기

요청

DNS-SD 보급에 태그를 추가합니다.

메서드	요청 URI
POST	/api/dns-sd/tag

URI 매개 변수

URI 매개 변수	설명
tagValue	(필수) 추가될 태그입니다.

요청 헤더

없음

요청 본문

없음

응답

없음

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	OK
401	태그 공간 오버플로. 제안된 태그가 결과로 생성된 DNS-SD 서비스 레코드에 비해 너무 긴 경우의 결과입니다.

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

앱 파일 탐색기

알려진 폴더 가져오기

요청

액세스 가능한 최상위 폴더의 목록을 가져옵니다.

메서드	요청 URI
GET	/api/filesystem/apps/knownfolders

URI 매개 변수

없음

요청 헤더

없음

요청 본문

없음

응답 다음과 같은 형식을 따르는 사용 가능한 폴더입니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	수락되어 처리 중인 요청 배포하기
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

파일 가져오기

요청

폴더의 파일 목록을 가져옵니다.

메서드	요청 URI
GET	/api/filesystem/apps/files

URI 매개 변수

URI 매개 변수	설명
knownfolderid	(필수) 원하는 파일 목록이 있는 최상위 디렉터리입니다. 사이드로드된 앱에 액세스하려면 LocalAppData를 사용합니다.
packageFullName	(knownfolderid == LocalAppData인 경우 필수) 관심 있는 앱 패키지의 전체 이름입니다.
경로	(선택적) 위에서 지정된 폴더 또는 패키지 내의 하위 디렉터리입니다.

요청 헤더

없음

요청 본문

없음

응답 다음과 같은 형식을 따르는 사용 가능한 폴더입니다.

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

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	확인
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

파일 다운로드하기

요청

알려진 폴더 또는 appLocalData에서 파일을 가져옵니다.

메서드	요청 URI
GET	/api/filesystem/apps/file

URI 매개 변수

URI 매개 변수	설명
knownfolderid	(필수) 파일을 다운로드하려는 최상위 디렉터리입니다. 사이드로드된 앱에 액세스하려면 LocalAppData를 사용합니다.
filename	(필수) 다운로드하고 있는 파일의 이름입니다.
packageFullName	(knownfolderid == LocalAppData인 경우 필수) 관심 있는 패키지의 전체 이름입니다.
경로	(선택적) 위에서 지정된 폴더 또는 패키지 내의 하위 디렉터리입니다.

요청 헤더

없음

요청 본문

요청된 파일(있는 경우)

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	요청된 파일
404	파일을 찾을 수 없음
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

파일 이름 바꾸기

요청

폴더 내 파일의 이름을 변경합니다.

메서드	요청 URI
POST	/api/filesystem/apps/rename

URI 매개 변수

URI 매개 변수	설명
knownfolderid	(필수) 파일이 위치한 최상위 디렉터리입니다. 사이드로드된 앱에 액세스하려면 LocalAppData를 사용합니다.
filename	(필수) 이름을 변경할 원래 파일의 이름입니다.
newfilename	(필수) 파일의 새 이름입니다.
packageFullName	(knownfolderid == LocalAppData인 경우 필수) 관심 있는 앱 패키지의 전체 이름입니다.
경로	(선택적) 위에서 지정된 폴더 또는 패키지 내의 하위 디렉터리입니다.

요청 헤더

없음

요청 본문

없음

응답

없음

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	OK. 파일 이름이 변경되었습니다.
404	파일을 찾을 수 없음
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

파일 삭제하기

요청

폴더의 파일을 삭제합니다.

메서드	요청 URI
DELETE	/api/filesystem/apps/file

URI 매개 변수

URI 매개 변수	설명
knownfolderid	(필수) 파일을 삭제하려는 최상위 디렉터리입니다. 사이드로드된 앱에 액세스하려면 LocalAppData를 사용합니다.
filename	(필수) 삭제하고 있는 파일의 이름입니다.
packagefullName	(knownfolderid == LocalAppData인 경우 필수) 관심 있는 앱 패키지의 전체 이름입니다.
경로	(선택적) 위에서 지정된 폴더 또는 패키지 내의 하위 디렉터리입니다.

요청 헤더

없음

요청 본문

없음

응답

없음

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	OK. 파일이 삭제되었습니다.
404	파일을 찾을 수 없음
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

파일 업로드하기

요청

폴더에 파일을 업로드합니다. 이렇게 하면 이름이 같은 기존 파일을 덮어쓰지만 새 폴더를 만들지는 않습니다.

메서드	요청 URI
POST	/api/filesystem/apps/file

URI 매개 변수

URI 매개 변수	설명
knownfolderid	(필수) 파일을 업로드하려는 최상위 디렉터리입니다. 사이드로드된 앱에 액세스하려면 LocalAppData를 사용합니다.
packageFullName	(knownfolderid == LocalAppData인 경우 필수) 관심 있는 앱 패키지의 전체 이름입니다.
extract	(필수) True이거나 false입니다. 이는 업로드 후 파일을 추출해야 하는지 여부를 나타냅니다.
경로	(선택적) 위에서 지정된 폴더 또는 패키지 내의 하위 디렉터리입니다.

요청 헤더

없음

요청 본문

없음

응답

상태 코드

이 API에서는 다음과 같은 상태 코드가 예상됩니다.

HTTP 상태 코드	설명
200	OK. 파일이 업로드되었습니다.
4XX	오류 코드
5XX	오류 코드

사용 가능한 디바이스 패밀리

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

URI 매개 변수	설명
appid	(필수) 시작하려는 앱의 PRAID입니다. 이 값은 hex64로 인코딩되어야 합니다.
패키지	(필수) 시작하려는 앱 패키지의 전체 이름입니다. 이 값은 hex64로 인코딩되어야 합니다.

URI 매개 변수	설명
패키지	(필수) 중지하려는 앱 패키지의 전체 이름입니다. 이 값은 hex64로 인코딩되어야 합니다.
forcestop	(선택적) 예의 값은 시스템이 모든 프로세스를 강제로 중지해야 함을 나타냅니다.

다음을 통해 공유

Windows Device Portal 코어 REST API 참조

앱 배포

앱 설치하기

관련 세트 설치하기

느슨한 폴더에 앱 등록하기

느슨한 파일 폴더에 관련 세트 등록하기

앱 설치 상태 가져오기

앱 제거하기

설치된 앱 가져오기

Bluetooth

머신의 Bluetooth 송수신 장치 가져오기

Bluetooth 송수신 장치 켜기 또는 끄기

페어링된 Bluetooth 디바이스 목록 가져오기

사용 가능한 Bluetooth 디바이스 목록 가져오기

Bluetooth 디바이스 연결하기

Bluetooth 디바이스 연결 해제하기

디바이스 관리자

머신에 설치된 디바이스 가져오기

연결된 USB 디바이스/허브의 데이터 가져오기

덤프 수집

앱에 대한 모든 크래시 덤프 목록 가져오기

앱에 대한 크래시 덤프 수집 설정 가져오기

사이드로드된 앱의 크래시 덤프 삭제하기

사이드로드된 앱의 크래시 덤프를 사용하지 않음

사이드로드된 앱의 크래시 덤프 다운로드하기

사이드로드된 앱의 크래시 덤프 사용하기

버그 검사 파일 목록 가져오기

버그 검사 덤프 파일 다운로드하기

버그 검사 크래시 제어 설정 가져오기

라이브 커널 덤프 가져오기

라이브 사용자 프로세스에서 덤프 가져오기

버그 검사 크래시 제어 설정 지정하기

ETW

Websocket을 통해 실시간 ETW 세션 만들기

ETW WebSocket 명령

등록된 ETW 공급자 열거하기

플랫폼에 의해 노출된 사용자 지정 ETW 공급자를 열거합니다.

위치

위치 재정의 모드 가져오기

위치 재정의 모드 설정하기

삽입 위치 가져오기

삽입 위치 설정하기

OS 정보

컴퓨터 이름 가져오기

운영 체제 정보 가져오기

디바이스 패밀리 가져오기

컴퓨터 이름 설정하기

사용자 정보

활성 사용자 가져오기

성능 데이터

실행 중인 프로세스 목록 가져오기

시스템 성능 통계 가져오기

Power

현재 배터리 상태 가져오기

활성 전원 구성표 가져오기

전원 구성표에 대한 하위 값 가져오기

시스템의 전원 상태 가져오기

활성 전원 구성표 설정하기

전원 구성표의 하위 값 설정하기

절전 연구 보고서 가져오기

사용 가능한 절전 연구 보고서 열거

절전 연구 변환 가져오기

원격 제어

대상 컴퓨터를 다시 시작합니다.

대상 컴퓨터 종료하기

작업 관리자

최신 앱 시작하기

최신 앱 중지하기

PID를 사용하여 프로세스 중단하기

네트워킹

현재 IP 구성 가져오기

고정 IP 주소 설정하기(IPV4 구성)

무선 네트워크 인터페이스 열거하기

무선 네트워크 열거하기

Wi-Fi 네트워크에 연결하고 연결을 해제합니다.

Wi-Fi 프로필 삭제하기

WER(Windows 오류 보고)

WER(Windows 오류 보고) 파일 다운로드하기

WER(Windows 오류 보고) 보고서에 파일 열거하기