API Console

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/login request of the Connectivity Management API. Use the session token that is returned in the response as the VZ-M2M-Token parameter 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:

  1. Use the GET /subscriptions request to see the status of your account’s Software Management Service subscription.
  2. Use the GET /firmware request to retrieve the list of available firmware upgrades.
  3. If your account has an MRC subscription, use the POST /licenses request to assign licenses to devices that you want to upgrade.
  4. Use the POST /upgrades request 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.
  5. Use the returned upgradeId in a GET /upgrades request to view the upgrade information.
  6. If you aren’t ready for devices to be upgraded yet, use the DELETE /upgrade request to cancel the upgrade.
Try It Out!