Check a schema migration

GET /v1/tenants/{tenant}/migrations/{id}

Track copying separately from schema cutoverCutoverPending still needs the explicit cutover step.

Keep the migration IDUse the ID returned when changes were submitted.
Read state and progressInspect row and chunk copying work.
Choose the next operationCut over or investigate according to the reported state.

Before you start

Use your database bearer token.

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

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

Read state before taking action. Row and chunk progress show copying work; CutoverPending still needs the cutover step. Use this endpoint to track the ID returned at submission.

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.
429	Honor Retry-After when present; back off.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/migrations/%3CMIGRATION_ID%3E" \
  --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": "CutoverPending",
  "diff": [
    {
      "AddColumn": {
        "name": "nickname",
        "ty": "str",
        "default": "New member"
      }
    }
  ],
  "progress": {
    "rows_seen": 3,
    "rows_written": 3,
    "chunks_done": 1,
    "chunks_total": 1
  },
  "version_before": 1,
  "version_after": 2
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses