HomeGuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Creates a new command to request that a mobile device update its OS. Command and mobile device list specified in URL. Mixing iOS and tvOS devices in ID list is not advised, as product version is specific to OS type. (deprecated on 2022-10-17)

❗️

This endpoint has been deprecated, but will continue to function. New endpoints in the Jamf Pro API are targeted for release in late 2023.

Path Params
string
required

Mobile device ID values, multiple IDs may be separated by commas (e.g. /id/13,14,15)

integer
required

Specify the behavior of the install. Possible integer values are: 1 (Download the update for users to install), 2 (Download and install the update, and restart devices after installation)

string
required

Specify the OS version of the update. Updating to a specific iOS version requires devices with iOS 11.3 or later. Updating to a specific tvOS version requires devices with tvOS 12.2 or later. install_action required by the ScheduleOSUpdate command if product_version is specified.

Response
201

Created

Language
Credentials
: