For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.harness.cancel_trigger_execution(
    trigger_id="b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d",
    execution_id="7c1f9e2a-3b4c-5d6e-7f80-91a2b3c4d5e6",
    force=None,
)

Description

Fails the execution and frees the trigger’s in-flight slot. A fresh-mode session is destroyed outright. A reuse-mode session is only paused, not stopped - harness has no run-interrupt call, so the agent’s turn may still be in flight server-side; this frees the queue, not necessarily the agent’s work. A non-running execution is a no-op that still returns 200.

Parameters

trigger_id string required

Example: b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d

The trigger UUID.

execution_id string required

Example: 7c1f9e2a-3b4c-5d6e-7f80-91a2b3c4d5e6

The execution UUID.

force boolean optional

Example: False

Cancel even if the execution has not started a run yet (the worker's own dispatch may still be in flight). Without this, that case returns 409; reclaim clears it automatically within 15m regardless.

Response Example

{
  "execution": {
    "execution_id": "7c1f9e2a-3b4c-5d6e-7f80-91a2b3c4d5e6",
    "trigger_id": "b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d",
    "status": "succeeded",
    "session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "run_id": "",
    "failure_reason": "",
    "created_at": "2026-07-27T12:00:00Z",
    "updated_at": "2026-07-27T12:00:05Z",
    "payload": "",
    "output_text": "",
    "output_truncated": false
  }
}

More Information

See /v2/agents/triggers/{trigger_id}/executions/{execution_id}/cancel in the API reference for additional detail on responses, headers, parameters, and more.