Install app
Requests an app install on the device. The request body must supply exactly one of an Android packageName or an iOS bundleId; protected packages are rejected. background (default false) selects the response contract: false installs inline and returns the outcome directly (200 on success, an error status on failure); true accepts the request and runs the download + install in the background, returning 202 immediately — poll list-app-installs for the backend’s view of that attempt’s status. Refuses with 409 once 2 other installs are already running on the device, in either mode; a repeat request for an app that already has an install running is also refused with 409 rather than superseding it — retry once that attempt reaches a terminal state.
background (default false) selects the response contract:
background: false(default) — installs inline; the response is the actual outcome:200on success, an error status on failure.background: true— accepts the request and runs the download + install in the background; a202response means the request was accepted, not that the app is installed yet — polllist-appsuntil the app appears, or polllist-app-installsfor the backend’s view of the install attempt itself (useful while the device is offline or crashed, whenlist-appscan’t be called at all).
409 Conflict once 2 other installs are already running on the device. A repeat request for an app that already has an install running is also refused with 409 Conflict rather than superseding it — retry once that attempt reaches a terminal state.
Provide exactly one of:
packageName— Android package name. Resolved against the device owner’s app library, so upload the APK first.bundleId— iOS bundle identifier (e.g.com.example.app) or a numeric App Store ID. The app is installed from the App Store.
Authorizations
Bearer token via Authorization header
Headers
x >= 0Path Parameters
Body
- Option 1
- Option 2
iOS bundle identifier (e.g. com.example.app)
1true: return 202 immediately and install in the background (poll list-app-installs). false/omitted: install inline and return the outcome directly (200 on success, an error status on failure).
Android package name (e.g. com.example.app)
1Response
Install finished synchronously (background omitted or false).