Boards

Board Router save Partial Board Settings

Authorization

apikey

ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pageTitle?string|null

metaTitle?string|null

logoImageUrl?string|null

faviconImageUrl?string|null

backgroundImageUrl?string|null

backgroundImageAttachment?string

Value in

"fixed"
"scroll"

backgroundImageRepeat?string

Value in

"repeat"
"repeat-x"
"repeat-y"
"no-repeat"

backgroundImageSize?string

Value in

"cover"
"contain"

primaryColor?string

Match^#[0-9A-Fa-f]{6}$

secondaryColor?string

Match^#[0-9A-Fa-f]{6}$

opacity?number

Range0 <= value <= 100

customCss?string

Lengthlength <= 16384

iconColor?|string|null

itemRadius?string|string|string|string|string

disableStatus?boolean

Response Body

`application/json`

curl -X PATCH "https://example.com/api/boards/string/settings" \  -H "Content-Type: application/json" \  -d '{}'

null

Board Router set Mobile Home Board

Board Router add Item

Board Router save Partial Board Settings

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`