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>
3.7 KiB
pageClass
| pageClass |
|---|
| page-reference |
Settings
Groups of users that share permissions.
The Settings Object
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.
public_foreground many-to-one
Foreground image for the Admin App's public pages. Many-to-one to files.
public_background many-to-one
Background image for the Admin App's public pages. Many-to-one to 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. One of all, none or presets.
storage_asset_presets array
What preset keys exist in the assets endpoint.
{
"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
}
}
Retrieve Settings
GET /settings
// 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
}
}
Update Settings
Query Parameters
Supports all global query parameters.
Request Body
A partial settings object.
Returns
Returns the settings object.
PATCH /settings
// Request
{
"project_url": "https://example.com/"
}
// 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
}
}