/
CU
cube-js
/
Cube Platform API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 2h ago · Updated 2d ago
Details
Filter operations
App Theme
1
get
Get app config
Dashboard Embed Access
2
get
List a dashboard's embed access
put
Update a dashboard's embed access
Data Model
15
get
List a deployment's branches
post
Create a branch (optionally entering dev mode on it)
delete
Delete a branch
put
Enable or disable a branch's staging environment
post
Commit (and push) the active branch's pending changes
get
List the data-model source files for a deployment
put
Create or overwrite data-model source files
delete
Delete data-model source files
post
Rename data-model source files
get
Compile a deployment's data model and report compilation errors
post
Enter dev mode (switch to a branch)
delete
Exit dev mode
post
Merge a branch into its parent branch (git-flow merge)
post
Merge a branch straight into the deploy (default) branch
post
Pull the latest for a branch from its remote and rebuild if changed
Data Model Uploads
4
get
Content hashes of the current data-model files (for upload diffing)
post
Upload a single file into an open transaction
post
Finish the upload transaction (prune removed files) and trigger a build
post
Start a data-model upload transaction
dbt Sync
6
get
List dbt syncs for a deployment
post
Start a dbt sync for a deployment
get
Get the status of a dbt sync
delete
Cancel a running dbt sync
get
Get the log of a dbt sync
get
Get the result of a completed dbt sync
Deployment Creation
1
post
Create a deployment with an empty starter project and trigger its first build
Deployments
12
get
Get deployments
get
Get deployment
put
Update a deployment
delete
Delete deployment
get
Latest build/compile status for a branch (production build or dev-mode)
post
Advance a deployment to a given onboarding step (e.g. after connecting a source)
post
Reset a deployment to the first onboarding step (project)
get
Recent runtime logs (tail) for a deployment. With no `source`, reads both the production API / worker pods and the dev-mode worker, merged chronologically; scope with `?source=production` or `?source=dev`.
get
List the pods currently scheduled for a deployment
get
Get deployment settings
post
Deployment token
get
List available Cube versions
Embed
5
get
Get an embeddable dashboard
patch
Enable or disable signed embedding for a dashboard
post
Run a python report over dashboard-filtered SQL
post
Generate an embed session
post
Exchange a session for an embed token
Embed Tenants
11
get
List embed tenants
delete
Delete embed tenant
get
List embed groups
post
Create an embed group
get
Get an embed group
delete
Delete an embed group
patch
Update an embed group
get
List embed group members
post
Add embed group members
delete
Remove embed group members
get
List embed users
Env Variables
2
get
Get env variables
put
Set env variables
Environments
4
get
Get deployment environments
get
Get deployment environment tokens
post
Create deployment environment token
post
Create deployment environment token for meta sync
Folders
5
get
List folders
post
Create a folder
put
Update a folder
delete
Delete a folder
get
List folder ancestors
GitHub
4
get
List the user's GitHub App installations (orgs/accounts)
get
List repositories accessible to a GitHub App installation
get
List branches of a repository
get
Whether GitHub is linked, plus the link/install URLs
GitHub Connection
1
post
Connect a deployment to a GitHub repository and trigger a build
Notifications
8
get
List scheduled notifications
post
Create a scheduled notification
get
Get a scheduled notification
put
Update a scheduled notification
delete
Delete a scheduled notification
get
List notification recipients
post
Add notification recipients
delete
Remove notification recipients
OAuth Integrations
5
get
List OAuth integrations
post
Create OAuth integration
get
Get OAuth integration
put
Update OAuth integration
delete
Delete OAuth integration
OIDC Token Configs
5
get
List OIDC token configs
post
Create OIDC token config
get
Get OIDC token config
put
Update OIDC token config
delete
Delete OIDC token config
OpenAPI Spec
1
get
Get the OpenAPI specification
Regions
1
get
List regions
Reports
9
get
List reports
post
Create a report
put
Create or update a report by publicId
get
Get report
put
Update a report
delete
Delete report
put
Connect a report to the calling spreadsheet
delete
Disconnect a report from one spot in a spreadsheet
put
Refresh report
Tenant Settings
2
get
Get tenant settings
put
Update tenant settings
User Attribute Values
2
post
Upsert user attribute value
get
Get user attribute values
User Attributes
3
get
Get user attributes
post
Create user attribute
put
Update user attribute
User OAuth Tokens
4
get
List user OAuth tokens
get
Get user OAuth token
delete
Revoke user OAuth token
post
Initiate OAuth flow
Users Admin
4
post
Create user
post
Apply an action to many users
put
Update user
delete
Delete user
Workbooks
9
get
Get workbooks
post
Create workbook
put
Create or update a workbook by slug
get
Get workbook
put
Update a workbook
delete
Delete workbook
put
Update workbook dashboard
post
Clone a workbook
post
Publish dashboard
Workspace
5
get
List shared workspace items
get
List workspace items
post
Delete workspace items in bulk
post
Move workspace items in bulk
post
Move a workspace item
App Theme
Get app config
get
/api/v1/app-config
Response
AppConfigResponse
required
appTheme
AppTheme
applyThemeGlobally
boolean
required
creatorMode
CreatorMode
embedding
EmbedSettings
sheetsUi
SheetsUiSettings
timezoneSettings
TimezoneSettings
Changes