KHkhotan
Databases

Get a database

Returns one database's record, including status and failure state when present. Responses never include usage data or connection credentials.

get/api/v1/databases/{databaseId}

Request

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

Path parameters

databaseIdstring required

Response

The database record.

idstring required
displayNamestring required
status'creating' | 'ready' | 'failed' required
providerstring required
regionIdstring required
environment'production' required
postgresVersioninteger required
providerDatabaseNamestring nullable required
providerRoleNamestring nullable required
endpointHoststring nullable required
protectedboolean required
tagsstring[] 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.