v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Models

Trigger a dbt metadata sync for a branch

Trigger a dbt metadata sync ("dbt quick sync") for a branch. Recompiles the branch's dbt manifest and merges the regenerated dbt extension model, without a full database schema scan. The branch (via branch_id) supplies the dbt environment and dbt git branch. Runs as a background job.

post/api/v1/models/{modelId}/dbt-sync

Path parameters

modelIdstring uuid required

Model UUID

Example:123e4567-e89b-12d3-a456-426614174000

Model UUID

Query parameters

branch_idstring uuid required

ID of the branch to sync dbt metadata for. The branch supplies the dbt environment and dbt git branch to compile against (set via POST /api/v1/models/{modelId}/branch/{branchName}/dbt).

Example:123e4567-e89b-12d3-a456-426614174001

ID of the branch to sync dbt metadata for. The branch supplies the dbt environment and dbt git branch to compile against (set via POST /api/v1/models/{modelId}/branch/{branchName}/dbt).

Response

dbt sync job started

jobIdstring required

ID of the created job. Poll GET /api/v1/jobs/{jobId}/status for its status.

Example response

{
  "jobId": "550e8400-e29b-41d4-a716-446655440000"
}