Create a Private Link
Creates a new private link in your Fivetran account.
Request schema
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
Private link name
Data processing location. This is where Fivetran will operate and run computation on data.
The name for the service type within the Fivetran system.
Snowflake for Azure
The ID of your Private Link service.
The URL of your account.
POST /v1/private-links HTTP/1.1
Accept: application/json
Authorization: Basic <Replace with base64-encoded key>
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 167
{
"name": "PrivateLinkName",
"region": "GCP_US_EAST4",
"service": "SNOWFLAKE_AZURE",
"config": {
"pls_id": "pls_id",
"account_url": "account_url"
}
}
Responses
Successful response schema
Response status code
Response status text
The unique identifier for the private link within the Fivetran system.
Private link name
Data processing location. This is where Fivetran will operate and run computation on data.
The name for the service type within the Fivetran system.
Private link state
The DNS name of the PrivateLink endpoint service.
Private link state summary
The timestamp of the time the private link was created in your account
The upstream status of the PrivateLink resource as reported by the cloud provider.
The actor who created the private link
Private link cloud provider
Snowflake for Azure
The ID of your Private Link service.
The URL of your account.
{
"code": "Success",
"message": "Operation performed.",
"data": {
"id": "private_link_id",
"name": "PrivateLinkName",
"region": "AWS_US_EAST_1",
"service": "SNOWFLAKE_AZURE",
"state": "OK",
"host": "example.host.com",
"state_summary": "...",
"account_id": "string",
"created_at": "2023-12-01T15:43:29.013729Z",
"resource_upstream_status": "IDLE",
"created_by": "user_id",
"cloud_provider": "AWS",
"config": {
"pls_id": "pls_id",
"account_url": "account_url"
}
}
}