Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
GETAgentSince 1.0SynchronousAuth Required

GetLockStatus

Get the current lock status and holder information for a specific agent

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • agentIdStringRequired

    UUID of the agent whose lock status to query

Responses

200 OK

On success, this API returns the following response structure.

  • agentIdString

    UUID of the agent on which the lock is held

    Example: agent-abc123-def456

  • operationTypeString

    Type of operation for which the lock was acquired

    Example: upgrade

  • holderString

    Current holder of the lock

    Example: upgrade-service

  • acquiredAtString

    Acquired at

    Example: 2026-01-15T08:00:00Z

  • expiresAtString

    Expires at

    Example: 2026-01-15T08:00:00Z

  • lockTokenString

    Token associated with this lock for release verification

    Example: lock-token-abc123

Endpoint

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

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

Operation ID

GetLockStatus

Permalink

Request Example

curl -X GET '{host}/api/v1/agents/locks/{agentId}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "agentId": "agent-abc123-def456",
  "operationType": "upgrade",
  "holder": "upgrade-service",
  "acquiredAt": "example",
  "expiresAt": "example",
  "lockToken": "lock-token-abc123"
}

Change History

This API has no change history records yet.

View all change history