Add dbt source

Add an additional dbt source to a project.

POST /api/v1/projects/{projectUuid}/dbt-sources

Error

A valid request URL is required to generate request examples

201

{
  "results": {
    "hasCredentialError": true,
    "warehouseLocation": {
      "schema": "<string>",
      "database": "<string>"
    },
    "projectSubPath": "<string>",
    "branch": "<string>",
    "repository": "<string>",
    "type": "dbt",
    "precedence": 123,
    "isPrimary": true,
    "name": "<string>",
    "projectDbtSourceUuid": "<string>"
  },
  "status": "ok"
}

Path Parameters

projectUuid · string<uuid> · required

Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Body

application/json

dbtConnection · object · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Show child attributes

name · string · required

warehouseLocation · object

Where in the warehouse a set of models lives — the two levels of a table reference, whatever a given warehouse calls them (BigQuery project and dataset, Snowflake database and schema, Databricks catalog and schema). A null field means "inherit from the project's warehouse connection".

Show child attributes

Response

201

application/json

Created

results · object · required

Non-sensitive view of a dbt source for API responses — never includes the decrypted connection (which holds credentials). The primary source is synthesised from the project's own dbt_connection. repository, branch and projectSubPath are the git-backed source's identity (null for non-git connections); they are safe to expose — only secrets are stripped.

hasCredentialError is always false for the synthesised primary source. See ProjectDbtSource for what it means on an additional source.

warehouseLocation is where this source's models live in the project's warehouse. For the primary source it is the location the project's warehouse connection already points at.

Show child attributes

status · enum<string> · required

Available options: ok