Workbooks

Publish a dashboard

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

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/publish
  • Auth: HTTP bearer

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

Changes

  • 04b88ae6ce37Revision changes
    • info

      added the optional property // to the response with the status

  • 914d24830bb3Revision changes
    • warning

      added the new FIELD enum value to the //// response property for the response status

    • info

      added the new FIELD enum value to the request property ////////