Skip to main content
POST
Start a dbt sync for a deployment

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

Body

application/json

StartDbtSyncInput

branchName
string | null
ref
string | null

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.

Response

200 - application/json
branchName
string
required
syncJobId
string
required
workflowId
string
required