Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/directus/directus/llms.txt

Use this file to discover all available pages before exploring further.

Settings control global project configuration.

​
Get Settings

Retrieve project settings. 
GET /settings
Example: 
curl "https://your-directus-instance.com/settings" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response: 
{
  "data": {
    "id": 1,
    "project_name": "My Project",
    "project_descriptor": "A headless CMS",
    "project_url": "https://example.com",
    "project_logo": "logo-uuid",
    "public_foreground": "bg-uuid",
    "public_background": "bg-uuid",
    "public_note": "Welcome message",
    "auth_login_attempts": 25,
    "auth_password_policy": null,
    "storage_asset_transform": "all",
    "storage_asset_presets": [],
    "custom_css": null,
    "custom_aspect_ratios": []
  }
}

​
Update Settings

Update project settings. 
PATCH /settings
Request Body: 
{
  "project_name": "Updated Project Name",
  "project_descriptor": "Updated description",
  "auth_login_attempts": 5
}

​
Settings Properties

​
project_name
string
Project name displayed in the app
​
project_descriptor
string
Project tagline
​
project_url
string
Project website URL
Logo file UUID
​
public_foreground
string
Public pages foreground image
​
public_background
string
Public pages background image
​
auth_login_attempts
integer
Failed login attempts before lockout
​
auth_password_policy
string
Password requirements regex
​
storage_asset_transform
string
Asset transformation permissions: all, none, presets
​
storage_asset_presets
array
Predefined asset transformation presets
​
custom_css
string
Custom CSS for the admin app

​
Next Steps

Collections

Manage collections

Users

Manage users