doctl harness-runtime cancel

Generated on 1 Oct 2026 from doctl version v1.177.0

Usage

doctl harness-runtime cancel <session> [flags]

Aliases

stop

Description

Stop the turn a session’s agent is running and leave the session up and ready for the next prompt — what Ctrl-C does in doctl harness-runtime attach and doctl harness-runtime prompt, from any terminal.

Without --run-id, cancels whichever turn is running when the request arrives and prints its run id. With --run-id, cancels only that turn: if it already finished, nothing is stopped — in particular not a turn someone started after it — so pass it when you have it.

Nothing running is not an error: the command says so and exits 0, so it is safe to run unconditionally. With -o json it prints {"session_id", "run_id", "outcome"}, where outcome is acked, no_turn or unsupported and run_id is absent when nothing was running. An agent that cannot cancel a turn is an error, since the turn keeps running. Cancel undoes nothing the turn already did; a half-written file stays half-written. It never pauses the session — use doctl harness-runtime pause for that.

Example

doctl harness-runtime cancel my-session;

Flags

Option Description
--format Columns for output in a comma-separated list. Possible values: SessionID, RunID, Outcome.
--help, -h Help for this command
--no-header Return raw data with no headers
Default: false
--run-id Cancel only this turn (the run id prompt or run.started reported); without it, whichever turn is running
Command Description
doctl harness-runtime Managed Agents Runtime Services (M.A.R.S)

Global Flags

Option Description
--access-token, -t API V2 access token
--api-url, -u Override default API endpoint
--config, -c Specify a custom config file
Default:
    --context Specify a custom authentication context name
    --http-retry-max Set maximum number of retries for requests that fail with a 429 or 500-level error
    Default: 5
    --http-retry-wait-max Set the minimum number of seconds to wait before retrying a failed request
    Default: 30
    --http-retry-wait-min Set the maximum number of seconds to wait before retrying a failed request
    Default: 1
    --interactive Enable interactive behavior. Defaults to true if the terminal supports it (default false)
    Default: false
    --output, -o Desired output format [text|json]
    Default: text
    --trace Show a log of network activity while performing a command
    Default: false
    --verbose, -v Enable verbose output
    Default: false

    We can't find any results for your search.

    Try using different keywords or simplifying your search terms.