v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01120263252.9 KB
Embed

Enable or disable signed embedding for a dashboard

patch/api/v1/embed/dashboard/{publicId}

Path parameters

publicIdstring required

Request body

allowEmbedboolean required

Whether customer-signed embedding is allowed for this dashboard ("Allow signed embedding" in the UI). true lets embed sessions fetch the dashboard via GET /api/v1/embed/dashboard/{publicId}; false makes that fetch return 403. Does not affect creator-mode sessions or dashboards shared with all embed users.

Response

allowEmbedboolean required
publicIdstring required