Distributed Lock API reference

This endpoint lets you acquire a lock by supplying a named lock owner and the resource ID to lock.

URL Parameters

Query Parameters

None

HTTP Response codes

HTTP Request Body

{
    "resourceId": "",
    "lockOwner": "",
    "expiryInSeconds": 0
}

The lock endpoint returns the following payload:

Examples

curl -X POST http://localhost:3500/v1.0-alpha/lock/redisStore \
  -H "Content-Type: application/json" \
  -d '{
        "resourceId": "lock1",
        "expiryInSeconds": 60
      }'
    "success": "true"
}

Unlock

This endpoint lets you unlock an existing lock based on the lock owner and resource Id

HTTP Request

URL Parameters

Query Parameters

HTTP Request Body

The unlock endpoint receives the following JSON payload:

{
    "resourceId": "",
}

HTTP Response Body

The unlock endpoint returns the following payload:

curl -X POST http://localhost:3500/v1.0-alpha/unlock/redisStore \
  -H "Content-Type: application/json" \
  -d '{
        "resourceId": "lock1",
        "lockOwner": "vader"
      }'
{