Validate settings import without applying

POST

/api/v1/system/settings/import/preview

curl --request POST \
  --url https://example.com/api/v1/system/settings/import/preview \
  --header 'Content-Type: application/json' \
  --data '{ "schemaVersion": 1, "exportedAt": "2026-04-15T12:00:00Z", "tilecastVersion": "example", "organization": { "schemaVersion": 1, "revision": 1, "values": {}, "updatedAt": "2026-04-15T12:00:00Z" }, "groupPolicies": [ {} ], "screenPolicies": [ {} ] }'

Requires an authenticated dashboard user.

Request Body^required

Media typeapplication/json

object

schemaVersion

required

Only version 1 is accepted.

integer

Allowed values: 1

exportedAt

required

string format: date-time

tilecastVersion

required

string

organization

required

Organization document as carried by settings exports. Definitions are stripped on export; the settings read carries them instead.

object

schemaVersion

required

integer

>= 1

revision

required

integer format: int64

values

required

object

key

additional properties

any

updatedAt

required

string format: date-time

groupPolicies

required

Array<object>

object

key

additional properties

any

screenPolicies

Array<object>

object

key

additional properties

any

Responses

200

Import preview

Media typeapplication/json

object

data

required

object

valid

required

boolean

changedKeys

required

Array<string>

groupPolicyCount

required

integer

screenPolicyCount

required

integer

requiresConfirmation

required

boolean

Example

{
  "data": {
    "valid": true,
    "requiresConfirmation": true
  }
}

422

Invalid import