getSettings

GET

/api/v1/settings

const url = 'https://example.com/api/v1/settings';
const options = {method: 'GET', headers: {cookie: 'tilecast_session=<tilecast_session>'}};

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/settings \
  --cookie tilecast_session=<tilecast_session>

Requires an authenticated user with the read scope. Reads the typed organization settings document with its registry and revision.

Authorizations

sessionCookie
userBearer

Responses

200

Settings document and registry

application/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

>= 1

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

Allowed values: organization policy preference

sensitive

required

boolean

restartRequired

required

boolean

immediate

required

boolean

futureOnly

required

boolean

updatedAt

required

string format: date-time

Example

{
  "data": {
    "definitions": [
      {
        "scope": "organization"
      }
    ]
  }
}

401

Dashboard authentication required