MEmetabase
/api/agent

PUT /api/agent/v1/dashboard/{id}

Changed on

Update a dashboard. Patch semantics - only fields you pass are changed.

Metadata: name, description, collection_id, archived. Archiving is a soft delete - there is no delete endpoint. It can be reversed by setting archived: false. Dashcard mutations are submitted under dashcards as a list of {action: add|add_heading|add_text|update_text|remove|move, ...} entries applied in order. add requires card_id; add_heading and add_text require text (Markdown for text cards); update_text, remove, and move require dashcard_id.

put/api/agent/v1/dashboard/{id}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

archivedboolean nullable
collection_idinteger nullable

value must be an integer greater than zero.

descriptionstring nullable
namestring nullable

value must be a non-blank string.

Response

Successful response

archivedboolean required
collection_idinteger nullable required

value must be an integer greater than zero.

collection_pathstring required
dashcard_idsinteger[] required
descriptionstring nullable required
idinteger required

value must be an integer greater than zero.

namestring required

value must be a non-blank string.

Changes