mirror of
https://github.com/directus/directus.git
synced 2026-02-01 13:44:58 -05:00
817ccf3620
* Add Quickstart Guide * Update installation * Remove unused files * Update support/backing * Tweaks in concepts * Setup file structure for API reference 2.0 * Setup page layout for reference * Add clean-urls plugin * getting started updates * Finish authentication rest * getting started updates * Render stylus in 2 spaces * Various * Various * Finish activity docs * Add collections reference * Add extension reference * concepts updates * Fields/tweaks * Add files doc * Add revisions * concepts docs * More api reference * Finish rest api reference (finally) * initial concepts * More things * Add assets api ref * Move sections from file to assets * Add environment variables * contributing docs * Add field transforms page * Left align table headers * concept links * Add API config * Fix mobile nav * Add migrating a project * doc link fixes Co-authored-by: Ben Haynes <ben@rngr.org>
198 lines
3.7 KiB
Markdown
198 lines
3.7 KiB
Markdown
---
|
|
pageClass: page-reference
|
|
---
|
|
|
|
# Settings
|
|
|
|
<div class="two-up">
|
|
<div class="left">
|
|
|
|
Groups of users that share permissions.
|
|
|
|
</div>
|
|
<div class="right">
|
|
|
|
[[toc]]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
---
|
|
|
|
## The Settings Object
|
|
|
|
<div class="two-up">
|
|
<div class="left">
|
|
<div class="definitions">
|
|
|
|
`id` **uuid**\
|
|
Primary key of the setting.
|
|
|
|
`project_name` **string**\
|
|
Name of the project, shown in the Admin App.
|
|
|
|
`project_url` **string**\
|
|
Link to the (public) website that goes with this project.
|
|
|
|
`project_color` **string**\
|
|
Brand color for the current project.
|
|
|
|
`project_logo` **many-to-one**\
|
|
Primary logo for the current project. Many-to-one to [files](/reference/api/rest/files/).
|
|
|
|
`public_foreground` **many-to-one**\
|
|
Foreground image for the Admin App's public pages. Many-to-one to [files](/reference/api/rest/files/).
|
|
|
|
`public_background` **many-to-one**\
|
|
Background image for the Admin App's public pages. Many-to-one to [files](/reference/api/rest/files/).
|
|
|
|
`public_note` **string**\
|
|
Note shown on the Admin App's public pages. Supports Markdown.
|
|
|
|
`auth_login_attempts` **integer**\
|
|
How often a user is allowed to try to login. After which times the user will be suspended.
|
|
|
|
`auth_password_policy` **RegEx**\
|
|
What regex passwords must pass in order to be valid.
|
|
|
|
`storage_asset_transform` **string**\
|
|
If the transform endpoints are allowed to be used on [the assets endpoint](/reference/assets/). One of `all`, `none` or `presets`.
|
|
|
|
`storage_asset_presets` **array**\
|
|
What preset keys exist in [the assets endpoint](/reference/assets/).
|
|
|
|
</div>
|
|
</div>
|
|
<div class="right">
|
|
|
|
```json
|
|
{
|
|
"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,
|
|
"auth_password_policy": null,
|
|
"storage_asset_transform": "all",
|
|
"storage_asset_presets": [
|
|
{ "key": "small", "fit": "cover", "width": 200, "height": 161, "quality": 80, "withoutEnlargement": false }
|
|
],
|
|
"custom_css": null
|
|
}
|
|
}
|
|
```
|
|
|
|
</div>
|
|
</div>
|
|
|
|
---
|
|
|
|
## Retrieve Settings
|
|
|
|
<div class="two-up">
|
|
<div class="left">
|
|
|
|
### Query Parameters
|
|
|
|
Supports all [global query parameters](/reference/api/query).
|
|
|
|
### Returns
|
|
|
|
Returns the [settings object](#the-settings-object).
|
|
|
|
</div>
|
|
<div class="right">
|
|
|
|
### `GET /settings`
|
|
|
|
```json
|
|
// Response
|
|
|
|
{
|
|
"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,
|
|
"auth_password_policy": null,
|
|
"storage_asset_transform": "all",
|
|
"storage_asset_presets": [
|
|
{ "key": "small", "fit": "cover", "width": 200, "height": 161, "quality": 80, "withoutEnlargement": false }
|
|
],
|
|
"custom_css": null
|
|
}
|
|
}
|
|
```
|
|
|
|
</div>
|
|
</div>
|
|
|
|
---
|
|
|
|
## Update Settings
|
|
|
|
<div class="two-up">
|
|
<div class="left">
|
|
|
|
### Query Parameters
|
|
|
|
Supports all [global query parameters](/reference/api/query).
|
|
|
|
### Request Body
|
|
|
|
A partial [settings object](#the-settings-object).
|
|
|
|
### Returns
|
|
|
|
Returns the [settings object](#the-setting-object).
|
|
|
|
</div>
|
|
<div class="right">
|
|
|
|
### `PATCH /settings`
|
|
|
|
```json
|
|
// Request
|
|
|
|
{
|
|
"project_url": "https://example.com/"
|
|
}
|
|
```
|
|
|
|
```json
|
|
// Response
|
|
|
|
{
|
|
"data": {
|
|
"id": 1,
|
|
"project_name": "Directus",
|
|
"project_url": "https://example.com/",
|
|
"project_color": null,
|
|
"project_logo": null,
|
|
"public_foreground": null,
|
|
"public_background": null,
|
|
"public_note": null,
|
|
"auth_login_attempts": 25,
|
|
"auth_password_policy": null,
|
|
"storage_asset_transform": "all",
|
|
"storage_asset_presets": [
|
|
{ "key": "small", "fit": "cover", "width": 200, "height": 161, "quality": 80, "withoutEnlargement": false }
|
|
],
|
|
"custom_css": null
|
|
}
|
|
}
|
|
```
|
|
|
|
</div>
|
|
</div>
|