Skip to main content
POST
Start a journalled resumable schema change with verified cutover.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Bound to actor, operation, target, schema version and canonical payload; changed input returns 409.

Required string length: 8 - 255

Path Parameters

orgId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
databaseId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
tableId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Body

application/json
expectedSchemaVersion
integer
required
Required range: 1 <= x <= 2147483647
change
object
required

Response

Committed synchronous result or accepted durable job; polling is required for terminal verification.

jobId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
state
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled,
partially_completed
statusUrl
string
required