Download OpenAPI specification:
The Lock API allows clients to create, retrieve, and delete locks.
Get all locks from the database
Note: Use with caution on large datasets as this performs a full table scan
| offset | integer (Offset) >= 0 Default: 0 Number of items to skip for pagination |
| limit | integer (Limit) [ 1 .. 100 ] Default: 100 Maximum number of items to return |
required | Authorization (string) or Authorization (null) (Authorization) |
[- {
- "lock_key": "string",
- "created_at": 0,
- "last_updated_at": 0,
- "expiration": 0
}
]Create a new lock
required | Authorization (string) or Authorization (null) (Authorization) |
| lock_key required | string (Lock Key) [ 1 .. 100 ] characters |
| expiration required | integer (Expiration) |
{- "lock_key": "string",
- "expiration": 0
}{- "lock_key": "string",
- "created_at": 0,
- "last_updated_at": 0,
- "expiration": 0
}Create a new lock
| lock_key required | string (Lock Key) |
required | Authorization (string) or Authorization (null) (Authorization) |
| expiration required | integer (Expiration) |
{- "expiration": 0
}{- "lock_key": "string",
- "created_at": 0,
- "last_updated_at": 0,
- "expiration": 0
}Get all locks with a specific lock_id (across all clients)
| lock_key required | string (Lock Key) |
required | Authorization (string) or Authorization (null) (Authorization) |
{- "lock_key": "string",
- "created_at": 0,
- "last_updated_at": 0,
- "expiration": 0
}Delete a lock by lock_id and client_id
| lock_key required | string (Lock Key) |
required | Authorization (string) or Authorization (null) (Authorization) |
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}