HomeGuidesAPI Reference
API Reference

Cancel queued or in-progress actions by GUID

Cancels all actions associated with the specified GUID key. Actions are flagged for cancellation and will complete with completionStatus=false and result='Action cancelled'. Only applies to actions queued via queueApplianceActionsAndGetPollHandle or queueSystemActionsAndGetPollHandle methods. Requires READ_WRITE permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
required
length ≥ 1

GUID key identifying the action group to cancel. Obtained from endpoints that return a poll handle (e.g., appliance upgrades, restores, bulk operations).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized - valid authentication credentials required.

403

Forbidden - user lacks READ_WRITE permission.

500

Internal server error - may occur if the GUID does not exist in the action tracking map (NullPointerException).

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html