Skip to content

Restore a database backup to a target environment

POST
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{backupId}/restore-database

Initiates an async restore of a database backup into the specified target environment. The backup may originate from a different environment of the same application (cross-env restore). Returns 202 with a restoreId for status polling.

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

Example
test-org
application
required
string

The application ID

Example
test-app
environment
required
string

The TARGET environment ID to restore INTO

Example
staging
backupId
required
string

The backup ID to restore from

Example
quant-gov-dashboard-staging-2025-09-19T21-50-27-145Z

Request Body required

object
backupId
required

The backup ID to restore (must match path param)

string
acknowledgeDataloss
required

Must be true to confirm existing data will be overwritten

boolean
true

Responses

202

Restore operation initiated

object
restoreId
string
restore-abc123
status
string
in_progress
message
string
Database restore initiated

422

Validation error

object
message
string
errors
object