v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB

folders

Get folders

Returns an array with one or more folders

get/folders

Query parameters

offsetinteger

limitinteger

The maximum number of items to return. Max value is 500, default is 100

order'ASC' | 'DESC'

Example:ASC

Ordering folders by name. Default ASC

Response

successful operation

idinteger

namestring

unique name for this virtual folder

mapped_pathstring

absolute filesystem path to use as virtual folder

descriptionstring

optional description

used_quota_sizeinteger

used_quota_filesinteger

last_quota_updateinteger

Last quota update as unix timestamp in milliseconds

usersstring[]

list of usernames associated with this virtual folder

Example response

[
  {
    "filesystem": {
      "s3config": {
        "key_prefix": "folder/subfolder/"
      },
      "gcsconfig": {
        "key_prefix": "folder/subfolder/"
      },
      "azblobconfig": {
        "key_prefix": "folder/subfolder/"
      },
      "sftpconfig": {
        "buffer_size": 2
      }
    }
  }
]