Abandon a migration

DELETE https://app.speybooks.com/api/v1/migrations/{id}

Abandon a migration session. Sets status to abandoned. Only non-terminal, non-executing migrations can be abandoned.

After abandoning, the singleton constraint is released and a new migration can be created.

Returns 422 if the migration is already terminal or currently executing.

Path parameters

id string required

Migration ID (e.g. mig_1). Must not be in a terminal or executing state.

Response

200 Migration abandoned. A new migration can now be started.

Show response fields

abandoned boolean

message string

migrationId string

Error codes

404 Migration not found.

422 Cannot abandon a completed, already-abandoned, or currently-executing migration.

Request DELETE /v1/migrations/{id} curl

curl -X DELETE https://api.speybooks.com/v1/migration/mig_1 \
  -H "Authorization: Bearer sk_test_..."

Response 200

{
  "success": true,
  "data": {
    "abandoned": true,
    "migrationId": "mig_1",
    "message": "Migration abandoned. You can start a new one."
  }
}