SFTPGo Octri Preview
PUT/quotas/folders/{name}/usage

Update folder quota usage

Updates the used file count and storage size for a virtual folder. Use mode to add the supplied values to current usage or reset usage to the supplied values; omitted values default to zero, with different effects depending on the mode.

2 parameters · 2 body fields
namestringrequired
The name of the virtual folder whose quota usage to update.
modestringoptional
Update mode: `add` adds the supplied values to current usage, while `reset` sets usage to the supplied values. Defaults to `reset` when omitted.
Allowed:addreset

Quota usage values to add or set. If used_quota_files or used_quota_size is omitted, it defaults to zero; in add mode the omitted value leaves that usage unchanged, while in reset mode it sets that usage to zero.

used_quota_filesintegeroptional
The number of files to add to current usage or set as the exact used file count.
used_quota_sizeintegeroptional
The number of bytes to add to current usage or set as the exact used storage size.

8 status codes
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 folder quota usage.
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
409Returned when the quota usage update conflicts with the folder's current state.
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 for an invalid request, a 401 when authentication is missing or invalid, and a 403 when the authenticated user is not permitted to update quota usage. A 404 is returned when the folder does not exist, a 409 when the update conflicts with the folder's current state, and a 500 when the server encounters an internal error. The name path parameter must identify the folder to update.