GEgetdbt
Projects

POST /api/v3/accounts/{account_id}/projects/{id}/

Changed on

Update a Project

Request

  • Base URL
    https://cloud.getdbt.com
  • Auth
    HTTP bearer

Path parameters

account_idinteger required
idinteger required

Request body

namestring required

The name of the project

account_idinteger required

The account the project is associated with

descriptionstring

The description of the project

connection_idinteger

The active connection

repository_idinteger

The active repository

semantic_layer_config_idinteger

The active semantic layer configuration

stateinteger required

A value of 1 means this entity is active and a value of 2 means this entity is deleted

dbt_project_subdirectorystring

The path in the associated repository where a dbt project can be found

docs_job_idinteger

The job used for docs generation

freshness_job_idinteger

The job used for source freshness generation

type0 | 1 required
  • 0 - DEFAULT
  • 1 - HYBRID

Example request

{
  "state": 1
}

Response

Example response

{
  "data": {
    "state": 1,
    "connection": {
      "state": 1
    },
    "environments": [
      {
        "state": 1
      }
    ],
    "repository": {
      "state": 1
    },
    "group_permissions": [
      {
        "state": 1
      }
    ],
    "docs_job": {
      "state": 1
    },
    "freshness_job": {
      "state": 1
    }
  }
}

Changes

  • v3e32fbfcdc9ecRevision changes
    • info

      added the required property /// to the response with the status

  • v37d5c1b4c8d8aRevision changes
    • breaking

      for the path request parameter account_id, the format changed from no format to int64

    • breaking

      for the path request parameter id, the format changed from no format to int64