App packagemanager package
Install an app
Request
You can install an app by using the following request format.
Method | Request URI |
---|---|
POST | /api/app/packagemanager/package |
URI parameters
You can specify the following additional parameters on the request URI:
URI parameter | Description |
---|---|
package | (required) The file name of the package to be installed. |
Request headers
- None
Request body
- The .appx or .appxbundle file, as well as any dependencies the app requires.
- The certificate used to sign the app, if the device is IoT or Windows Desktop. Other platforms do not require the certificate.
Response
Status code
This API has the following expected status codes.
HTTP status code | Description |
---|---|
200 | Deploy request accepted and being processed |
4XX | Error codes |
5XX | Error codes |
Available device families
- Windows Mobile
- Windows Desktop
- Xbox
- HoloLens
- IoT
Install a related set
Request
You can install a related set by using the following request format.
Method | Request URI |
---|---|
POST | /api/app/packagemanager/package |
URI parameters
You can specify the following additional parameters on the request URI:
URI parameter | Description |
---|---|
package | (required) The file names of the packages to be installed. |
Request headers
- None
Request body - Add ".opt" to the optional package file names when specifying them as a parameter, like so: "foo.appx.opt" or "bar.appxbundle.opt". - The .appx or .appxbundle file, as well as any dependencies the app requires. - The certificate used to sign the app, if the device is IoT or Windows Desktop. Other platforms do not require the certificate.
Response
Status code
This API has the following expected status codes.
HTTP status code | Description |
---|---|
200 | Deploy request accepted and being processed |
4XX | Error codes |
5XX | Error codes |
Available device families
- Windows Mobile
- Windows Desktop
- Xbox
- HoloLens
- IoT
Uninstall an app
Request
You can uninstall an app by using the following request format.
Method | Request URI |
---|---|
DELETE | /api/app/packagemanager/package |
URI parameters
URI parameter | Description |
---|---|
package | (required) The PackageFullName (from GET /api/app/packagemanager/packages) of the target app |
Request headers
- None
Request body
- None
Response
Status code
This API has the following expected status codes.
HTTP status code | Description |
---|---|
200 | OK |
4XX | Error codes |
5XX | Error codes |
Available device families
- Windows Mobile
- Windows Desktop
- Xbox
- HoloLens
- IoT
Credits Microsoft