Reschedule run

Updates a delayed run with a new delay. Only valid when the run is in the DELAYED state.

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({ accessToken: "tr_dev_1234" });

Path Parameters

runId

string

required

The ID of an run, starts with run_. The run ID will be returned when you trigger a run on a task.

Body

application/json

delay

The duration to delay the run by. The duration should be in the format of 1d, 6h, 10m, 11s, etc.

Response

200 - application/json

id

string

required

The unique ID of the run, prefixed with run_

status

enum<string>

required

The status of the run

Available options:

DELAYED,

WAITING_FOR_DEPLOY,

QUEUED,

EXECUTING,

REATTEMPTING,

FROZEN,

COMPLETED,

CANCELED,

FAILED,

CRASHED,

INTERRUPTED,

SYSTEM_FAILURE

taskIdentifier

string

required

The identifier of the task that was run

createdAt

string

required

updatedAt

string

required

attempts

object[]

required

Show child attributes

attempts.id

string

required

The unique ID of the attempt, prefixed with attempt_

attempts.status

enum<string>

required

Available options:

PENDING,

EXECUTING,

PAUSED,

COMPLETED,

FAILED,

CANCELED

attempts.error

object

Show child attributes

attempts.error.message

string

required

attempts.error.name

string

attempts.error.stackTrace

string

attempts.createdAt

string

required

attempts.updatedAt

string

required

attempts.startedAt

string

attempts.completedAt

string

version

string

The version of the worker that executed the run

idempotencyKey

string

The idempotency key used to prevent creating duplicate runs, if provided

isTest

boolean

Whether the run is a test run or not

startedAt

string

The time the run started

finishedAt

string

The time the run finished

delayedUntil

string

If the run was triggered with a delay, this will be the time the run will be enqueued to execute

ttl

The time-to-live for this run. If the run is not executed within this time, it will be removed from the queue and never execute. You can use a string in this format: 1h, 1m, 1h42m or a number of seconds (min. 1).

expiredAt

string

If the run had a TTL and that time has passed, when the run "expired".

tags

string[]

Tags can be attached to a run to make it easy to find runs (in the dashboard or using SDK functions like runs.list)

metadata

object

The metadata of the run. See Metadata for more information.

costInCents

number

The compute cost of the run (so far) in cents. This cost does not apply to DEV runs.

baseCostInCents

number

The invocation cost of the run in cents. This cost does not apply to DEV runs.

durationMs

number

The duration of compute (so far) in milliseconds. This does not include waits.

depth

integer

The depth of the run in the task run hierarchy. The root run has a depth of 0.

batchId

string

The ID of the batch that this run belongs to

triggerFunction

enum<string>

The name of the function that triggered the run

Available options:

trigger,

triggerAndWait,

batchTrigger,

batchTriggerAndWait

payload

object

The payload that was sent to the task. Will be omitted if the request was made with a Public API key

payloadPresignedUrl

string

The presigned URL to download the payload. Will only be included if the payload is too large to be included in the response. Expires in 5 minutes.

output

object

The output of the run. Will be omitted if the request was made with a Public API key

outputPresignedUrl

string

The presigned URL to download the output. Will only be included if the output is too large to be included in the response. Expires in 5 minutes.

relatedRuns

object

Show child attributes

relatedRuns.root

object

The root run of the run hierarchy. Will be omitted if the run is the root run

Show child attributes

relatedRuns.root.id

string

required

The unique ID of the run, prefixed with run_

relatedRuns.root.status

enum<string>

required

The status of the run

Available options:

DELAYED,

WAITING_FOR_DEPLOY,

QUEUED,

EXECUTING,

REATTEMPTING,

FROZEN,

COMPLETED,

CANCELED,

FAILED,

CRASHED,

INTERRUPTED,

SYSTEM_FAILURE

relatedRuns.root.taskIdentifier

string

required

The identifier of the task that was run

relatedRuns.root.createdAt

string

required

relatedRuns.root.updatedAt

string

required

relatedRuns.root.version

string

The version of the worker that executed the run

relatedRuns.root.idempotencyKey

string

The idempotency key used to prevent creating duplicate runs, if provided

relatedRuns.root.isTest

boolean

Whether the run is a test run or not

relatedRuns.root.startedAt

string

The time the run started

relatedRuns.root.finishedAt

string

The time the run finished

relatedRuns.root.delayedUntil

string

If the run was triggered with a delay, this will be the time the run will be enqueued to execute

relatedRuns.root.ttl

The time-to-live for this run. If the run is not executed within this time, it will be removed from the queue and never execute. You can use a string in this format: 1h, 1m, 1h42m or a number of seconds (min. 1).

relatedRuns.root.expiredAt

string

If the run had a TTL and that time has passed, when the run "expired".

relatedRuns.root.tags

string[]

Tags can be attached to a run to make it easy to find runs (in the dashboard or using SDK functions like runs.list)

relatedRuns.root.metadata

object

The metadata of the run. See Metadata for more information.

relatedRuns.root.costInCents

number

The compute cost of the run (so far) in cents. This cost does not apply to DEV runs.

relatedRuns.root.baseCostInCents

number

The invocation cost of the run in cents. This cost does not apply to DEV runs.

relatedRuns.root.durationMs

number

The duration of compute (so far) in milliseconds. This does not include waits.

relatedRuns.root.depth

integer

The depth of the run in the task run hierarchy. The root run has a depth of 0.

relatedRuns.root.batchId

string

The ID of the batch that this run belongs to

relatedRuns.root.triggerFunction

enum<string>

The name of the function that triggered the run

Available options:

trigger,

triggerAndWait,

batchTrigger,

batchTriggerAndWait

relatedRuns.parent

object

The parent run of the run. Will be omitted if the run is the root run

Show child attributes

relatedRuns.parent.id

string

required

The unique ID of the run, prefixed with run_

relatedRuns.parent.status

enum<string>

required

The status of the run

Available options:

DELAYED,

WAITING_FOR_DEPLOY,

QUEUED,

EXECUTING,

REATTEMPTING,

FROZEN,

COMPLETED,

CANCELED,

FAILED,

CRASHED,

INTERRUPTED,

SYSTEM_FAILURE

relatedRuns.parent.taskIdentifier

string

required

The identifier of the task that was run

relatedRuns.parent.createdAt

string

required

relatedRuns.parent.updatedAt

string

required

relatedRuns.parent.version

string

The version of the worker that executed the run

relatedRuns.parent.idempotencyKey

string

The idempotency key used to prevent creating duplicate runs, if provided

relatedRuns.parent.isTest

boolean

Whether the run is a test run or not

relatedRuns.parent.startedAt

string

The time the run started

relatedRuns.parent.finishedAt

string

The time the run finished

relatedRuns.parent.delayedUntil

string

If the run was triggered with a delay, this will be the time the run will be enqueued to execute

relatedRuns.parent.ttl

The time-to-live for this run. If the run is not executed within this time, it will be removed from the queue and never execute. You can use a string in this format: 1h, 1m, 1h42m or a number of seconds (min. 1).

relatedRuns.parent.expiredAt

string

If the run had a TTL and that time has passed, when the run "expired".

relatedRuns.parent.tags

string[]

Tags can be attached to a run to make it easy to find runs (in the dashboard or using SDK functions like runs.list)

relatedRuns.parent.metadata

object

The metadata of the run. See Metadata for more information.

relatedRuns.parent.costInCents

number

The compute cost of the run (so far) in cents. This cost does not apply to DEV runs.

relatedRuns.parent.baseCostInCents

number

The invocation cost of the run in cents. This cost does not apply to DEV runs.

relatedRuns.parent.durationMs

number

The duration of compute (so far) in milliseconds. This does not include waits.

relatedRuns.parent.depth

integer

The depth of the run in the task run hierarchy. The root run has a depth of 0.

relatedRuns.parent.batchId

string

The ID of the batch that this run belongs to

relatedRuns.parent.triggerFunction

enum<string>

The name of the function that triggered the run

Available options:

trigger,

triggerAndWait,

batchTrigger,

batchTriggerAndWait

relatedRuns.children

object[]

The immediate children of the run. Will be omitted if the run has no children

Show child attributes

relatedRuns.children.id

string

required

The unique ID of the run, prefixed with run_

relatedRuns.children.status

enum<string>

required

The status of the run

Available options:

DELAYED,

WAITING_FOR_DEPLOY,

QUEUED,

EXECUTING,

REATTEMPTING,

FROZEN,

COMPLETED,

CANCELED,

FAILED,

CRASHED,

INTERRUPTED,

SYSTEM_FAILURE

relatedRuns.children.taskIdentifier

string

required

The identifier of the task that was run

relatedRuns.children.version

string

The version of the worker that executed the run

relatedRuns.children.idempotencyKey

string

The idempotency key used to prevent creating duplicate runs, if provided

relatedRuns.children.createdAt

string

required

relatedRuns.children.updatedAt

string

required

relatedRuns.children.isTest

boolean

Whether the run is a test run or not

relatedRuns.children.startedAt

string

The time the run started

relatedRuns.children.finishedAt

string

The time the run finished

relatedRuns.children.delayedUntil

string

If the run was triggered with a delay, this will be the time the run will be enqueued to execute

relatedRuns.children.ttl

The time-to-live for this run. If the run is not executed within this time, it will be removed from the queue and never execute. You can use a string in this format: 1h, 1m, 1h42m or a number of seconds (min. 1).

relatedRuns.children.expiredAt

string

If the run had a TTL and that time has passed, when the run "expired".

relatedRuns.children.tags

string[]

Tags can be attached to a run to make it easy to find runs (in the dashboard or using SDK functions like runs.list)

relatedRuns.children.metadata

object

The metadata of the run. See Metadata for more information.

relatedRuns.children.costInCents

number

The compute cost of the run (so far) in cents. This cost does not apply to DEV runs.

relatedRuns.children.baseCostInCents

number

The invocation cost of the run in cents. This cost does not apply to DEV runs.

relatedRuns.children.durationMs

number

The duration of compute (so far) in milliseconds. This does not include waits.

relatedRuns.children.depth

integer

The depth of the run in the task run hierarchy. The root run has a depth of 0.

relatedRuns.children.batchId

string

The ID of the batch that this run belongs to

relatedRuns.children.triggerFunction

enum<string>

The name of the function that triggered the run

Available options:

trigger,

triggerAndWait,

batchTrigger,

batchTriggerAndWait

schedule

object

The schedule that triggered the run. Will be omitted if the run was not triggered by a schedule

Show child attributes

schedule.id

string

required

The unique ID of the schedule, prefixed with sched_

schedule.generator

object

required

Show child attributes

schedule.generator.type

enum<string>

Available options:

CRON

schedule.generator.expression

string

The cron expression used to generate the schedule

schedule.generator.description

string

The description of the generator in plain english

schedule.externalId

string

The external ID of the schedule. Can be anything that is useful to you (e.g., user ID, org ID, etc.)

schedule.deduplicationKey

string

The deduplication key used to prevent creating duplicate schedules