SFTPGo Octri Preview
GET/saas/usage

Retrieve SaaS usage metrics

Returns the current usage statistics for your SaaS installation. This endpoint is available only when running SFTPGo as a service

6 status codes
200successful operation
bandwidth_allowedintegeroptional
bandwidth_usedintegeroptional
storage_allowedintegeroptional
storage_usedintegeroptional
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
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 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.