Skip to main content
POST
Start Migration

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Path Parameters

migration_id
string
required

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

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