Create dbt Project
Creates a new dbt Project within a specified Group.
Request schema
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
The number of threads dbt will use.
Project type. Now only GIT project type is supported. Default value is GIT.
Target name to set or override the value from the deployment.yaml.
List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value"
Default schema in destination.
The unique identifier for the Group within the Fivetran system.
The version of dbt that should run the project.
dbt Project config for Git-based project.
Folder in Git repo with your dbt project.
Git branch.
Git remote URL with your dbt project
POST /v1/dbt/projects HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 441
{
"threads": 1,
"type": "GIT",
"folder_path": "string",
"target_name": "target_name",
"environment_vars": [
"DBT_VARIABLE_1=VALUE",
"DBT_VARIABLE_2=VALUE_2"
],
"git_remote_url": "string",
"default_schema": "default_schema",
"group_id": "group_id",
"dbt_version": "1.7.9",
"git_branch": "string",
"project_config": {
"folder_path": "string",
"git_branch": "string",
"git_remote_url": "string"
}
}
Responses
Successful response schema
Response status code
Response status text
The unique identifier for the dbt Model within the Fivetran system.
Project type. Now only GIT project type is supported. Default value is GIT.
Dbt Project Status. Possible values: NOT_READY, ERROR, READY.
List of errors occurred while project processing and setup.
Target name to set or override the value from the deployment.yaml.
(Deprecated) Git remote url.
The unique identifier for the Group within the Fivetran system.
Public key to grant Fivetran SSH access to git repository.
Folder in Git repo with your dbt project.
The timestamp when dbt project was created.
List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value"
Default schema in destination.
The version of dbt that should run the project.
The unique identifier for the User within the Fivetran system.
Git branch.
{
"code": "Success",
"message": "Operation performed.",
"data": {
"id": "dbt_project_id",
"threads": 0,
"type": "GIT",
"status": "READY",
"errors": {},
"target_name": "target_name",
"git_remote_url": "https://github.com/your-project-url.git",
"group_id": "group_id",
"public_key": "ssh-rsa AAAAB3NzaC1yc2EA...W7t6jVhQLVvs8udQ== fivetran user key",
"folder_path": "/folder/path",
"created_at": "2023-01-02T00:00:00.743708Z",
"environment_vars": [
"DBT_VARIABLE_1=VALUE",
"DBT_VARIABLE_2=VALUE_2"
],
"default_schema": "default_schema",
"project_config": {},
"dbt_version": "1.7.9",
"created_by_id": "user_id",
"git_branch": "main"
}
}