POST /v1/private-links

Creates a new private link in your Fivetran account.

Servers

Request headers

Name Type Required Description
Accept String No

Default value: "application/json"

Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
region String Yes

Data processing location. This is where Fivetran will operate and run computation on data.

Possible values:

  • "AWS_EU_CENTRAL_1"
  • "AZURE_AUSTRALIAEAST"
  • "GCP_US_WEST1"
  • "GCP_EUROPE_WEST2"
  • "AWS_AP_SOUTHEAST_2"
  • "AZURE_CANADACENTRAL"
  • "AWS_EU_WEST_2"
  • "GCP_AUSTRALIA_SOUTHEAST1"
  • "AZURE_UAENORTH"
  • "AWS_AP_SOUTH_1"
  • "AZURE_CENTRALUS"
  • "AZURE_UKSOUTH"
  • "AWS_US_EAST_2"
  • "GCP_US_EAST4"
  • "AZURE_JAPANEAST"
  • "GCP_ASIA_SOUTH1"
  • "GCP_ASIA_SOUTHEAST2"
  • "AZURE_SOUTHEASTASIA"
  • "GCP_NORTHAMERICA_NORTHEAST1"
  • "GCP_EUROPE_WEST3"
  • "AZURE_EASTUS"
  • "AWS_AP_SOUTHEAST_1"
  • "GCP_US_CENTRAL1"
  • "AWS_US_WEST_2"
  • "AWS_EU_WEST_1"
  • "GCP_ASIA_NORTHEAST1"
  • "AWS_US_EAST_1"
  • "AZURE_CENTRALINDIA"
  • "AWS_US_GOV_WEST_1"
  • "AWS_AP_NORTHEAST_1"
  • "AWS_CA_CENTRAL_1"
  • "AZURE_WESTEUROPE"
  • "GCP_ASIA_SOUTHEAST1"
  • "AZURE_EASTUS2"
name String Yes

Private link name

service String Yes

The name for the service type within the Fivetran system.

Possible values:

  • "POSTGRES_WAREHOUSE_AZURE"
  • "REDSHIFT_AWS"
  • "DATABRICKS_AWS"
  • "SQL_DATA_WAREHOUSE_AZURE"
  • "SOURCE_GCP"
  • "DATABRICKS_AZURE"
  • "SNOWFLAKE_AWS"
  • "SOURCE_AWS"
  • "SNOWFLAKE_AZURE"
  • "ONELAKE_AZURE"
  • "SOURCE_AZURE"
  • "SNOWFLAKE_GCP"
  • "DATABRICKS_GCP"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.