Private Links Management config Object
The private link setup configuration (the config object) is specific for region and service. We will continue to add more private links to this list:
The following subsections provide configuration examples for the supported services and cloud providers to help get you started.
Databricks for AWS
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "DATABRICKS",
"config": {
"connection_service_name": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AWS_US_EAST_1,
AWS_US_EAST_2,
AWS_US_WEST_2,
AWS_AP_NORTHEAST_1,
AWS_AP_SOUTHEAST_1,
AWS_AP_SOUTHEAST_2,
AWS_EU_CENTRAL_1,
AWS_EU_WEST_1,
AWS_EU_WEST_2,
AWS_AP_SOUTH_1,
AWS_CA_CENTRAL_1,
AWS_US_GOV_WEST_1 |
service (required) | Service type. | DATABRICKS |
Config parameters
| Name | Description |
|---|
connection_service_name (required) | The name of your connection service. |
Snowflake for AWS
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "SNOWFLAKE",
"config": {
"account_url": "string",
"vpce_id": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AWS_US_EAST_1,
AWS_US_EAST_2,
AWS_US_WEST_2,
AWS_AP_NORTHEAST_1,
AWS_AP_SOUTHEAST_1,
AWS_AP_SOUTHEAST_2,
AWS_EU_CENTRAL_1,
AWS_EU_WEST_1,
AWS_EU_WEST_2,
AWS_AP_SOUTH_1,
AWS_CA_CENTRAL_1,
AWS_US_GOV_WEST_1 |
service (required) | Service type. | SNOWFLAKE |
Config parameters
| Name | Description |
|---|
account_url (required) | The URL of your account. |
vpce_id (required) | The ID of your Virtual Private Cloud Endpoint. |
Redshift for AWS
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "REDSHIFT",
"config": {
"aws_account_id": "string",
"cluster_identifier": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AWS_US_EAST_1,
AWS_US_EAST_2,
AWS_US_WEST_2,
AWS_AP_NORTHEAST_1,
AWS_AP_SOUTHEAST_1,
AWS_AP_SOUTHEAST_2,
AWS_EU_CENTRAL_1,
AWS_EU_WEST_1,
AWS_EU_WEST_2,
AWS_AP_SOUTH_1,
AWS_CA_CENTRAL_1,
AWS_US_GOV_WEST_1 |
service (required) | Service type. | REDSHIFT |
Config parameters
| Name | Description |
|---|
aws_account_id (required) | The ID of your AWS account. |
cluster_identifier (required) | The cluster identifier. |
Source and all other services for AWS
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "SOURCE",
"config": {
"connection_service_name": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AWS_US_EAST_1,
AWS_US_EAST_2,
AWS_US_WEST_2,
AWS_AP_NORTHEAST_1,
AWS_AP_SOUTHEAST_1,
AWS_AP_SOUTHEAST_2,
AWS_EU_CENTRAL_1,
AWS_EU_WEST_1,
AWS_EU_WEST_2,
AWS_AP_SOUTH_1,
AWS_CA_CENTRAL_1,
AWS_US_GOV_WEST_1 |
service (required) | Service type. | SOURCE |
Config parameters
| Name | Description |
|---|
connection_service_name (required) | The name of your connection service. |
Databricks for Azure
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "DATABRICKS",
"config": {
"connection_service_id": "string",
"workspace_url": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AZURE_EASTUS2,
AZURE_AUSTRALIAEAST,
AZURE_UKSOUTH,
AZURE_WESTEUROPE,
AZURE_CENTRALUS,
AZURE_CANADACENTRAL,
AZURE_UAENORTH,
AZURE_SOUTHEASTASIA,
AZURE_EASTUS,
AZURE_JAPANEAST,
AZURE_CENTRALINDIA |
service (required) | Service type. | DATABRICKS |
Config parameters
| Name | Description |
|---|
connection_service_id (required) | The ID of your connection service. |
workspace_url (required) | The URL of your workspace. |
Snowflake for Azure
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "SNOWFLAKE",
"config": {
"account_url": "string",
"pls_id": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AZURE_EASTUS2,
AZURE_AUSTRALIAEAST,
AZURE_UKSOUTH,
AZURE_WESTEUROPE,
AZURE_CENTRALUS,
AZURE_CANADACENTRAL,
AZURE_UAENORTH,
AZURE_SOUTHEASTASIA,
AZURE_EASTUS,
AZURE_JAPANEAST,
AZURE_CENTRALINDIA |
service (required) | Destination type. | SNOWFLAKE |
Config parameters
| Name | Description |
|---|
account_url (required) | The URL of your account. |
pls_id (required) | The ID of your Azure Private Link service. |
Synapse for Azure
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "SYNAPSE",
"config": {
"connection_service_id": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AZURE_EASTUS2,
AZURE_AUSTRALIAEAST,
AZURE_UKSOUTH,
AZURE_WESTEUROPE,
AZURE_CENTRALUS,
AZURE_CANADACENTRAL,
AZURE_UAENORTH,
AZURE_SOUTHEASTASIA,
AZURE_EASTUS,
AZURE_JAPANEAST,
AZURE_CENTRALINDIA |
service (required) | Destination type. | SYNAPSE |
Config parameters
| Name | Description |
|---|
connection_service_id (required) | The ID of your connection service. |
Onelake for Azure
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "ONELAKE",
"config": {
"connection_service_id": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AZURE_EASTUS2,
AZURE_AUSTRALIAEAST,
AZURE_UKSOUTH,
AZURE_WESTEUROPE,
AZURE_CENTRALUS,
AZURE_CANADACENTRAL,
AZURE_UAENORTH,
AZURE_SOUTHEASTASIA,
AZURE_EASTUS,
AZURE_JAPANEAST,
AZURE_CENTRALINDIA |
service (required) | Destination type. | ONELAKE |
Config parameters
| Name | Description |
|---|
connection_service_id (required) | The ID of your connection service. |
Azure SQL Data Warehouse for Azure
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "AZURE_POSTGRES_WAREHOUSE",
"config": {
"connection_service_id": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AZURE_EASTUS2,
AZURE_AUSTRALIAEAST,
AZURE_UKSOUTH,
AZURE_WESTEUROPE,
AZURE_CENTRALUS,
AZURE_CANADACENTRAL,
AZURE_UAENORTH,
AZURE_SOUTHEASTASIA,
AZURE_EASTUS,
AZURE_JAPANEAST,
AZURE_CENTRALINDIA |
service (required) | Destination type. | AZURE_POSTGRES_WAREHOUSE |
Config parameters
| Name | Description |
|---|
connection_service_id (required) | The ID of your connection service. |
Source and all other services for Azure
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "SOURCE",
"config": {
"connection_service_id": "string",
"sub_resource_name": "string",
"private_dns_regions": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | AZURE_EASTUS2,
AZURE_AUSTRALIAEAST,
AZURE_UKSOUTH,
AZURE_WESTEUROPE,
AZURE_CENTRALUS,
AZURE_CANADACENTRAL,
AZURE_UAENORTH,
AZURE_SOUTHEASTASIA,
AZURE_EASTUS,
AZURE_JAPANEAST,
AZURE_CENTRALINDIA |
service (required) | Destination type. | SOURCE |
Config parameters
| Name | Description |
|---|
connection_service_id (required) | The ID of your connection service. |
sub_resource_name (required) | The name of subresource. |
private_dns_regions (optional) | List of DNS regions for private link separated by semicolon. Order of the entries is important. |
Snowflake for GCP
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "SNOWFLAKE",
"config": {
"account_url": "string",
"pls_id": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | GCP_US_EAST4,
GCP_US_WEST1,
GCP_US_CENTRAL1,
GCP_EUROPE_WEST3,
GCP_AUSTRALIA_SOUTHEAST1,
GCP_NORTHAMERICA_NORTHEAST1,
GCP_EUROPE_WEST2,
GCP_ASIA_SOUTHEAST1,
GCP_ASIA_SOUTHEAST2,
GCP_ASIA_SOUTH1,
GCP_ASIA_NORTHEAST1 |
service (required) | Service type. | SNOWFLAKE |
Config parameters
| Name | Description |
|---|
account_url (required) | The URL of your account. |
pls_id (required) | The ID of your Azure Private Link service. |
Source and all other services for GCP
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "SOURCE",
"config": {
"private_connection_service_id": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | GCP_US_EAST4,
GCP_US_WEST1,
GCP_US_CENTRAL1,
GCP_EUROPE_WEST3,
GCP_AUSTRALIA_SOUTHEAST1,
GCP_NORTHAMERICA_NORTHEAST1,
GCP_EUROPE_WEST2,
GCP_ASIA_SOUTHEAST1,
GCP_ASIA_SOUTHEAST2,
GCP_ASIA_SOUTH1,
GCP_ASIA_NORTHEAST1 |
service (required) | Service type. | SOURCE |
Config parameters
| Name | Description |
|---|
private_connection_service_id (required) | The ID of your connection service. |
