Delete Console Remote Firmware Update

The Delete Console Remote Firmware Update operation deletes a remote firmware update operation scheduled to run at a future time on the Console.

HTTP method and URI

DELETE /api/console/remote-firmware-updates/{remote-firmware-update-id}

In this request, the URI variable {remote-firmware-update-id} is the element ID of the Remote Firmware Update object to be deleted.

Description

The Delete Console Remote Firmware Update operation deletes a remote firmware update operation scheduled to run at a future time on the Console.

See Authorize Remote Firmware Updates for a description of the complete remote firmware update process.

If the API user does not have action/task permission to the Cancel Scheduled Update task, a 403 (Forbidden) status code is returned. A 404 (Not Found) status code is returned if {remote-firmware-update-id} does not identify a Remote Firmware Update element object on the Console. A 409 (Conflict) status code is returned if the remote firmware update operation identified by remote-firmware-update-id is already running or has already completed. Updated by feature rcl-progress]

If the request is valid, the identified remote firmware update is deleted from the Console.

Authorization requirements

This operation has the following authorization requirement:
  • Action/task permission to the Cancel Scheduled Update task.

HTTP status and reason codes

On success, HTTP status code 204 (No Content) is returned and no response body is provided.

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.

Table 1. Delete Console Remote Firmware Update: HTTP status and reason codes
HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
403 (Forbidden) 1 The API user does not have action/task permission to the Cancel Scheduled Update task.
404 (Not Found) 5 A remote firmware update operation with element-id {remote-firmware-update-id} does not exist in the Console.
409 (Conflict) 342 The value of the state property of the remote firmware update operation with element-id {remote-firmware-update-id} is "running" and it can therefore no longer be deleted.
382

The value of the state property of the remote firmware update with element-id {remote-firmware-update-id} indicates that the operation has already completed and it can therefore no longer be deleted.

[Added by feature rcl-progress]

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. Delete Console Remote Firmware Update: Request
DELETE /api/console/remote-firmware-updates/de52dc87-adb4-4cba-a8c7-cb1c4516f495 HTTP/1.1
x-api-session: l5b5w1hg644wcp0kpwcb9mhwj5xyhslge6nrxn8opyc1g2v43
Figure 2. Delete Console Remote Firmware Update: Response
204 No Content
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Fri, 19 Feb 2021 17:52:41 GMT

<No response body>