Namespace Migrations

Start Migration

Changed on

Start a migration execution.

Args: request: FastAPI request migration_id: Migration ID start_request: Start options

Returns: StartMigrationResponse with task ID

post/v1/namespaces/migrations/{migration_id}/start

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}/start
  • Auth: HTTP bearer

Path parameters

migration_idstring required

Request body

forceboolean

Force start even if validation warnings exist

Response

Successful Response

migration_idstring required

Migration ID

status'draft' | 'validating' | 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled' required

Migration execution status.

task_idstring required

Task ID for tracking migration progress

started_atstring date-time required

Start timestamp

messagestring required

Human-readable message

Example response

{
  "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"
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API