Export non-secret settings

GET

/api/v1/system/settings/export

const url = 'https://example.com/api/v1/system/settings/export';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/system/settings/export

Requires an authenticated dashboard user.

Responses

200

Versioned settings export

application/json

object

data

required

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

Example

{
  "data": {
    "schemaVersion": 1
  }
}