Skip to navigation
API ReferenceTask Run

Cancel a Task Run

View as Markdown

Cancel a Task Run. Best-effort cancellation cascades to the current phase’s in-flight target Tasks; targets not yet claimed are not started. Cancelling an already-terminal Task Run returns its last known state.

Task Runs are site-scoped; siteId must be the Site that owns the Task Run. Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Authentication

AuthorizationBearer
export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired
Name of the Org
idstringRequiredformat: "uuid"
UUID of the Task Run

Request

This endpoint expects an object.
siteIdstringRequiredformat: "uuid"
ID of the Site that owns the Task Run.
reasonstringOptional

Optional free-form reason recorded with the cancellation.

Response

Accepted. The cancellation request was accepted and the Task Run's last known state is returned.
idstringformat: "uuid"
Unique identifier of the Task Run.
namestring

Human-readable name of the Task Run.

operationTypeenum

Type of operation this Task Run executes. Currently always FirmwareControl.

Allowed values:
statusenum
Current lifecycle state of the Task Run.
statusReasonenum

Why the Task Run is paused or terminal (e.g. PhaseGate, SafetyGate). None when there is no qualifying reason.

totalPhasesinteger
Total number of phases the selected targets were divided into.
createddatetime
Timestamp when the Task Run was created.
updateddatetime
Timestamp when the Task Run was last updated.
descriptionstringOptional

Optional free-form description.

operationCodestringOptional

Operation code within the operation type (e.g. upgrade).

statusMessagestringOptional

Optional human-readable detail for the current status.

starteddatetime or nullOptional
Timestamp when the Task Run started execution. Null before it starts.
finisheddatetime or nullOptional
Timestamp when the Task Run reached a terminal state. Null while active.
statsobjectOptional

Derived per-phase outcome stats. Present only on the single-Task-Run GET when includeStats=true; omitted otherwise.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
504
Gateway Timeout Error