Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

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

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

databaseId
string
required
branchId
string
required

Body

application/json
expiresInDays
integer | null
deleteOnPreviewClose
boolean

Response

Updated database branch.

id
string
required
sourceDatabaseId
string
required
databaseId
string | null
required
name
string
required
Pattern: ^[a-z][a-z0-9-]{1,61}$
environment
string
required
Pattern: ^[a-z][a-z0-9-]{0,38}$
source
object
required
status
enum<string>
required
Available options:
queued,
hydrating,
ready,
failed,
expired,
promoted
progressPercent
integer
required
hydrationMode
enum<string>
required

Launch implementation hydrates a full independent copy; it is not copy-on-write.

Available options:
full_copy
hydrationProgressPercent
integer
required
connectionReady
boolean
required

True only when the independent database safely accepts customer connections.

fullyHydrated
boolean
required

True only after every data block is copied and verified. Full-copy branches never report connectionReady before this is true.

deleteOnPreviewClose
boolean
required
expiresAt
string<date-time> | null
required

Defaults to seven days; null disables automatic expiry.

createdAt
string<date-time>
required