Retrieve the sync status of a specific content token

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To get VPP account sync status

Request URL

https://{server-hostname}:8383/api/mdm/apps/account/vpp/sync/{vpp_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

vpp_idstringMandatory

Unique identifier of the VPP content token. Obtain from the Add VPP Account_addVppAccount) or Get VPP Accounts_getVppAccount) response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/mdm/apps/account/vpp/sync/{vpp_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
if_license_insufficientboolean

true if the content token has insufficient licenses for one or more apps

if_sync_failedboolean

Whether the sync failed. true = sync failed

apps_with_insufficient_licensesinteger

Number of apps with insufficient licenses

failed_apps_countinteger

Total number of apps that did not sync successfully

total_apps_countinteger

Total number of apps associated with this content token

successful_apps_countinteger

Total number of apps that synced successfully

last_sync_timelong

Epoch timestamp (milliseconds) of the last sync

completed_apps_countinteger

Total number of apps processed (successful + failed)

remarksstring

Remarks about the sync status including failure reasons. Can be null or differentClientContext

statusinteger

Sync status code. 0 = Idle, 1 = Downloading App Details, 2 = Syncing Apps

other_mdm_hostnamestring

Hostname of another MDM using this token. Displayed when remarks equals differentClientContext

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Sync status when idle with no sync initiated

Copied!
  {
    "if_license_insufficient": false,
    "if_sync_failed": true,
    "apps_with_insufficient_licenses": 0,
    "failed_apps_count": 0,
    "total_apps_count": 0,
    "successful_apps_count": 0,
    "last_sync_time": 1621574248750,
    "completed_apps_count": 0,
    "remarks": null,
    "status": 0,
    "other_mdm_hostname": "Sample MDM"
  }
                
Show full

Sync status while apps are being synced

Copied!
  {
    "if_license_insufficient": false,
    "if_sync_failed": false,
    "apps_with_insufficient_licenses": 0,
    "failed_apps_count": 0,
    "total_apps_count": 10,
    "successful_apps_count": 5,
    "last_sync_time": 1621574248750,
    "completed_apps_count": 5,
    "remarks": null,
    "status": 2,
    "other_mdm_hostname": ""
  }
                
Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.