Restore a filesystem backup to a target environment
POST
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{backupId}/restore-filesystem
const url = 'https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/staging/backups/quant-gov-dashboard-staging-2025-09-19T21-50-27-145Z/restore-filesystem';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"backupId":"example","acknowledgeDataloss":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/staging/backups/quant-gov-dashboard-staging-2025-09-19T21-50-27-145Z/restore-filesystem \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "backupId": "example", "acknowledgeDataloss": true }'Initiates an async restore of a filesystem 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
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”organisation
required
string
The organisation ID
Example
test-orgapplication
required
string
The application ID
Example
test-appenvironment
required
string
The TARGET environment ID to restore INTO
Example
stagingbackupId
required
string
The backup ID to restore from
Example
quant-gov-dashboard-staging-2025-09-19T21-50-27-145ZRequest Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
backupId
required
The backup ID to restore (must match path param)
string
acknowledgeDataloss
required
Must be true. tar extraction overwrites same-named files in the target EFS in place; pre-existing files not in the archive are preserved.
boolean
Responses
Section titled “Responses”Restore operation initiated
Media typeapplication/json
object
restoreId
string
status
string
message
string
Example
{ "restoreId": "restore-abc123", "status": "in_progress", "message": "Filesystem restore initiated"}Validation error
Media typeapplication/json
object
message
string
errors
object
Examplegenerated
{ "message": "example", "errors": {}}