ONLYOFFICE DocSpace Backup 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.

Backup

Method	HTTP request	Description
cancelBackup	POST /api/2.0/backup/cancelbackup	Cancel the running backup
createBackupSchedule	POST /api/2.0/backup/createbackupschedule	Create the backup schedule
deleteBackup	DELETE /api/2.0/backup/deletebackup/{id}	Delete the backup
deleteBackupHistory	DELETE /api/2.0/backup/deletebackuphistory	Delete the backup history
deleteBackupSchedule	DELETE /api/2.0/backup/deletebackupschedule	Delete the backup schedule
getBackupHistory	GET /api/2.0/backup/getbackuphistory	Get the backup history
getBackupProgress	GET /api/2.0/backup/getbackupprogress	Get the backup progress
getBackupSchedule	GET /api/2.0/backup/getbackupschedule	Get the backup schedule
getBackupsCount	GET /api/2.0/backup/getbackupscount	Get the number of backups
getBackupsCounts	GET /api/2.0/backup/getbackupscountbypaid	Get free and paid backup counts
getBackupsServiceState	GET /api/2.0/backup/getservicestate	Check whether backups are enabled
getRestoreProgress	GET /api/2.0/backup/getrestoreprogress	Get the restoring progress
startBackup	POST /api/2.0/backup/startbackup	Start the backup
startBackupRestore	POST /api/2.0/backup/startrestore	Start the restoring process

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