Skip to main content
PATCH
/
api
/
v1
/
worker-queues
/
{queue_id}
Update Worker Queue
curl --request PATCH \
  --url https://control-plane.kubiya.ai/api/v1/worker-queues/{queue_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "max_workers": 2,
  "heartbeat_interval": 155,
  "tags": [
    "<string>"
  ],
  "settings": {}
}
'
{
  "id": "<string>",
  "organization_id": "<string>",
  "environment_id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "max_workers": 123,
  "heartbeat_interval": 123,
  "tags": [
    "<string>"
  ],
  "settings": {},
  "created_at": "<string>",
  "updated_at": "<string>",
  "created_by": "<string>",
  "task_queue_name": "<string>",
  "active_workers": 0
}

Authorizations

Authorization
string
header
required

Path Parameters

queue_id
string
required

Body

application/json
name
string | null
Required string length: 2 - 50
display_name
string | null
description
string | null
status
string | null
max_workers
integer | null
Required range: x >= 1
heartbeat_interval
integer | null
Required range: 10 <= x <= 300
tags
string[] | null
settings
Settings · object

Response

Successful Response

id
string
required
organization_id
string
required
environment_id
string
required
name
string
required
display_name
string | null
required
description
string | null
required
status
string
required
max_workers
integer | null
required
heartbeat_interval
integer
required
tags
string[]
required
settings
Settings · object
required
created_at
string
required
updated_at
string
required
created_by
string | null
required
task_queue_name
string
required
active_workers
integer
default:0