KHkhotan
Databases

Create a database branch

Branches a ready database synchronously and responds 201 with the persisted record whether provisioning ends ready or failed; branch on the returned status. Omit parentBranchId to branch from the database root. Expiration: omit expiresAt and noExpiry for the ephemeral default, pass expiresAt (ISO 8601) for an explicit expiry, or noExpiry true for a non-expiring branch. This operation is not idempotent.

post/api/v1/databases/{databaseId}/branches

Request

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

Path parameters

databaseIdstring required

Request body

namestring required
parentBranchIdstring nullable
initSource'parent-data' | 'schema-only' required
parentTimestampstring date-time nullable
expiresAtstring date-time nullable
noExpiryboolean nullable

Response

The persisted branch record, in ready or failed status.

idstring required
databaseIdstring required
parentBranchIdstring nullable required
namestring required
status'creating' | 'ready' | 'failed' required
initSource'parent-data' | 'schema-only' required
parentTimestampstring nullable required
expiresAtstring nullable required
endpointHoststring nullable required
createdAtstring required
updatedAtstring required
readyAtstring nullable required
failedAtstring nullable required

Changes

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