v4

latestSwagger 2.02026-08-0343714211.7 MB

locks

Locks

Create Lock

post/locks/{path}

Path parameters

pathstring required

Path

Response

The Locks object.

pathstring

Path

timeoutinteger

Lock timeout in seconds

depthstring

recursiveboolean

Does lock apply to subfolders?

ownerstring

Owner of the lock. This can be any arbitrary string.

scopestring

exclusiveboolean

Is lock exclusive?

tokenstring

Lock token. Use to release lock.

typestring

allow_access_by_any_userboolean

Can lock be modified by users other than its creator?

user_idinteger

Lock creator user ID

usernamestring

Lock creator username

Example response

{
  "path": "locked_file",
  "timeout": 1,
  "depth": "infinity",
  "recursive": true,
  "owner": "user",
  "scope": "shared",
  "token": "17c54824e9931a4688ca032d03f6663c",
  "type": "write",
  "user_id": 1,
  "username": "username"
}