v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB
runs

Cancel a Run

Interrupt a run that is currently planning or applying.

Performing a cancel is roughly equivalent to hitting ctrl+c during a Terraform plan or apply on the CLI. The running Terraform process is sent an INT signal, which instructs Terraform to end its work and wrap up in the safest way possible.

post/runs/{run}/actions/cancel

Path parameters

runstring required

The ID of the run to cancel.

Request body

commentstring

The reason.

Response

Successfully queued a cancel request.