dbt Sync

Start a dbt sync for a deployment

Changed on
post/api/v1/deployments/{deploymentId}/dbt-sync

Request

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

Path parameters

deploymentIdinteger required

Request body

branchNamestring nullable
manifestobject nullable

The contents of your dbt target/manifest.json, as JSON. Required when source is manifest and ignored otherwise. Produced by dbt parse, dbt compile or dbt build, so a CI job can POST the manifest it just validated and be sure Cube converts exactly that — no re-parse of a branch tip that may already have moved.

output'branch' | 'files'
refstring nullable

Git ref in the dbt repository to sync from — a branch or a tag, NOT a commit SHA. Overrides the branch saved on the deployment’s dbt git integration for this sync only, so CI can sync the ref under review (e.g. a pull request’s head branch) instead of the tracked branch. The generated Cube branch is named after it.

source'git' | 'manifest'

Response

branchNamestring required
syncJobIdstring required
workflowIdstring required

Changes