Skip to main content
ZStack
Infrastructure/Agents

ReleaseLock

Release a held lock on an agent using the lock token for authorization

DELETE/api/v1/agents/locks/{agentId}

Operation ID

ReleaseLock

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • agentId
    StringRequired

    UUID of the agent whose lock to release

Query Parameters

  • lockToken
    String

    Token proving ownership of the lock being released Token proving ownership of the lock being released

Responses

200 OK

DELETE endpoints return an empty object on success, or a standard error structure on failure.

Success Response

{}

Error Response

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Delete resource timeout after 300s"
  }
}