Skip to main content
POST
Create

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

Body

application/json
source
object
required
targetName
string
required

Name for the new isolated database. The source is never overwritten.

Pattern: ^[a-z][a-z0-9-]{1,61}$
targetEnvironment
string
required
Pattern: ^[a-z][a-z0-9-]{0,38}$
targetRegion
string
required
targetSku
string
required

Response

Restore queued.

id
string
required
sourceDatabaseId
string
required
targetDatabaseId
string | null
required
status
enum<string>
required
Available options:
queued,
restoring,
verifying,
ready,
failed,
promoted
source
object
required
progressPercent
integer
required
error
string | null
required
createdAt
string<date-time>
required
completedAt
string<date-time> | null
required