Get system settings

GET

/api/admin/settings

const url = 'https://example.com/api/admin/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/admin/settings \
  --header 'Authorization: Bearer <token>'

Retrieves system-wide settings, falling back to defaults when unset

Authorizations

bearerAuth

Responses

200

Settings retrieved successfully

application/json

object

preferences

object

view

required

object

defaultView

required

Default view mode

string

Allowed values: grid list

tableColumns

Saved table column selections

Array<string>

recentRepositories

Recently visited repositories

Array<object>

<= 3 items

object

CACHE_ROOT

required

Repository namespace

string

name

Display name

string

lastVisited

required

Timestamp of last visit

number

recentSites

Recently visited sites

Array<object>

<= 3 items

object

required

Site ID

string

name

Site name

string

lastVisited

required

Timestamp of last visit

number

detailPaneColumns

Number of grid columns visible when detail pane is open

number

default: 2 >= 1 <= 5

theme

UI theme mode

string

default: dark

Allowed values: dark light

uiVersion

UI version preference

string

default: content2

Allowed values: content content2

Example

{
  "preferences": {
    "view": {
      "defaultView": "grid"
    }
  }
}