Private Link
Represents a private networking connection between Fivetran and your cloud infrastructure. Private links route traffic over private networks instead of the public internet. They are available for AWS, GCP, and Azure, and support destinations and sources such as Databricks, Snowflake, and Redshift.
Resource attributes
The following attributes describe a private link and its configuration.
| Field name | Type | Description |
|---|---|---|
id | string, read-only | Unique identifier of the private link. |
name | string | Name of the private link. |
cloud_provider | string, read-only | Cloud provider for the private link. Possible values: AWS, GCP, AZURE. |
region | string | Data processing region where the private link operates. |
service | string | Service type for the private link. Possible values:DATABRICKS_AWS, SNOWFLAKE_AWS, REDSHIFT_AWS, SOURCE_AWSDATABRICKS_AZURE, SNOWFLAKE_AZURE, ONELAKE_AZURE, POSTGRES_WAREHOUSE_AZURE, SQL_DATA_WAREHOUSE_AZURE, SOURCE_AZURESNOWFLAKE_GCP, DATABRICKS_GCP, SOURCE_GCP. |
state | string, read-only | Current state of the private link. Possible values:CREATING – The private link is being provisioned.UPDATING – The private link is being updated.DESTROYING – The private link is being deleted.OK – The private link is active and healthy.FAIL – The private link encountered an error. |
state_summary | string, read-only | Additional details about the current state. |
host | string, read-only | DNS name of the private link endpoint service. |
config | object | Service-specific connection configuration. The required fields vary by service type. |
resource_upstream_status | string, read-only | Status of the private link resource as reported by the cloud provider. |
account_id | string, read-only | Unique identifier of the account that owns the private link. |
created_at | string, read-only | Date and time the private link was created, in ISO 8601 format. |
created_by | string, read-only | Identifier of the actor who created the private link. |
Supported operations
| Category | Endpoint | Description |
|---|---|---|
| List | GET /v1/private-links | Returns a paginated list of all private links in the account. |
| Create | POST /v1/private-links | Creates a new private link. |
| Retrieve | GET /v1/private-links/{privateLinkId} | Returns the details of a private link. |
| Update | PATCH /v1/private-links/{privateLinkId} | Updates the configuration of an existing private link. |
| Delete | DELETE /v1/private-links/{privateLinkId} | Deletes a private link. |