Dashboards v3 · embed

Save a board's embed settings

Every published board embeds; mode is the tier a board without a public link is on (key: the board's embed key; signed: a host-signed token). Framing is open unless allow_any_origin is false, and only then does allowed_origins restrict it; origins are validated as origin patterns (https, optional port, one leading *. label), normalised and capped. Appearance and snippet keys are whitelisted; a saved appearance.tile makes the board's embed a tile embed. A field left out of params keeps its saved value, so a save that sends only allowed_origins never moves a Signed board back to Key.

put/dashboards/{dashboard_id}/embed/config

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/embed/config
  • 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 embed settings plus the URLs a snippet needs

modestring required
tierstring
allow_any_originboolean
allowed_originsstring[] required
appearanceobject required
snippetobject
embed_urlstring required
sdk_urlstring required
publishedboolean required
publicboolean required
access_keystring nullable
key_rotated_atstring date-time nullable
has_signing_secretboolean
signing_secret_rotated_atstring date-time nullable
token_ttlinteger
rls_enabledboolean
rls_columnstring nullable

Changes

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