getRestorePlan

GET

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

curl --request GET \
  --url https://example.com/api/v1/system/backups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plan

Read the restore plan for a system backup. Requires an Owner with the admin scope.

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Restore plan

Media typeapplication/json

object

data

required

object

archive

required

object

id

required

string format: uuid

fileName

required

string

kind

required

string

status

required

string

sizeBytes

required

integer

archiveSha256

required

string

tilecastVersion

required

string

schemaVersion

required

integer

>= 1

installationId

required

string

organizationName

required

string

components

required

Array<object>

object

name

required

string

fileCount

required

integer

totalBytes

required

integer

verification

required

string

verifiedAt

string format: date-time

createdAt

required

string format: date-time

organizationName

required

string

installationId

required

string

tilecastVersion

required

string

serverChannel

string

buildCommit

string

buildDate

string

schemaVersion

required

integer

>= 1

createdAt

required

string format: date-time

sizeBytes

required

integer

components

required

Array<object>

object

name

required

string

fileCount

required

integer

totalBytes

required

integer

identityMismatch

required

boolean

currentInstallationId

required

string

Example^generated

{
  "data": {
    "archive": {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "fileName": "example",
      "kind": "example",
      "status": "example",
      "sizeBytes": 1,
      "archiveSha256": "example",
      "tilecastVersion": "example",
      "schemaVersion": 1,
      "installationId": "example",
      "organizationName": "example",
      "components": [
        {
          "name": "example",
          "fileCount": 1,
          "totalBytes": 1
        }
      ],
      "verification": "example",
      "verifiedAt": "2026-04-15T12:00:00Z",
      "createdAt": "2026-04-15T12:00:00Z"
    },
    "organizationName": "example",
    "installationId": "example",
    "tilecastVersion": "example",
    "serverChannel": "example",
    "buildCommit": "example",
    "buildDate": "example",
    "schemaVersion": 1,
    "createdAt": "2026-04-15T12:00:00Z",
    "sizeBytes": 1,
    "components": [
      {
        "name": "example",
        "fileCount": 1,
        "totalBytes": 1
      }
    ],
    "identityMismatch": true,
    "currentInstallationId": "example"
  }
}

401

Dashboard authentication required

403

Insufficient role

404

Backup not found

422

Backup archive unreadable