PUT
/folders/{name}Update a virtual folder
Updates the configuration of an existing virtual folder. Identify the folder with name and provide its configuration in the request body. Use filesystem.provider to select the active storage configuration; unused provider configurations are ignored or cleared when saved.
namestringrequired
The unique name of the virtual folder to update.
Virtual folder configuration, including its unique name, storage filesystem, and quota usage values. name is required.
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
Server-generated folder identifier; this field is read-only.
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
Current used quota as a number of files.
used_quota_sizeintegeroptional
Current used quota as a size in bytes.
usersarray<string>optional
list of usernames associated with this virtual folder
200Returns an object with a message and an optional error description.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
400Returned when the request is invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when authentication is missing or invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when the authenticated user is not permitted to update the folder.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Returned when the specified folder does not exist.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when the server encounters an internal 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 when the request is invalid, a 401 when authentication is missing or invalid, and a 403 when the authenticated user is not permitted to update the folder. A 404 is returned when the folder does not exist, and a 500 when the server encounters an internal error. The name body field is required.