executions:terminate

Close one stored execution record: sets its status to --terminal_status (`completed`, `failed` or `canceled`; omitted: `canceled`), merges --metadata into the record's metadata, and bumps the node's revision. It records status only: it stops no process or compute (release machines with `compute:release`). Needs the node's owner or an admin. Only a `running` record can be closed: one that is already `completed`, `failed` or `canceled` is refused with 409 naming its status, and stays as it is.

Reference for flywheel executions:terminate.

Command Group

Compute & Executions Commands

Summary

Close one stored execution record: sets its status to --terminal_status (completed, failed or canceled; omitted: canceled), merges --metadata into the record's metadata, and bumps the node's revision. It records status only: it stops no process or compute (release machines with compute:release). Needs the node's owner or an admin. Only a running record can be closed: one that is already completed, failed or canceled is refused with 409 naming its status, and stays as it is.

Effect

DESTRUCTIVE: deletes, overwrites or revokes something

Usage

flywheel executions:terminate <FLAGS>

Required flags

FlagValueDefaultChoicesDescription
--node_idstringNode UUID (not a slug) from node_id in hosted:node:list or graph:get. Missing or hidden: 404 where the command loads it.
--execution_idstringExecution record on node_id, from executions:launch or executions:list; not a lease_id. Unknown: 404 where looked up; upload items store it unchecked.
--expected_revisionintegerrevision of node_id (root_node_id for tags) from hosted:node:get or your last write. Stale: 409 (some tools retry once); re-read and retry.

Optional flags

FlagValueDefaultChoicesDescription
--terminal_statusstringcanceledcompleted, failed, canceledHow the execution ended, stored as the record's status: completed, failed or canceled (omitted: canceled).
--metadatajsonJSON object merged into the record's metadata: keys you send replace the old values, other keys stay (omitted: \{\}).
--formatFORMATjson, tsv, csv, tableOutput format for command results.
--envPROFILESelect a CLI profile; unconfigured default requires FLYWHEEL_BASE_URL.
--outPATHWrite output to a file path, or use - for stdout.
--openOpen browser-bound URLs when supported.
--no-retryDisable transient-error retries.
--retry-maxNMaximum transient-error retry attempts.
--waitBlock on async operations until a terminal state is reached.
--wait-timeoutSECONDS600Seconds to wait for --wait before timing out. Defaults to 600.
--allow-selfAllow mutating the currently active credential.
--timeoutSECONDSSet the per-request timeout budget in seconds.
--idempotency-keyKEYReuse an Idempotency-Key so ambiguous write failures can be retried with the same key.
--forceForce safety-gated operations where supported.
--yesConfirm forced compute:release-all --force. Other runtime commands do not read --yes.
--debugPrint structured request debugging with secrets masked.
--verbosePrint verbose progress for long-running operations.
-h, --helpShow this help.

Examples

Terminate, recording canceled.

flywheel executions:terminate --node_id n_abc --execution_id e1 --expected_revision 6

Record that the execution finished, with a result.

flywheel executions:terminate --node_id n_abc --execution_id e1 --expected_revision 6 --terminal_status completed --metadata '{"score":1}'

Output

Default format: json.

FieldType
nodeobject