Sign in

Cancel a run (operator)

post/workspaces/{workspaceId}/runs/{runId}/cancel

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/workspaces/{workspaceId}/runs/{runId}/cancel
  • Auth: HTTP bearer

Path parameters

workspaceIdstring required
runIdstring required

Response

Cancelled run

idstring required
workspace_idstring required
org_idstring required
operation'plan' | 'apply' | 'destroy' | 'import' | 'test' required
status'pending' | 'queued' | 'planning' | 'planned' | 'awaiting_approval' | 'applying' | 'applied' | 'errored' | 'cancelled' | 'discarded' required
plan_outputstring
plan_log_urlstring
apply_log_urlstring
resources_addedinteger
resources_changedinteger
resources_deletedinteger
error_messagestring
commit_shastring
plan_json_urlstring
created_bystring required
started_atstring date-time nullable
finished_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 14 revisions of this API.