Gets migration status

GET /api/2.0/migration/status

Request

Gets migration status

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

Responses

200

Ok

progressnumberformat: double

Migration progress

errorstring

Migration error

parseResultobject
migratorNamestring
operationstring
failedArchivesarray of unknown
usersarray of unknown
withoutEmailUsersarray of unknown
existUsersarray of unknown
groupsarray of unknown
importPersonalFilesboolean
importSharedFilesboolean
importSharedFoldersboolean
importCommonFilesboolean
importProjectFilesboolean
importGroupsboolean
successedUsersintegerformat: int32
failedUsersintegerformat: int32
filesarray of unknown
errorsarray of unknown
isCompletedboolean

Specifies whether the migration is completed

401

Unauthorized

403

Forbidden

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