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

await runs.cancel("run_1234");
{
  "message": "<string>"
}

Authorizations

Authorization
string
headerrequired

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

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

configure({ secretKey: "tr_dev_1234" });

Path Parameters

run_id
string
required

The ID of an existing run. When you trigger a run you will get an id in the response.

Response

200 - application/json
message
string

Confirmation message that the run was canceled.