KHkhotan
Databases

Get a database branch

Returns one branch's record, including status and failure state when present. Responses never include connection credentials.

get/api/v1/databases/{databaseId}/branches/{branchId}

Request

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

Path parameters

databaseIdstring required
branchIdstring required

Response

The branch record.

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.