Skip to main content

​
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

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

​
Request body

​
action
string
required
"pause" to pause the queue, or "resume" to resume it.
​
type
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:
​
id
string
Queue ID.
​
name
string
Queue name.
​
type
string
task or custom.
​
running
integer
Runs currently executing.
​
queued
integer
Runs currently waiting.
​
paused
boolean
The updated pause state.
​
concurrencyLimit
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" });

​
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
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us