Dashboards v3 · embed

Create or rotate the board's embed key (Basic embeds)

Editor-only. The key a page presents to embed a board that has no public link. By default the replaced key keeps working for 24 hours, so a planned rotation does not blank every page at once; send keep_previous false to end it immediately, which is what a leaked key needs. Readable again through the config route — it is meant to live in a page — but this route is excluded from the request log.

post/dashboards/{dashboard_id}/embed/key

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/embed/key
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

dashboard_idinteger required

Request body

Response

The board's new embed key (also readable via the config)

keystring required
rotated_atstring date-time nullable

Changes

No recorded changes to this operation across all 4 revisions of this API.