Homarr
Settings

Update global board settings

PATCH/api/settings/board

Update supplied instance board defaults and return the resulting settings. Home board IDs must reference public boards, or be null to clear the default. Requires admin permission.

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/settings/board" \  -H "Content-Type: application/json" \  -d '{}'
{  "homeBoardId": "string",  "mobileHomeBoardId": "string",  "enableStatusByDefault": true,  "forceDisableStatus": true}

Get global board settings

Return instance desktop and mobile home board IDs and default status behavior. Requires admin permission.

List all users

Return user IDs, names, email addresses, verification dates, and profile images. Requires admin permission.