Update system settings

PUT

/api/admin/settings

const url = 'https://example.com/api/admin/settings';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"preferences":{"view":{"defaultView":"grid"}}}'
};

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

curl --request PUT \
  --url https://example.com/api/admin/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "preferences": { "view": { "defaultView": "grid" } } }'

Updates system-wide settings. Requires the admin.settings.update permission.

Authorizations

bearerAuth

Request Body

application/json

object

preferences

object

view

required

object

defaultView

required

Default view mode

string

Allowed values: grid list

Example

grid

tableColumns

Saved table column selections

Array<string>

recentRepositories

Recently visited repositories

Array<object>

<= 3 items

object

CACHE_ROOT

required

Repository namespace

string

Example

my-repo

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

Example

theme

UI theme mode

string

default: dark

Allowed values: dark light

Example

dark

uiVersion

UI version preference

string

default: content2

Allowed values: content content2

Example

content2

Responses

200

Settings updated 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"
    }
  }
}

400

Invalid preferences

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}

403

Access denied

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}