Cancel a scheduled upgrade:

DELETE /upgrades/{account}/upgrade/{upgradeId}

Cancel a scheduled upgrade. Currently, you cannot modify an upgrade once it has been scheduled, so you must cancel it and schedule it again if you want to make changes.


See also:
Schedule Firmware Upgrade
Get Information about an Upgrade
Get Upgrades by Status
Add or remove devices from an upgrade

Uses and Requirements

You cannot cancel an upgrade that has already started.

Request Components

HTTP Request


Resource Path and Query Parameters

You must include the account name in the path and the ID of the upgrade that you want to cancel.

Parameter Name Data Type Description
string The name of the account that has the scheduled upgrade. An account name is usually numeric, and must include any leading zeros.
UUID string The UUID of the upgrade that you want to cancel, returned by POST /upgrades when the upgrade was scheduled.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token.

Parameter Name Data Type Description
string HTTP Authorization request header containing a valid Bearer token.
string A valid session token returned by a Connectivity Management POST /session/login request.

Request Body


Example Request

Cancel an upgrade for an account:

curl -X DELETE$ACCOUNT/upgrade/$UPGRADE_ID  -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN'

Success Responses

Status 200

A response to a successful request contains a single Boolean value:

  "success": true

Failure Responses

Status 400

All error messages are returned in this format:

  "errorCode": "error code string",
  "errorMessage": "error message string"

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.