Retrieve Private Link Details

Returns a private link object if a valid identifier was provided.

DATABRICKS_AWS

Request schema

Path parameters

privateLinkId

stringrequired

The unique identifier for the private link within the Fivetran system

example:

privateLinkId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/v1/private-links/privateLinkId

GET /v1/private-links/privateLinkId HTTP/1.1
Accept: application/json
Authorization: Basic <Replace with base64-encoded key>
Host: api.fivetran.com

Responses

200

Successful response

404

Private Link not found

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique identifier for the private link within the Fivetran system.

example:

private_link_id

name

stringrequired

Private link name

example:

PrivateLinkName

region

stringrequired

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

stringrequired

DATABRICKS_AWS

The name for the service type within the Fivetran system.

enum:

"DATABRICKS_AWS""SNOWFLAKE_AWS""REDSHIFT_AWS""SOURCE_AWS""DATABRICKS_AZURE""SNOWFLAKE_AZURE""ONELAKE_AZURE""POSTGRES_WAREHOUSE_AZURE""SQL_DATA_WAREHOUSE_AZURE""SOURCE_AZURE""SNOWFLAKE_GCP""SOURCE_GCP""DATABRICKS_GCP"

state

stringrequired

Private link state

enum:

"CREATING""UPDATING""DESTROYING""OK""FAIL"

host

string

The DNS name of the PrivateLink endpoint service.

example:

example.host.com

state_summary

stringrequired

Private link state summary

example:

...

account_id

string

created_at

stringrequired

The timestamp of the time the private link was created in your account

format:

date-time

example:

2023-12-01T15:43:29.013729Z

resource_upstream_status

string

The upstream status of the PrivateLink resource as reported by the cloud provider.

example:

IDLE

created_by

stringrequired

The actor who created the private link

example:

user_id

cloud_provider

stringrequired

Private link cloud provider

enum:

"AWS""GCP""AZURE"

config

objectrequired

Databricks for AWS

connection_service_name

objectrequired

The name of your connection service.

example:

connection_service_name

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "id": "private_link_id",
    "name": "PrivateLinkName",
    "region": "AWS_US_EAST_1",
    "service": "DATABRICKS_AWS",
    "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": {
      "connection_service_name": "connection_service_name"
    }
  }
}