Skip to main content
POST
/
presence
/
locks
/
{resource_id}
Acquire Lock
curl --request POST \
  --url https://api.example.com/presence/locks/{resource_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "<string>"
}
'
{
  "resource_id": "<string>",
  "agent_id": "<string>",
  "organization_id": "<string>",
  "acquired_at": "2023-11-07T05:31:56Z"
}

Path Parameters

​
resource_id
string
required

Body

application/json

Request body for acquiring an advisory lock.

Attributes: agent_id: ID of the agent requesting the lock.

​
agent_id
string
required

Response

Successful Response

Advisory lock on a resource.

Attributes: resource_id: ID of the locked resource. agent_id: ID of the agent holding the lock. organization_id: Organization the lock belongs to. acquired_at: Timestamp when the lock was acquired.

​
resource_id
string
required
​
agent_id
string
required
​
organization_id
string
required
​
acquired_at
string<date-time>