Apply confirmed settings import
POST
/api/v1/system/settings/import/apply
const url = 'https://example.com/api/v1/system/settings/import/apply';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"schemaVersion":1,"exportedAt":"2026-04-15T12:00:00Z","tilecastVersion":"example","organization":{"schemaVersion":1,"revision":1,"values":{},"updatedAt":"2026-04-15T12:00:00Z"},"groupPolicies":[{}],"screenPolicies":[{}]}'};
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://example.com/api/v1/system/settings/import/apply \ --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 Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
schemaVersion
required
Only version 1 is accepted.
integer
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
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
Section titled “ Responses ”Import applied
Media typeapplication/json
object
data
required
Versioned organization or preference document. Definitions always ride along; callers never merge a second read to render titles.
object
schemaVersion
required
integer
revision
required
integer format: int64
values
required
object
key
additional properties
any
definitions
required
Array<object>
object
key
required
string
category
required
string
type
required
string
title
required
string
description
string
documentation
string
default
required
min
number
max
number
allowed
Array<string>
scope
required
string
sensitive
required
boolean
restartRequired
required
boolean
immediate
required
boolean
futureOnly
required
boolean
updatedAt
required
string format: date-time
Example
{ "data": { "definitions": [ { "scope": "organization" } ] }}Revision conflict