ci.runs.cancelCancel a run that is queued or in progress
POST /ci/api/runs/{runId}/cancelIAM ci:CancelRunChanges stateDestructive
Its machines are torn down within moments; a runner that has not started it never will. 409 when the run has already finished.
Request syntax
POST /ci/api/runs/{runId}/cancelPath parameters
runIdRequiredstring
Constraints: uuid
Response
200 with no data; the run is now cancelled, with the error "Cancelled from the console". 409 when it already succeeded, failed, was cancelled or timed out; 404 when it is not in this organization.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow ci:CancelRun on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud ci runs cancel runIdcurl -X POST "https://console.platform.deutschecloud.app/ci/api/runs/runId/cancel" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ci_runs_cancel.