Skip to main content
POST
Restore database

Authorizations

X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Path Parameters

database_id
string
required

Database ID (UUID) or short id (the database_id field, e.g. a1b2c3d4)

Body

application/json

Set exactly one of clone_to_new or in_place to true.

clone_to_new
boolean

Restore into a new database

in_place
boolean

Restore over this database. Data written after the restore point is lost.

backup_id
string<uuid>

Restore from this completed backup. Omit to use pitr_timestamp or the latest state.

pitr_timestamp
string<date-time>

Point-in-time restore target (RFC 3339). PostgreSQL only — Valkey restores from snapshots via backup_id.

new_name
string

Name for the new database. Defaults to {source-name}-restored; auto-suffixed (-2, -3, …) if taken.

ha_enabled
boolean
default:false

Enable high availability on the new database (+70% of the plan price). Never inherited from the source.

Response

Restore started

success
boolean
new_database_id
string

Short ID of the new database being created (empty for an in-place restore)

Last modified on October 5, 2026