v1

latestOpenAPI 3.1.0MIT2026-07-1799111346.8 KB

List objects

Lists objects and directories for a remote path, returning the same fields as rclone lsjson.

post/operations/list

Query parameters

fsstring

Remote name or path to list, for example drive:.

remotestring

Directory path within fs to list; leave empty to target the root.

optstring

Optional JSON-encoded object of listing flags (e.g. { "recurse": true, "showHash": true }).

recurseboolean

Set to true to list directories recursively.

noModTimeboolean

Set to true to omit modification times for faster listings on some backends.

showEncryptedboolean

Set to true to include encrypted names when using crypt remotes.

showOrigIDsboolean

Set to true to include original backend identifiers where available.

showHashboolean

Set to true to include hash digests for each entry.

noMimeTypeboolean

Set to true to omit MIME type detection.

dirsOnlyboolean

Set to true to return only directory entries.

filesOnlyboolean

Set to true to return only file entries.

metadataboolean

Set to true to include backend-provided metadata maps.

hashTypesstring[]

Specify one or more hash algorithms to include when showHash is true (e.g. md5).

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Headers

Prefer'respond-async'

Set to "respond-async" with _async=true to receive HTTP 202 instead of 200.

Request body

fsstring

Remote name or path to list, for example drive:.

remotestring

Directory path within fs to list; leave empty to target the root.

optstring

Optional JSON-encoded object of listing flags (e.g. { "recurse": true, "showHash": true }).

recurseboolean

Set to true to list directories recursively.

noModTimeboolean

Set to true to omit modification times for faster listings on some backends.

showEncryptedboolean

Set to true to include encrypted names when using crypt remotes.

showOrigIDsboolean

Set to true to include original backend identifiers where available.

showHashboolean

Set to true to include hash digests for each entry.

noMimeTypeboolean

Set to true to omit MIME type detection.

dirsOnlyboolean

Set to true to return only directory entries.

filesOnlyboolean

Set to true to return only file entries.

metadataboolean

Set to true to include backend-provided metadata maps.

hashTypesstring[]

Specify one or more hash algorithms to include when showHash is true (e.g. md5).

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Response

Directory listing entries from operations/list, mirroring the lsjson format.