Override Concurrency Limit
Override the concurrency limit of a queue. This is useful for temporarily scaling up or down based on demand.
Authorizations
Use a named environment API key. It starts with tr_dev_sk_, tr_prod_sk_, tr_stg_sk_, etc.
Create a named API key in the API Keys section of your Trigger.dev project dashboard. Choose the narrowest access preset that supports your integration.
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.
Path Parameters
The queue ID (e.g., queue_1234), or the name of the queue when using the type body parameter.
Body
The new concurrency limit to set for the queue. It may not exceed your environment's maximum concurrency limit: a higher value is rejected with a 400, not capped to the maximum.
0 <= x <= 100000How 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 queuecustom: Treat as a custom queue name
id, task, custom Response
Concurrency limit overridden successfully
The queue ID, e.g., queue_1234
"queue_1234"
The queue name. For task queues, this is the task ID. For custom queues, this is the name you specified.
"my-task-id"
The type of queue:
task: Created automatically for each taskcustom: Created explicitly in your code usingqueue()
task, custom "task"
Discriminates the shape:
V1: the queue carries its ownconcurrencyLimit(applied per key when runs pass aconcurrencyKey, to the whole queue when they don't) and itsconcurrencyoverride stateV2: the queue is only the line runs wait in; concurrency is declared with the taskconcurrencyoption and managed through the concurrency-limits endpoints.concurrencyLimitis always null andconcurrencyis absent.
V1, V2 "V1"
The number of runs currently executing
5
The number of runs currently queued
10
Whether the queue is paused. When paused, no new runs will start.
false
The queue's own concurrency limit. Meaningful on V1 queues; always null on V2 queues.
10
Detailed concurrency information. V1 queues only.

