Retrieve concurrency limit
Changed onRetrieve a concurrency limit by name, with its bounds and live running and queued counts. With the concurrencyKey query parameter, retrieve the limit's view for that one key instead (its per-key bound, any per-key override and when it expires, and the runs executing for the key).
Request
- Base URLhttps://api.trigger.dev
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The limit's name, as declared with concurrencyLimit()
Query parameters
Return the view for this concurrencyKey instead of the limit itself.
Response
Concurrency limit retrieved successfully
Example response
{
"id": "climit_abcdef123456",
"name": "openai",
"total": {
"current": 25,
"base": 25
},
"running": 14,
"queued": 100
}Changes
- breaking
added to the response body
oneOflist for the response status - breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - warning
removed the optional property
from the response with the status - info
added the new optional
queryrequest parameterconcurrencyKey
- breaking
- info
added the optional property
to the response with the status
- info