Abort a schema migration

POST /v1/tenants/{tenant}/migrations/{id}/abort

Restore a migration's previous table shapeThis is schema-migration recovery, not a rollback of unrelated application writes.

Inspect the migrationUse its ID and current progress.
Request an abortStop the identified schema migration.
Check the resulting stateConfirm the migration's reported recovery outcome.

Before you start

Use your database bearer token.

Connection setup

Use the ID returned by Start a schema migration. Check its state before cutover or abort.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`id`	`string`	Required

Query parameters

Field	Type	Required
`force`	`boolean`	Optional

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

Check the returned state for the abort outcome. This operates on the identified schema migration; it is not cancellation of a data-import request or a general rollback of application writes.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
409	Resolve the conflict before retrying.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/migrations/%3CMIGRATION_ID%3E/abort" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "id": "77777777-7777-4777-8777-777777777777",
  "tenant": "your-tenant",
  "schema": "demo.people",
  "state": "Aborted",
  "diff": [
    {
      "AddColumn": {
        "name": "nickname",
        "ty": "str",
        "default": "New member"
      }
    }
  ],
  "progress": {
    "rows_seen": 0,
    "rows_written": 0,
    "chunks_done": 0,
    "chunks_total": 0
  },
  "version_before": 1,
  "version_after": 2
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link