Skip to main content
POST
/
api
/
v1
/
queues
/
{queueParam}
/
pause
TypeScript
import { queues } from "@trigger.dev/sdk";

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

// Resume a queue
await queues.resume("queue_1234");
await queues.resume({ type: "task", name: "my-task-id" });
curl --request POST \
  --url https://api.trigger.dev/api/v1/queues/{queueParam}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "id"
}'
import requests

url = "https://api.trigger.dev/api/v1/queues/{queueParam}/pause"

payload = { "type": "id" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'id'})
};

fetch('https://api.trigger.dev/api/v1/queues/{queueParam}/pause', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trigger.dev/api/v1/queues/{queueParam}/pause",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'id'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trigger.dev/api/v1/queues/{queueParam}/pause"

	payload := strings.NewReader("{\n  \"type\": \"id\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.trigger.dev/api/v1/queues/{queueParam}/pause")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"id\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.trigger.dev/api/v1/queues/{queueParam}/pause")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"id\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "queue_1234",
  "name": "my-task-id",
  "type": "task",
  "running": 5,
  "queued": 10,
  "paused": false,
  "concurrencyLimit": 10,
  "concurrency": {
    "current": 10,
    "base": 10,
    "override": null,
    "overriddenAt": null,
    "overriddenBy": null
  }
}

Authorizations

​
Authorization
string
header
required

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";

configure({ accessToken: "tr_dev_1234" });

Path Parameters

​
queueParam
string
required

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

Body

application/json
​
action
enum<string>
required

Whether to pause or resume the queue

Available options:
pause,
resume
​
type
enum<string>
default:id

How to interpret the queueParam path parameter:

  • id: Treat as a queue ID (default)
  • task: Treat as a task ID to get the task's default queue
  • custom: Treat as a custom queue name
Available options:
id,
task,
custom

Response

Queue paused or resumed successfully

​
id
string
required

The queue ID, e.g., queue_1234

Example:

"queue_1234"

​
name
string
required

The queue name. For task queues, this is the task ID. For custom queues, this is the name you specified.

Example:

"my-task-id"

​
type
enum<string>
required

The type of queue:

  • task: Created automatically for each task
  • custom: Created explicitly in your code using queue()
Available options:
task,
custom
Example:

"task"

​
running
integer
required

The number of runs currently executing

Example:

5

​
queued
integer
required

The number of runs currently queued

Example:

10

​
paused
boolean
required

Whether the queue is paused. When paused, no new runs will start.

Example:

false

​
concurrencyLimit
integer | null

The current concurrency limit of the queue

Example:

10

​
concurrency
object

Detailed concurrency information