Try the Software Management Services API
You will need tokens from two different accounts to use the Software Management Services API Console, a ThingSpace API Token and a Session Token:
- The ThingSpace API Token is available after you sign in to your ThingSpace Develop account. Go to Key Management in your Account Settings. Refresh the Token and then copy it to the clipboard. Return to the API Console page and paste it into the Authorization: Bearer field below.
- Obtain a Session Token by signing in to your UWS account using the
POST /api/m2m/v1/session/loginrequest of the Connectivity Management API. Use the session token that is returned in the response as theVZ-M2M-Tokenparameter value in the requests on this page.
NOTE: ThingSpace API Tokens are valid for one hour. Session tokens stay valid as long as they are being used, but expire after 20 minutes of inactivity.
Where to start
After you have your tokens, here is a suggested sequence of API requests to get you started:
- Use the
GET /subscriptionsrequest to see the status of your account's Software Management Service subscription. - Use the
GET /firmwarerequest to retrieve the list of available firmware upgrades. - If your account has an MRC subscription, use the
POST /licensesrequest to assign licenses to devices that you want to upgrade. - Use the
POST /upgradesrequest to schedule a firmware upgrade for devices. Note that the firmware must match the device (make, model, current firmware version) or you will get an error back. - Use the returned upgradeId in a
GET /upgradesrequest to view the upgrade information. - If you aren't ready for devices to be upgraded yet, use the
DELETE /upgraderequest to cancel the upgrade.
You will need tokens from two different accounts to use the Software Management Services API Console, a ThingSpace API Token and a Session Token:
- The ThingSpace API Token is available after you sign in to your ThingSpace Develop account. Go to Key Management in your Account Settings. Refresh the Token and then copy it to the clipboard. Return to the API Console page and paste it into the Authorization: Bearer field below.
- Obtain a Session Token by signing in to your UWS account using the
POST /api/m2m/v1/session/loginrequest of the Connectivity Management API. Use the session token that is returned in the response as theVZ-M2M-Tokenparameter value in the requests on this page.
NOTE: ThingSpace API Tokens are valid for one hour. Session tokens stay valid as long as they are being used, but expire after 20 minutes of inactivity.
Where to start
After you have your tokens, here is a suggested sequence of API requests to get you started:
- Use the
GET /subscriptionsrequest to see the status of your account's Software Management Service subscription. - Use the
GET /firmwarerequest to retrieve the list of available firmware upgrades. - If your account has an MRC subscription, use the
POST /licensesrequest to assign licenses to devices that you want to upgrade. - Use the
POST /upgradesrequest to schedule a firmware upgrade for devices. Note that the firmware must match the device (make, model, current firmware version) or you will get an error back. - Use the returned upgradeId in a
GET /upgradesrequest to view the upgrade information. - If you aren't ready for devices to be upgraded yet, use the
DELETE /upgraderequest to cancel the upgrade.

