Skip to main content
POST
Create Migration

Authorizations

Authorization
string
header
required

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

Body

application/json

Request to create a new migration.

config
MigrationConfig · object
required

Migration configuration

start_immediately
boolean
default:false

Start execution immediately after validation

Response

Successful Response

Response after creating a migration.

migration_id
string
required

Created migration ID

status
enum<string>
required

Current status

Available options:
draft,
validating,
pending,
in_progress,
completed,
failed,
cancelled
created_at
string<date-time>
required

Creation timestamp

message
string
required

Human-readable message

validation_result
ValidationResult · object | null

Validation result if available