>run cancellation

Cancel a run

Cancel pending or executing work from its run page or the API. Cancellation stops further work when the runner observes it; it does not reverse infrastructure changes already made.

Canceling an apply can leave partially changed infrastructure. Check the output and the latest saved state before retrying or cleaning up resources. A canceled status is not evidence that every provider operation stopped immediately.

Choose the action for the current state

Run state	Action
`pending`, `running`, `planning`, `applying`	Cancel from the run page or API.
A run-task stage (an external check at a plan/apply boundary) is running	Use the cancel API below. It also cancels outstanding task stages/results.
Plan finished and is waiting for approval	Discard the plan rather than using Cancel.
Terminal run	Inspect its result; it cannot be canceled again.

Use the actual run status, not an informal queue label, to choose an action. The API can refuse a request if a run finishes or changes state before the cancellation is accepted.

Cancel from the UI

Open the workspace's Runs tab and select the active run.
Check its workspace, operation and current phase.
Choose Cancel Run in the header. This control acts immediately; there is no separate cancellation confirmation dialog.
Wait for the status to update. Review the output and saved state before taking another action.

Example active run with the Cancel Run button in its header and phase output below.

The shared maintained capture uses synthetic data. No run was canceled to create it. For a run waiting on external run tasks, use the API path rather than relying on the current page's cancellation control.

Cancel through the API

Use a token with apply permission on the run's workspace. Set the API origin, token and run ID, then send:

curl --fail-with-body --request POST \
  --header "Authorization: Bearer $STACKWEAVER_TOKEN" \
  "$STACKWEAVER_API_URL/api/v2/runs/$RUN_ID/actions/cancel"

202 Accepted records the cancellation. Read the run again and inspect its phase logs:

curl --fail-with-body \
  --header "Authorization: Bearer $STACKWEAVER_TOKEN" \
  "$STACKWEAVER_API_URL/api/v2/runs/$RUN_ID"

The serialized canceled status is canceled. A 400 means the state is not eligible; a 409 can mean it changed concurrently. Read the current record before choosing another action. Cancellation also closes outstanding run-task stages, so a later external verdict does not restart the run.

Terraform resources configure and queue work; the cancel action is a lifecycle request, not a workspace YAML option. Use the API explorer for the separate discard and force-cancel operations. Do not substitute force-cancel for normal cancellation without understanding whether execution has actually stopped.

Check the consequences

Phase	What to verify
Planning	Output identifies how far evaluation got. A plan normally does not apply proposed changes, but providers/data sources can still perform external work.
Applying or destroying	Resources already changed remain. Compare phase output, the latest available state and actual infrastructure before a fresh plan.
Waiting on run tasks	The run and outstanding checks become terminal. Check the run before responding to any delayed task result.

Both platform and self-hosted runners observe cancellation through their control path. There can be a delay between recording the request and a process stopping. If the result is uncertain, investigate the runner before starting overlapping work.

The run-timeout guide explains automatic limits. Use run output and troubleshooting for verification and recovery.

opentofu streaming

run timeout