Get a portal quota

GET /api/2.0/portal/quota

Request

Returns the current portal quota.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Examples

GET /api/2.0/portal/quota HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/portal/quota \
  --header 'Accept: application/json'

Responses

200

Current portal quota

tenantIdintegerformat: int32

Tenant ID

namestring

Name

pricenumberformat: double

Price

priceCurrencySymbolstring

Price currency symbol

productIdstring

Product ID

visibleboolean

Specifies if the tenant quota is visible or not

featuresstring

Tenant quota features

maxFileSizeintegerformat: int64

Maximum file size

maxTotalSizeintegerformat: int64

Maximum total size

countUserintegerformat: int32

Number of portal users

countRoomAdminintegerformat: int32

Number of portal room administrators

usersInRoomintegerformat: int32

Number of room users

countRoomintegerformat: int32

Number of rooms

nonProfitboolean

Specifies if the tenant quota is nonprofit or not

trialboolean

Specifies if the tenant quota is trial or not

freeboolean

Specifies if the tenant quota is free or not

updateboolean

Specifies if the tenant quota is updated or not

auditboolean

Specifies if the audit trail is available or not

docsEditionboolean

Specifies if this tenant quota is Docs edition or not

ldapboolean

Specifies if the LDAP settings are available or not

ssoboolean

Specifies if the SSO settings are available or not

statisticboolean

Specifies if the statistic settings are available or not

brandingboolean

Specifies if the branding settings are available or not

customizationboolean

Specifies if the customization settings are available or not

lifetimeboolean

Specifies if the license is lifetime or not

customboolean

Specifies if the custom domain URL is available or not

autoBackupRestoreboolean

Specifies if the automatic Backup&Restore feature is available or not

oauthboolean

Specifies if Oauth is available or not

contentSearchboolean

Specifies if the content search is available or not

thirdPartyboolean

Specifies if the third-party accounts linking is available or not

401

Unauthorized

403

No permissions to perform this action

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).