Skip to main content
PATCH
Enable or disable signed embedding for a dashboard

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

publicId
string
required

Body

application/json

UpdateDashboardEmbeddingInput

allowEmbed
boolean
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

200 - application/json
allowEmbed
boolean
required
publicId
string
required