Get the backup progress

GET /api/2.0/backup/getbackupprogress

Request

Returns the progress of the started backup.

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/backup/getbackupprogress HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/backup/getbackupprogress \
  --header 'Accept: application/json'

Responses

200

Backup progress: completed or not, progress percentage, error, tenant ID, backup progress item (Backup, Restore, Transfer), link

isCompletedboolean
progressintegerformat: int32
errorstring
linkstring
tenantIdintegerformat: int32
backupProgressEnumone of
.enum of string

[Backup - Backup, Restore - Restore, Transfer - Transfer]

Can be one of: Backup, Restore, Transfer.

.enum of integer

[0 - Backup, 1 - Restore, 2 - Transfer]

Can be one of: 0, 1, 2.

taskIdstring

401

Unauthorized

402

Your pricing plan does not support this option

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).