Skip to main content
POST
Start Migration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

migration_id
string
required

Body

application/json

Request to start a migration.

force
boolean
default:false

Force start even if validation warnings exist

Response

Successful Response

Response after starting a migration.

migration_id
string
required

Migration ID

status
enum<string>
required

Current status

Available options:
draft,
validating,
pending,
in_progress,
completed,
failed,
cancelled
task_id
string
required

Task ID for tracking migration progress

started_at
string<date-time>
required

Start timestamp

message
string
required

Human-readable message