GEgetdbt
Connections

GET /api/v3/accounts/{account_id}/projects/{project_id}/connections/

Changed on

List Connections

Request

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

Path parameters

account_idinteger required
project_idinteger required

Query parameters

adapter_version'apache_spark_v0' | 'databricks_spark_v0' | 'databricks_v0' | 'trino_v0' | 'snowflake_v0' | 'bigquery_v0' | 'bigquery_v1' | 'postgres_v0' | 'redshift_v0' | 'salesforce_v0' | 'synapse_v0' | 'fabric_v0' | 'athena_v0' | 'teradata_v0' | 'clickhouse_v0'
has_catalog_ingestion_enabledboolean
has_cost_insights_enabledboolean
has_cost_management_enabledboolean
has_platform_metadata_credentialsboolean
include_relatedstring

Comma-separated list of related objects to include in the response.

limitinteger
offsetinteger
order_bystring

Field to order results by. Prefix with '-' for descending order.

pkinteger
integer
OR
'active' | 'deleted' | 'all'

Filters by soft deletion state. <ul> <li> <strong>"active"</strong> / <strong>1</strong>: Only active resources </li> <li> <strong>"deleted"</strong> / <strong>2</strong>: Only deleted resources </li> <li> <strong>"all"</strong>: All resources </li> </ul>

Response

Example response

{
  "data": [
    {
      "state": 1
    }
  ]
}

Changes

  • v37d5c1b4c8d8aRevision changes
    • breaking

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

    • breaking

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

    • breaking

      for the query request parameter pk, the format changed from no format to int64

  • v36b5199f1f0c8Revision changes
    • warning

      added the new clickhouse_v0 enum value to the // response property for the response status

    • info

      added the new enum value clickhouse_v0 to the query request parameter adapter_version