---
title: "Start a dbt sync for a deployment"
method: POST
path: "/api/v1/deployments/{deploymentId}/dbt-sync"
tags: ["dbt Sync"]
---

# Start a dbt sync for a deployment

`POST /api/v1/deployments/{deploymentId}/dbt-sync`

## Path parameters

- `deploymentId` integer, required

## Request body

- StartDbtSyncInput
  - `branchName` string, nullable
  - `ref` string, 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.

## Response `200`

- DbtSyncResponse
  - `branchName` string, required
  - `syncJobId` string, required
  - `workflowId` string, required

---

[API](https://skmtc.net/cube-js/apis/cube-cloud-rest-api.md) · [All operations](https://skmtc.net/cube-js/apis/cube-cloud-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cube-js/cube-cloud-rest-api/revisions/29d481391a25/schema)