Cancel Run

Overview

Cancels an actively executing run. If the run has already finished (completed, failed, canceled, etc.) this is a no-op.

Authentication with a secret key is required.

POST https://api.trigger.dev/api/v2/runs/{runId}/cancel

runId

string

required

The unique run ID to cancel, prefixed with run_.

string

The ID of the run that was canceled.

import { runs } from "@trigger.dev/sdk";

await runs.cancel("run_p4omhh45hgxxnq1re6ovy");

{
  "id": "run_p4omhh45hgxxnq1re6ovy"
}

Learn more about Mintlify

Enter your email to receive updates about new features and product releases.