Skip to main content
POST
/
api
/
v1
/
worker-queues
/
{queue_id}
/
workers
/
{worker_id}
/
update-lock
Acquire Update Lock
curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/worker-queues/{queue_id}/workers/{worker_id}/update-lock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "worker_id": "<string>",
  "lock_duration_seconds": 300
}
'
{
  "lock_id": "<string>",
  "worker_id": "<string>",
  "queue_id": "<string>",
  "acquired_at": "<string>",
  "expires_at": "<string>",
  "locked": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.kubiya.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

​
queue_id
string
required
​
worker_id
string
required

Body

application/json

Request to acquire an update lock for coordinated rolling updates

​
worker_id
string
required
​
lock_duration_seconds
integer
default:300

Lock TTL (60-600 seconds)

Required range: 60 <= x <= 600

Response

Successful Response

Response with update lock information

​
lock_id
string
required
​
worker_id
string
required
​
queue_id
string
required
​
acquired_at
string
required
​
expires_at
string
required
​
locked
boolean
required