v4

latestSwagger 2.02026-08-0343714211.7 MB

locks

Locks

List Locks by Path

get/locks/{path}

Path parameters

pathstring required

Path to operate on.

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

include_childrenboolean

Include locks from children objects?

Response

A list of Locks objects.

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"
  }
]