Sign in

v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/dashboard

PUT /api/dashboard/{id}

Update a Dashboard, and optionally the dashcards and tabs of a Dashboard. The request body should be a JSON object with the same structure as the response from GET /api/dashboard/:id.

put/api/dashboard/{id}

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

archivedboolean nullable
cache_ttlinteger nullable

value must be an integer greater than zero.

caveatsstring nullable
collection_idinteger nullable

value must be an integer greater than zero.

collection_positioninteger nullable

value must be an integer greater than zero.

descriptionstring nullable
embedding_paramsobject nullable
embedding_typestring nullable
enable_embeddingboolean nullable
namestring nullable
points_of_intereststring nullable
positioninteger nullable

value must be an integer greater than zero.

show_in_getting_startedboolean nullable
width'fixed' | 'full'

Response

Successful response