Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Connections

Create a default data warehouse connection

An endpoint for creating a default data warehouse connection

post/v1/projects/{projectId}/data-platform-connections

Path parameters

projectIdstring uuid required

Request body

authProvider'SNOWFLAKE' | 'REDSHIFT' | 'BIGQUERY' | 'DATABRICKS' required

The authentication provider to use for the connection

authType'KEY_PAIR' | 'PASSWORD' | 'NONE' | 'PERSONAL_ACCESS_TOKEN' | 'OAUTH_CLIENT_CREDENTIALS' required

The authentication type to use for the connection

namestring required

The name of the default data warehouse connection

platformConnectionType'DWH' | 'COMPONENT_BASIC' | 'CLOUD_PLATFORM_CREDENTIALS' required

The platform type of date warehouse connection to create

Example request

{
  "authProvider": "SNOWFLAKE",
  "authType": "KEY_PAIR",
  "name": "DWH-Connection-1",
  "platformConnectionType": "DWH"
}

Response

Default Data Warehouse Connection created