Skip to main content
POST
/
v1
/
namespaces
/
migrations
/
{migration_id}
/
cancel
Cancel Migration
curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}/cancel \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "migration_id": "<string>",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "message": "<string>"
}

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

Path Parameters

​
migration_id
string
required

Body

application/json

Request to cancel a migration.

​
reason
string | null

Cancellation reason

Response

Successful Response

Response after cancelling a migration.

​
migration_id
string
required

Migration ID

​
status
enum<string>
required

Current status

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

Cancellation timestamp

​
message
string
required

Human-readable message