Pause or Resume Queue

Overview

Toggle the paused state of a queue. When a queue is paused, no new runs will be dequeued and started. Runs that are currently executing continue to completion. Queues can be addressed by:

Queue ID (queue_1234)
Task ID (type: "task") — targets the default queue for that task
Custom queue name (type: "custom") — targets a named custom queue

Authentication with a secret key is required.

Endpoint

POST https://api.trigger.dev/api/v1/queues/{queueParam}/pause

Path parameters

string

required

The queue ID (e.g. queue_1234), or the task/custom queue name when using the type body parameter.

Request body

string

required

"pause" to pause the queue, or "resume" to resume it.

string

How to interpret queueParam. One of:

"id" (default) — treat as a queue ID
"task" — treat as a task ID and target the task’s default queue
"custom" — treat as a custom queue name

Response

Returns the updated Queue object:

string

Queue ID.

string

Queue name.

string

task or custom.

integer

Runs currently executing.

integer

Runs currently waiting.

boolean

The updated pause state.

integer | null

Effective concurrency limit.

Examples

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

// Pause by queue ID
await queues.pause("queue_1234");

// Pause a task's default queue
await queues.pause({ type: "task", name: "my-task-id" });

// Pause a custom queue
await queues.pause({ type: "custom", name: "email-queue" });

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

// Resume by queue ID
await queues.resume("queue_1234");

// Resume a task's default queue
await queues.resume({ type: "task", name: "my-task-id" });

curl -X POST "https://api.trigger.dev/api/v1/queues/queue_1234/pause" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_dev_1234" \
  -d '{"action": "pause"}'

curl -X POST "https://api.trigger.dev/api/v1/queues/my-task-id/pause" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_dev_1234" \
  -d '{"type": "task", "action": "pause"}'

curl -X POST "https://api.trigger.dev/api/v1/queues/queue_1234/pause" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_dev_1234" \
  -d '{"action": "resume"}'

Response example

{
  "id": "queue_1234",
  "name": "my-task",
  "type": "task",
  "running": 2,
  "queued": 8,
  "paused": true,
  "concurrencyLimit": 10,
  "concurrency": {
    "current": 10,
    "base": 10,
    "override": null,
    "overriddenAt": null,
    "overriddenBy": null
  }
}

Overview

Tasks & Runs

Schedules & Queues

Waitpoints & Env Vars

Pause or Resume Queue

Overview

Endpoint

Path parameters

Request body

Response

Examples

Response example

​Overview

​Endpoint

​Path parameters

​Request body

​Response

​Examples

​Response example

Overview

Endpoint

Path parameters

Request body

Response

Examples

Response example