dbt platform API Configuration Lite

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "dbt_cloud",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "data_checks": true,
  "config": {
    "api_key": "your_dbt_cloud_service_token",
    "custom_url": "your_dbt_cloud_custom_api_base_url",
    "sub_domain": "",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`api_key`	Your dbt platform service token.
`custom_url`	Your dbt platform access url.
`sub_domain`	Your dbt platform API server region.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the sub_domain, api_key and custom_url parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "dbt_cloud",
  "group_id": "group_id",
  "config": {
    "sub_domain": "",
    "api_key": "your_dbt_cloud_service_token",
    "custom_url": "your_dbt_cloud_custom_api_base_url"
  }
}

By using the Connect Card or the Fivetran dashboard.