Cancel a scheduled firmware upgrade
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.
Uses and Requirements
You cannot cancel an upgrade that has already started.
Request Components
HTTP Request
DELETE https://thingspace.verizon.com/api/fota/v1/upgrades/{account}/upgrade/{upgradeId}
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 |
|---|---|---|
| account (required) | string | The name of the account that has the scheduled upgrade. An account name is usually numeric, and must include any leading zeros. |
| upgradeId (required) | 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 set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token: VZ-M2M-Token: {M2Mtoken} |
| Content-Type (required) | string | Must be application/json Content-Type: application/json |
Request Body
None.
Example Request
Cancel an upgrade for an account:
curl -X DELETE https://thingspace.verizon.com/api/fota/v1/upgrades/$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.