Homarr
Users

Change your color scheme

PATCH/api/users/changeScheme

Set the current user's preferred color scheme. Requires authentication.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/users/changeScheme" \  -H "Content-Type: application/json" \  -d '{    "colorScheme": "auto"  }'
null

Update search preferences

Set a user's default search engine, new-tab behavior, and DuckDuckGo bang preference. Users can update themselves; updating another user requires admin permission.

Change widget context menu behavior

Enable or disable opening widget context menus with a right click for a user. Users can update themselves; updating another user requires admin permission.