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

Migration

Method	HTTP request	Description
cancelMigration	POST /api/2.0/migration/cancel	Cancel migration
clearMigration	POST /api/2.0/migration/clear	Clear migration
finishMigration	POST /api/2.0/migration/finish	Finish migration
getMigrationLogs	GET /api/2.0/migration/logs	Get migration logs
getMigrationStatus	GET /api/2.0/migration/status	Get migration status
listMigrations	GET /api/2.0/migration/list	Get available migrators
startMigration	POST /api/2.0/migration/migrate	Start migration
uploadAndInitializeMigration	POST /api/2.0/migration/init/{migratorName}	Parse migration archive

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: