Skip to main content
POST
/
api
/
v1
/
deploy
/
lock
Acquire deploy lock
curl --request POST \
  --url https://api.devhelm.io/api/v1/deploy/lock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lockedBy": "<string>",
  "ttlMinutes": 30
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lockedBy": "<string>",
    "lockedAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Body

application/json

Request to acquire a deploy lock for the current workspace

​
lockedBy
string
required

Identity of the lock requester (e.g. hostname, CI job ID)

Minimum string length: 1
​
ttlMinutes
integer<int32> | null

Lock TTL in minutes (default: 30, max: 60)

Example:

30

Response

201 - */*

Created

​
data
object

Represents an active deploy lock for a workspace