Homarr
Settings

Get global board settings

GET/api/settings/board

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

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/settings/board"
{  "homeBoardId": "string",  "mobileHomeBoardId": "string",  "enableStatusByDefault": true,  "forceDisableStatus": true}

Delete a user invitation

Revoke an invitation by ID. Requires admin permission and credentials authentication to be enabled. Returns not found if the invitation does not exist.

Update global board settings

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.