Homarr
Boards

Rename a board

PATCH/api/boards/{id}/name

Change a board's name to a unique name. Requires full access to the board.

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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

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

Duplicate a board

Copy a board under a unique name and return its new ID. Requires board-create permission, view access to the source, and use access to its linked integrations. Widget configurations must be valid; boards containing Custom Widgets require admin permission.

Change board visibility

Make a board public or private. Requires full access to the board. A board selected as an instance desktop or mobile home board cannot be made private.