GET
/folders/{name}Get folder by name
Returns the virtual folder with the given name if it exists
namestringrequired
folder name
confidential_dataintegeroptional
If set to 1 confidential data will not be hidden. This means that the response will contain the key and additional data for secrets. Ignored if the * permission is not granted.
200successful operation
descriptionstringoptional
Optional free-form description.
filesystemobjectoptional
Storage filesystem details. The `provider` field selects which sub-config is active — all other sub-configs are ignored / cleared on save. See `FsProviders` for the mapping.
* `provider: -1` → no sub-config (None; users and groups)
* `provider: 0` → `osconfig` (local; root is the user's `home_dir`)
* `provider: 1` → `s3config`
* `provider: 2` → `gcsconfig`
* `provider: 3` → `azblobconfig`
* `provider: 4` → `cryptconfig` (encrypted local; root is the user's `home_dir`)
* `provider: 5` → `sftpconfig`
* `provider: 6` → `httpconfig`
* `provider: 7` → `ftpconfig`
groupsarray<string>optional
list of groups associated with this virtual folder
idintegeroptional
last_quota_updateintegeroptional
Last quota update as unix timestamp in milliseconds
mapped_pathstringoptional
Absolute filesystem path used as the virtual folder's storage root. Only meaningful when `filesystem.provider` is 0 (local) or 4 (encrypted local); ignored for cloud providers, which reference a bucket/container via `filesystem.*config`.
namestringrequired
Unique name for this virtual folder (server-side identifier; not shown to end users).
rolestringoptional
Role name. A folder carrying a role with `resource_isolation` enabled is visible to the admins carrying the same role, it is reachable from the groups and the accounts of that role and its storage is measured against the allowlist of the role. An admin carrying a role receives that role on the folders it creates. On update the body replaces the stored role: omitting it clears the role, and the change is refused while accounts or groups of another role reference the folder
used_quota_filesintegeroptional
used_quota_sizeintegeroptional
usersarray<string>optional
list of usernames associated with this virtual folder
400Bad Request
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Not Found
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
Error handling
A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 404 is returned: Not Found. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.