dashboards

Pin a dashboard panel to the caller's Home.

Pins a panel (idempotent upsert on dashboard + page + panel). Requires the dashboard read capability AND per-dashboard read access; an unknown dashboard, a dashboard the caller cannot read, or a panel not in the dashboard's spec all 404. Body is at most 16 KiB; unknown fields are rejected. filterState has at most 32 keys; each value must be a v1:-encoded string of at most 2048 characters. 201 when newly pinned, 200 when an existing pin's filter state was updated. At most 48 pins per user (409).

post/v1/me/home-pins

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/me/home-pins
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

dashboardIdstring uuid required
pageIdstring

Page id; empty/omitted for a single-page dashboard.

panelIdstring required
filterStateobject

Saved filter state, param name to a v1:-encoded value.

Response

Existing pin updated.

Changes

No recorded changes to this operation across all 1 revision of this API.