<!--
{
  "availability" : [
    "iOS: 9.0.0 - 26.0.0",
    "iPadOS: 9.0.0 - 26.0.0",
    "macCatalyst: 9.0.0 - 26.0.0",
    "macOS: 10.11.5 - 26.0.0",
    "tvOS: 12.0.0 - 26.0.0"
  ],
  "documentType" : "symbol",
  "framework" : "DeviceManagement",
  "identifier" : "/documentation/DeviceManagement/OS-Update-Status-Command",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service Endpoint",
  "symbol" : {
    "kind" : "Web Service Endpoint",
    "modules" : [
      "Device Management"
    ],
    "preciseIdentifier" : "rest:put:mdm#OSUpdateStatusCommand"
  },
  "title" : "OS Update Status"
}
-->

# OS Update Status

Get the status of operating-system updates on a device. Removed: subscribe to the declarative management `softwareupdate.install-state` status item.

## Discussion

Refer to the following sections to determine supported channels and requirements, and to see an example request and response.

### Command availability

|||
|--------------------------|-----------------------------|
|Device channel            |iOS, macOS, Shared iPad, tvOS|
|User channel              |N/A                          |
|Requires supervision      |iOS, macOS, tvOS             |
|Allowed in user enrollment|N/A                          |
|Required access right     |AllowAppInstallation         |

### Example request and response

**Request:**

```plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Command</key>
    <dict>
        <key>RequestType</key>
        <string>OSUpdateStatus</string>
    </dict>
    <key>CommandUUID</key>
    <string>0001_OSUpdateStatus</string>
</dict>
</plist>
```

**Response:**

```plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>CommandUUID</key>
    <string>0001_OSUpdateStatus</string>
    <key>OSUpdateStatus</key>
    <array>
        <dict>
            <key>DownloadPercentComplete</key>
            <real>0.5030184984207153</real>
            <key>IsDownloaded</key>
            <false/>
            <key>ProductKey</key>
            <string>iOSUpdate17A576</string>
            <key>Status</key>
            <string>Downloading</string>
        </dict>
    </array>
    <key>Status</key>
    <string>Acknowledged</string>
    <key>UDID</key>
    <string>00008020-000915083C80012E</string>
</dict>
</plist>
```

## Topics

### Commands and responses

[`OSUpdateStatusCommand`](/documentation/DeviceManagement/OSUpdateStatusCommand)

The command to get the status of operating-system updates on a device. Removed: subscribe to the declarative management `softwareupdate.install-state` status item.

[`OSUpdateStatusResponse`](/documentation/DeviceManagement/OSUpdateStatusResponse)

A response from the device after it processes the command to get the status of operating-system updates on a device. Removed: subscribe to the declarative management `softwareupdate.install-state` status item.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)