Skip to main content
POST
/
v1
/
namespaces
/
migrations
/
{migration_id}
/
start
Start Migration
curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "force": false
}'
{
  "message": "Migration started successfully. Track progress at GET /migrations/{id}",
  "migration_id": "mig_abc123xyz789",
  "started_at": "2025-12-03T10:05:00Z",
  "status": "pending",
  "task_id": "task_xyz789"
}

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