Namespace Migrations

Cancel Migration

Changed on

Cancel a running migration.

Args: request: FastAPI request migration_id: Migration ID cancel_request: Cancellation options

Returns: CancelMigrationResponse with updated status

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

Request

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

Path parameters

migration_idstring required

Request body

reasonstring nullable

Cancellation reason

Response

Successful Response

migration_idstring required

Migration ID

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

Migration execution status.

cancelled_atstring date-time required

Cancellation timestamp

messagestring required

Human-readable message

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