Retrieve the sync status of all created content tokens

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

Retrieve the current sync status of all VPP content tokens

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
vpp_sync_detailsJSON Array

Array of sync detail objects for all content tokens

Show Sub-Attributes
JSON Object
Show Sub-Attributes
if_sync_failedboolean

Whether the sync failed. true = sync failed, false = sync succeeded or not yet attempted

failed_apps_countinteger

Total number of apps that did not sync successfully

total_apps_countinteger

Total number of apps associated with the content token

completed_apps_countinteger

Total number of apps processed (successful + failed)

successful_apps_countinteger

Total number of apps that synced successfully

businessstore_idlong

Unique ID of the content token

statusinteger

Sync status code. 0 = Idle (sync not initiated), 1 = Downloading App Details, 2 = Syncing Apps (license syncing)

remarksstring

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

other_mdm_hostnamestring

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

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Sync status details for all content tokens

Copied!
  {
    "vpp_sync_details": [
      {
        "if_sync_failed": true,
        "failed_apps_count": 0,
        "total_apps_count": 0,
        "successful_apps_count": 0,
        "businessstore_id": 9007199254741896,
        "completed_apps_count": 0,
        "remarks": null,
        "status": 0,
        "other_mdm_hostname": "Sample MDM"
      }
    ]
  }
                
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.