ONLYOFFICE DocSpace Settings API

The browsable version of this reference, with a request builder and code samples, is published at https://api.onlyoffice.com/docspace/api-backend/usage-api/.

All URIs are relative to https://yourportal.onlyoffice.com, where the host is the address of your DocSpace instance.

Access to DevTools

Method	HTTP request	Description
getTenantAccessDevToolsSettings	GET /api/2.0/settings/devtoolsaccess	Get the Developer Tools access settings

Authorization

Method	HTTP request	Description
getAuthServices	GET /api/2.0/settings/authservice	Get the authorization services
saveAuthKeys	POST /api/2.0/settings/authservice	Save the authorization keys
testExternalDatabaseConnection	POST /api/2.0/settings/authservice/externaldb/test	Test external database connection

Banners visibility

Method	HTTP request	Description
getTenantBannerSettings	GET /api/2.0/settings/banner	Get the banners visibility

Common settings

Method	HTTP request	Description
closeAdminHelper	PUT /api/2.0/settings/closeadminhelper	Close the admin helper
completeWizard	PUT /api/2.0/settings/wizard/complete	Complete the Wizard settings
configureDeepLink	POST /api/2.0/settings/deeplink	Configure the deep link settings
deletePortalColorTheme	DELETE /api/2.0/settings/colortheme	Delete a color theme
getDeepLinkSettings	GET /api/2.0/settings/deeplink	Get the deep link settings
getPaymentSettings	GET /api/2.0/settings/payment	Get the payment settings
getPortalColorTheme	GET /api/2.0/settings/colortheme	Get a color theme
getPortalHostname	GET /api/2.0/settings/machine	Get the portal hostname
getPortalLogo	GET /api/2.0/settings/logo	Get a portal logo
getPortalSettings	GET /api/2.0/settings	Get the portal settings
getSocketSettings	GET /api/2.0/settings/socket	Get the socket settings
getSupportedCultures	GET /api/2.0/settings/cultures	Get supported languages
getTenantAiAccessSettings	GET /api/2.0/settings/ai-access	Get the AI access settings
getTenantUserInvitationSettings	GET /api/2.0/settings/invitationsettings	Get the user invitation settings
getTimeZones	GET /api/2.0/settings/timezones	Get time zones
saveDefaultFolder	PUT /api/2.0/settings/defaultfolder	Set the default folder
saveDnsSettings	PUT /api/2.0/settings/dns	Save the DNS settings
saveMailDomainSettings	POST /api/2.0/settings/maildomainsettings	Save the mail domain settings
savePortalColorTheme	PUT /api/2.0/settings/colortheme	Save a color theme
setTenantAiAccessSettings	POST /api/2.0/settings/ai-access	Set the AI access settings
updateEmailActivationSettings	PUT /api/2.0/settings/emailactivation	Update the email activation settings
updateInvitationSettings	PUT /api/2.0/settings/invitationsettings	Update the user invitation settings

Cookies

Method	HTTP request	Description
getCookieSettings	GET /api/2.0/settings/cookiesettings	Get the cookie lifetime settings
updateCookieSettings	PUT /api/2.0/settings/cookiesettings	Update the cookie lifetime settings

DocsCloud

Method	HTTP request	Description
calculateDevPack	POST /api/2.0/settings/docscloud/calculatedevpack	Calculate the Docs Connect Dev Pack switch cost
createTenantQuotaReport	POST /api/2.0/settings/docscloud/tenant/quota/report	Start the Docs Connect quota report
getTenant	GET /api/2.0/settings/docscloud/tenant	Get the Docs Connect tenant
getTenantConfig	GET /api/2.0/settings/docscloud/tenant/config	Get the Docs Connect tenant configuration
getTenantInfo	GET /api/2.0/settings/docscloud/tenant/info	Get the Docs Connect tenant information
getTenantQuota	GET /api/2.0/settings/docscloud/tenant/quota	Get the Docs Connect tenant quota
getTenantQuotaReport	GET /api/2.0/settings/docscloud/tenant/quota/report	Get the Docs Connect quota report status
getTenantUsage	GET /api/2.0/settings/docscloud/tenant/usage	Get the Docs Connect tenant usage
startDocsCloudTrial	POST /api/2.0/settings/docscloud/trial	Start the Docs Connect trial
switchToDevPack	POST /api/2.0/settings/docscloud/switchtodevpack	Switch Docs Connect to Docs Connect Dev Pack
terminateTenantQuotaReport	DELETE /api/2.0/settings/docscloud/tenant/quota/report	Terminate the Docs Connect quota report
updateTenantConfig	PUT /api/2.0/settings/docscloud/tenant/config	Update the Docs Connect tenant configuration

Encryption

Method	HTTP request	Description
getStorageEncryptionProgress	GET /api/2.0/settings/encryption/progress	Get the storage encryption progress
getStorageEncryptionSettings	GET /api/2.0/settings/encryption/settings	Get the storage encryption settings
startStorageEncryption	POST /api/2.0/settings/encryption/start	Start the storage encryption

Greeting settings

Method	HTTP request	Description
getGreetingSettings	GET /api/2.0/settings/greetingsettings	Get greeting settings
getIsDefaultGreetingSettings	GET /api/2.0/settings/greetingsettings/isdefault	Check the default greeting settings
restoreGreetingSettings	POST /api/2.0/settings/greetingsettings/restore	Restore the greeting settings
saveGreetingSettings	POST /api/2.0/settings/greetingsettings	Save the greeting settings

IP restrictions

Method	HTTP request	Description
getIpRestrictions	GET /api/2.0/settings/iprestrictions	Get IP restrictions
readIpRestrictionsSettings	GET /api/2.0/settings/iprestrictions/settings	Get IP restriction settings
saveIpRestrictions	PUT /api/2.0/settings/iprestrictions	Save IP restrictions
updateIpRestrictionsSettings	PUT /api/2.0/settings/iprestrictions/settings	Update IP restriction settings

License

Method	HTTP request	Description
acceptLicense	POST /api/2.0/settings/license/accept	Activate a license
getIsLicenseRequired	GET /api/2.0/settings/license/required	Check if a license is required
refreshLicense	GET /api/2.0/settings/license/refresh	Refresh the license
uploadLicense	POST /api/2.0/settings/license	Upload a license

Login settings

Method	HTTP request	Description
getLoginSettings	GET /api/2.0/settings/security/loginsettings	Get login settings
setDefaultLoginSettings	DELETE /api/2.0/settings/security/loginsettings	Reset login settings
updateLoginSettings	PUT /api/2.0/settings/security/loginsettings	Update login settings

Messages

Method	HTTP request	Description
enableAdminMessageSettings	POST /api/2.0/settings/messagesettings	Enable or disable administrator messages
sendAdminMail	POST /api/2.0/settings/sendadmmail	Send a message to the administrator
sendJoinInviteMail	POST /api/2.0/settings/sendjoininvite	Send an invitation email

Notifications

Method	HTTP request	Description
getNotificationChannels	GET /api/2.0/settings/notification/channels	Get notification channels
getNotificationSettings	GET /api/2.0/settings/notification/{type}	Check notification availability
getRoomsNotificationSettings	GET /api/2.0/settings/notification/rooms	Get muted rooms
setNotificationSettings	POST /api/2.0/settings/notification	Set notification status
setRoomsNotificationStatus	POST /api/2.0/settings/notification/rooms	Mute or unmute a room

Owner

Method	HTTP request	Description
sendOwnerChangeInstructions	POST /api/2.0/settings/owner	Start the portal owner change
updatePortalOwner	PUT /api/2.0/settings/owner	Confirm the portal owner change

Quota

Method	HTTP request	Description
getUserQuotaSettings	GET /api/2.0/settings/userquotasettings	Get the user quota settings
saveAiAgentQuotaSettings	POST /api/2.0/settings/aiagentquotasettings	Save the AI Agent quota settings
saveRoomQuotaSettings	POST /api/2.0/settings/roomquotasettings	Save the room quota settings
setTenantQuotaSettings	PUT /api/2.0/settings/tenantquotasettings	Save the tenant quota settings

Rebranding

Method	HTTP request	Description
deleteAdditionalWhiteLabelSettings	DELETE /api/2.0/settings/rebranding/additional	Delete the additional white label settings
deleteCompanyWhiteLabelSettings	DELETE /api/2.0/settings/rebranding/company	Delete the company white label settings
getAdditionalWhiteLabelSettings	GET /api/2.0/settings/rebranding/additional	Get the additional white label settings
getCompanyWhiteLabelSettings	GET /api/2.0/settings/rebranding/company	Get the company white label settings
getEnableWhitelabel	GET /api/2.0/settings/enablewhitelabel	Check the white label availability
getIsDefaultWhiteLabelLogoText	GET /api/2.0/settings/whitelabel/logotext/isdefault	Check the default logo text
getIsDefaultWhiteLabelLogos	GET /api/2.0/settings/whitelabel/logos/isdefault	Check the default white label logos
getLicensorData	GET /api/2.0/settings/companywhitelabel	Get the licensor data
getWhiteLabelLogoText	GET /api/2.0/settings/whitelabel/logotext	Get the white label logo text
getWhiteLabelLogos	GET /api/2.0/settings/whitelabel/logos	Get the white label logos
restoreWhiteLabelLogoText	PUT /api/2.0/settings/whitelabel/logotext/restore	Restore the white label logo text
restoreWhiteLabelLogos	PUT /api/2.0/settings/whitelabel/logos/restore	Restore the white label logos
saveAdditionalWhiteLabelSettings	POST /api/2.0/settings/rebranding/additional	Save the additional white label settings
saveCompanyWhiteLabelSettings	POST /api/2.0/settings/rebranding/company	Save the company white label settings
saveWhiteLabelLogoText	POST /api/2.0/settings/whitelabel/logotext/save	Save the white label logo text
saveWhiteLabelSettings	POST /api/2.0/settings/whitelabel/logos/save	Save the white label logos
saveWhiteLabelSettingsFromFiles	POST /api/2.0/settings/whitelabel/logos/savefromfiles	Save the logos from files

SSO

Method	HTTP request	Description
getDefaultSsoSettingsV2	GET /api/2.0/settings/ssov2/default	Get the default SSO settings
getSsoSettingsV2	GET /api/2.0/settings/ssov2	Get the SSO settings
getSsoSettingsV2Constants	GET /api/2.0/settings/ssov2/constants	Get the SSO settings constants
resetSsoSettingsV2	DELETE /api/2.0/settings/ssov2	Reset the SSO settings
saveSsoSettingsV2	POST /api/2.0/settings/ssov2	Save the SSO settings

Security

Method	HTTP request	Description
getEnabledModules	GET /api/2.0/settings/security/modules	Get enabled modules
getIsProductAdministrator	GET /api/2.0/settings/security/administrator	Check product administrator
getPasswordSettings	GET /api/2.0/settings/security/password	Get password settings
getProductAdministrators	GET /api/2.0/settings/security/administrator/{productId}	Get product administrators
getWebItemSecurityInfo	GET /api/2.0/settings/security/{id}	Check module availability
getWebItemSettingsSecurityInfo	GET /api/2.0/settings/security	Get module access settings
setAccessToWebItems	PUT /api/2.0/settings/security/access	Set access to modules in bulk
setProductAdministrator	PUT /api/2.0/settings/security/administrator	Set product administrator
setWebItemSecurity	PUT /api/2.0/settings/security	Set module access
updatePasswordSettings	PUT /api/2.0/settings/security/password	Update password settings

Statistics

Method	HTTP request	Description
getSpaceUsageStatistics	GET /api/2.0/settings/statistics/spaceusage/{id}	Get the space usage statistics

Storage

Method	HTTP request	Description
getAllBackupStorages	GET /api/2.0/settings/storage/backup	Get the backup storages
getAllCdnStorages	GET /api/2.0/settings/storage/cdn	Get the CDN storages
getAllStorages	GET /api/2.0/settings/storage	Get the portal storages
getAmazonS3Regions	GET /api/2.0/settings/storage/s3/regions	Get the Amazon S3 regions
getStorageProgress	GET /api/2.0/settings/storage/progress	Get the storage migration progress
resetCdnToDefault	DELETE /api/2.0/settings/storage/cdn	Reset the CDN storage settings
resetStorageToDefault	DELETE /api/2.0/settings/storage	Reset the storage settings
updateCdnStorage	PUT /api/2.0/settings/storage/cdn	Update the CDN storage
updateStorage	PUT /api/2.0/settings/storage	Switch the portal storage

TFA settings

Method	HTTP request	Description
getTfaAppCodes	GET /api/2.0/settings/tfaappcodes	Get the TFA backup codes
getTfaConfirmData	GET /api/2.0/settings/tfaapp/confirm	Get TFA confirmation data
getTfaSettings	GET /api/2.0/settings/tfaapp	Get the TFA settings
tfaAppGenerateSetupCode	GET /api/2.0/settings/tfaapp/setup	Generate the TFA setup code
tfaValidateAuthCode	POST /api/2.0/settings/tfaapp/validate	Validate the TFA code
unlinkTfaApp	PUT /api/2.0/settings/tfaappnewapp	Unlink the TFA application
updateTfaAppCodes	PUT /api/2.0/settings/tfaappnewcodes	Regenerate the TFA backup codes
updateTfaSettings	PUT /api/2.0/settings/tfaapp	Update the TFA settings
updateTfaSettingsLink	PUT /api/2.0/settings/tfaappwithlink	Update TFA settings with a link

Telegram

Method	HTTP request	Description
checkTelegram	GET /api/2.0/settings/telegram/check	Check the Telegram connection
linkTelegram	GET /api/2.0/settings/telegram/link	Get the Telegram link
unlinkTelegram	DELETE /api/2.0/settings/telegram/link	Unlink Telegram

Webhooks

Method	HTTP request	Description
createWebhook	POST /api/2.0/settings/webhook	Create a webhook
enableWebhook	PUT /api/2.0/settings/webhook/enable	Switch a webhook on or off
getTenantWebhooks	GET /api/2.0/settings/webhook	Get the portal webhooks
getWebhookTriggers	GET /api/2.0/settings/webhook/triggers	Get the webhook triggers
getWebhooksLogs	GET /api/2.0/settings/webhooks/log	Get the webhook delivery log
removeWebhook	DELETE /api/2.0/settings/webhook/{id}	Remove a webhook
retryWebhook	PUT /api/2.0/settings/webhook/{id}/retry	Retry a webhook delivery
retryWebhooks	PUT /api/2.0/settings/webhook/retry	Retry webhook deliveries
updateWebhook	PUT /api/2.0/settings/webhook	Update a webhook

Webplugins

Method	HTTP request	Description
addWebPluginFromFile	POST /api/2.0/settings/webplugins	Add a web plugin
deleteWebPlugin	DELETE /api/2.0/settings/webplugins/{name}	Delete a web plugin
getWebPlugin	GET /api/2.0/settings/webplugins/{name}	Get a web plugin by name
getWebPlugins	GET /api/2.0/settings/webplugins	Get web plugins
updateWebPlugin	PUT /api/2.0/settings/webplugins/{name}	Update a web plugin

Authorization

cookieAuth

• Type: API key
• API key parameter name: asc_auth_key
• Location:

bearerAuth

• Type: HTTP Bearer Token authentication

asc_auth_key

• Type: API key
• API key parameter name: asc_auth_key
• Location:

Basic

• Type: HTTP basic authentication

Bearer

• Type: HTTP Bearer Token authentication (JWT)

ApiKeyBearer

• Type: API key
• API key parameter name: ApiKeyBearer
• Location: HTTP header

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL:
• Scopes:
  • read: Read access to protected resources
  • write: Write access to protected resources

OpenId

x-signature

• Type: API key
• API key parameter name: x-signature
• Location: