Databases

Get a database schema promotion

Returns the recorded schema promotion plan, including SQL, summary, blocked changes, and failure state.

get/api/v1/databases/{databaseId}/schema-promotions/{promotionId}

Request

  • Base URL
    https://app.khotan.com
  • URL
    https://app.khotan.com/api/v1/databases/{databaseId}/schema-promotions/{promotionId}
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

databaseIdstring required
promotionIdstring required

Response

The schema promotion record.

idstring required
databaseIdstring required
branchIdstring required
status'planning' | 'ready' | 'blocked' | 'applying' | 'applied' | 'failed' required
sourceSchemaHashstring required
targetSchemaHashstring required
sqlstring required
failedStatementIndexinteger nullable required
createdAtstring required
updatedAtstring required
validatedAtstring nullable required
appliedAtstring nullable required
failedAtstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.