Retrieve dbt Project Details

Returns a dbt Project details if a valid identifier was provided.

Request schema

Path parameters

projectId

stringrequired

The unique identifier for the dbt Project within the Fivetran system.

example:

dbt_project_id

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/v1/dbt/projects/dbt_project_id

GET /v1/dbt/projects/dbt_project_id HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com

Responses

200

Successful response

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique identifier for the dbt Model within the Fivetran system.

example:

dbt_project_id

threads

integer

format:

int32

type

stringrequired

Project type. Now only GIT project type is supported. Default value is GIT.

enum:

"GIT"

status

stringrequired

Dbt Project Status. Possible values: NOT_READY, ERROR, READY.

enum:

"NOT_READY""READY""ERROR"

errors

arrayrequired

List of errors occurred while project processing and setup.

type:

string

target_name

stringrequired

Target name to set or override the value from the deployment.yaml.

example:

target_name

git_remote_url

stringrequired

(Deprecated) Git remote url.

example:

https://github.com/your-project-url.git

group_id

stringrequired

The unique identifier for the Group within the Fivetran system.

example:

group_id

public_key

stringrequired

Public key to grant Fivetran SSH access to git repository.

example:

ssh-rsa AAAAB3NzaC1yc2EA...W7t6jVhQLVvs8udQ== fivetran user key

folder_path

stringrequired

Folder in Git repo with your dbt project.

example:

/folder/path

created_at

stringrequired

The timestamp when dbt project was created.

format:

date-time

example:

2023-01-02T00:00:00.743708Z

environment_vars

arrayrequired

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"

example:

DBT_VARIABLE_1=VALUE,DBT_VARIABLE_2=VALUE_2

type:

string

default_schema

stringrequired

Default schema in destination.

example:

default_schema

project_config

object

dbt_version

stringrequired

The version of dbt that should run the project.

example:

1.7.9

created_by_id

stringrequired

The unique identifier for the User within the Fivetran system.

example:

user_id

git_branch

stringrequired

Git branch.

example:

main

{
  "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"
  }
}