Retrieve Private Link Details
Returns a private link object if a valid identifier was provided.
Request schema
Path parameters
privateLinkId
stringrequired
The unique identifier for the private link within the Fivetran system
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
example:
default:
Http + 1.1
GET
https://api.fivetran.com/v1/private-links/private_link_id
GET /v1/private-links/private_link_id 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
example:
message
string
Response status text
example:
data
objectrequired
id
stringrequired
The unique identifier for the private link within the Fivetran system.
example:
name
stringrequired
Private link name
example:
region
stringrequired
Data processing location. This is where Fivetran will operate and run computation on data.
example:
enum:
service
stringrequired
The name for the service type within the Fivetran system.
example:
enum:
state
stringrequired
Private link state
example:
enum:
config
objectrequired
Private link configuration
property name *
object
additional property
account_id
string
created_at
stringrequired
The timestamp of the time the private link was created in your account
format:
example:
created_by
stringrequired
The actor who created the private link
example:
cloud_provider
stringrequired
Private link cloud provider
example:
enum:
state_summary
stringrequired
Private link state summary
example:
{
"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": "..."
}
}