Sign in

v7

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

Publish dashboard

post/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/publish

Path parameters

deploymentIdnumber required
workbookIdnumber required

Request body

allowEmbedboolean nullable
dashboardIdinteger nullable
descriptionstring nullable
titlestring nullable
workbookIdinteger required

Response

allowEmbedboolean required
createdByinteger nullable
deploymentIdinteger required
descriptionstring nullable
fromSharedWorkspaceboolean nullable
idinteger required
publicIdstring required
restrictDataDownloadboolean nullable
status'draft' | 'published' | 'archived' required
titlestring nullable
useBoardDashboardsboolean nullable
versionIdinteger required
versionNumberinteger required
workbookIdinteger required