restoreBackup

POST

/api/v1/system/backups/{id}/restore

curl --request POST \
  --url https://example.com/api/v1/system/backups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/restore \
  --header 'Content-Type: application/json' \
  --data '{ "confirmIdentityMismatch": true }'

Restore a system backup, confirming identity mismatch explicitly when the archive names another installation. Requires an Owner with the admin scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body

May be omitted entirely when the archive names this installation; only identity mismatches need confirmation.

Media typeapplication/json

object

confirmIdentityMismatch

boolean

Example^generated

{
  "confirmIdentityMismatch": true
}

Responses

202

Restore job started

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

kind

required

string

Allowed values: backup verify restore

trigger

required

string

archiveId

string format: uuid

status

required

string

phase

required

string

progressPercent

required

integer

<= 100

errorCode

string

errorMessage

string

createdAt

required

string format: date-time

completedAt

string format: date-time

Example

{
  "data": {
    "kind": "backup"
  }
}

400

Invalid request body

401

Dashboard authentication required

403

Insufficient role

404

Backup not found