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.
Private link configuration
additional property
POST /v1/private-links HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 146
{
"name": "PrivateLinkName",
"region": "GCP_US_EAST4",
"service": "DATABRICKS",
"config": {
"property1": {},
"property2": {}
}
}
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
Private link configuration
additional property
The timestamp of the time the private link was created in your account
The actor who created the private link
Private link cloud provider
Private link state summary
{
"code": "Success",
"message": "Operation performed.",
"data": {
"id": "private_link_id",
"name": "PrivateLinkName",
"region": "AWS_US_EAST_1",
"service": "DATABRICKS",
"state": "OK",
"config": {
"property1": {},
"property2": {}
},
"account_id": "string",
"created_at": "2023-12-01T15:43:29.013729Z",
"created_by": "user_id",
"cloud_provider": "AWS",
"state_summary": "..."
}
}