Retrieve Private Link Details
Returns a private link object if a valid identifier was provided.
Request schema
Path parameters
privateLinkId
integerrequired
The unique identifier for the private link within the Fivetran system
format:
int64
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
example:
application/json
default:
application/json
Http + 1.1
GET
https://api.fivetran.com/v1/private-links/null
GET /v1/private-links/null HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com
Responses
200
Successful response
404
Private Link not found
Successful response schema
code
stringrequired
Response status code
message
string
Response status text
data
objectrequired
id
string
The unique identifier for the private link within the Fivetran system.
name
string
Private link name
region
string
Data processing location. This is where Fivetran will operate and run computation on data.
enum:
"GCP_US_EAST4""GCP_US_WEST1""GCP_EUROPE_WEST3""GCP_AUSTRALIA_SOUTHEAST1""GCP_NORTHAMERICA_NORTHEAST1""GCP_EUROPE_WEST2""GCP_ASIA_SOUTHEAST1""GCP_ASIA_SOUTHEAST2""GCP_ASIA_SOUTH1""GCP_ASIA_NORTHEAST1""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""AZURE_EASTUS2""AZURE_AUSTRALIAEAST""AZURE_UKSOUTH""AZURE_WESTEUROPE""AZURE_CENTRALUS""AZURE_CANADACENTRAL""AZURE_UAENORTH""AZURE_SOUTHEASTASIA"
service
string
The name for the service type within the Fivetran system.
enum:
"DATABRICKS""SNOWFLAKE""ONELAKE""SYNAPSE""AZURE_POSTGRES_WAREHOUSE""AZURE_SQL_DATA_WAREHOUSE""SOURCE""REDSHIFT"
state
string
Private link state
enum:
"CREATING""UPDATING""DESTROYING""OK""FAIL"
config
object
Private link configuration
property name *
object
additional property
account_id
string
created_at
string
The timestamp of the time the private link was created in your account
format:
date-time
created_by
string
The actor who created the private link
cloud_provider
string
Private link cloud provider
enum:
"AWS""GCP""AZURE"
state_summary
string
Private link state summary
null