Settings

Settings are key-value pairs that are stored in the database, and control different aspects of the project. Only administrators have access to manage Settings.

Retrieve Settings

List the project settings.

Query Parameters

limit
integer

A limit on the number of objects that are returned.

offset
integer

How many items to skip when fetching data.

meta
string

What metadata to return in the response.

page
integer

Cursor for use in pagination. Often used in combination with limit.

200 Response

Successful request

data
object

401 Response

Error: Unauthorized request

error
object

404 Response

Error: Not found.

error
object
GET /settings
Response Example
{
  "data": {
    "id": 1,
    "project_name": "Directus",
    "project_url": null,
    "project_color": null,
    "project_logo": null,
    "public_foreground": null,
    "public_background": null,
    "public_note": null,
    "auth_login_attempts": 25,
    "storage_asset_transform": "all",
    "storage_asset_presets": null,
    "basemaps": [],
    "module_bar": [],
    "custom_aspect_ratios": [],
    "theme_light_overrides": {},
    "theme_dark_overrides": {}
  }
}

Update Settings

Update the project settings.

Query Parameters

fields
array

Control what fields are being returned in the object.

meta
string

What metadata to return in the response.

Request Body

[object]
object

200 Response

Successful request

data
object

401 Response

Error: Unauthorized request

error
object

404 Response

Error: Not found.

error
object
PATCH /settings
Response Example
{
  "data": {
    "id": 1,
    "project_name": "Directus",
    "project_url": null,
    "project_color": null,
    "project_logo": null,
    "public_foreground": null,
    "public_background": null,
    "public_note": null,
    "auth_login_attempts": 25,
    "storage_asset_transform": "all",
    "storage_asset_presets": null,
    "basemaps": [],
    "module_bar": [],
    "custom_aspect_ratios": [],
    "theme_light_overrides": {},
    "theme_dark_overrides": {}
  }
}