List schema migrations

GET /v1/tenants/{tenant}/migrations

Find schema changes that need attentionOpen an individual migration before cutting it over or aborting it.

List visible migrationsRead the tenant's migrations permitted to the caller.
Compare targets and statesIdentify the affected schemas and progress.
Inspect the selected migrationUse its ID to examine current details.

Before you start

Use your database bearer token.

Path parameters

Field	Type	Required
`tenant`	`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

Each item identifies a migration, its target schema, state and progress. Open the individual migration before deciding to cut over or abort it.

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.
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" \
  --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": "Pending",
    "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

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses