Private Links Management Private Preview
Our REST API supports the following private links management actions:
- Create a Private Link
- List all Private Links within Account
- Retrieve Private Link Details
- Update a Private Link
- Delete a Private Link
Create a Private Link
Creates a new private link within your Fivetran account.
Request
POST https://api.fivetran.com/v1/private-links
{
"name": "string",
"region": "string",
"service": "string",
"config": {
"connection_service_name": "string"
}
}
Payload parameters
| Name | Description | Possible values |
|---|---|---|
name (required) | The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters. | |
region (required) | Data processing location. | GCP_US_EAST4,GCP_US_WEST1,GCP_US_CENTRAL1,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,AZURE_EASTUS,AZURE_JAPANEAST,AZURE_CENTRALINDIA. |
service (required) | Service type. | |
config (required) | The private link setup configuration. The format is specific for each service. | DATABRICKS, SNOWFLAKE, ONELAKE, SYNAPSE, AZURE_POSTGRES_WAREHOUSE, AZURE_SQL_DATA_WAREHOUSE, SOURCE, REDSHIFT |
Response
HTTP 201 Created
{
"code": "Success",
"data": {
"id": "string",
"name": "string",
"region": "string",
"service": "string",
"account_id": "string",
"cloud_provider": "string",
"state": "string",
"state_summary": "string",
"created_at": "2022-04-29T09:41:08.583Z",
"created_by": "string",
"config": {
"connection_service_name": "string"
}
}
}
| Name | Description | Possible values |
|---|---|---|
id | The unique identifier for the private link within the Fivetran system. | |
name | The private link name within the account. | |
region | Data processing location. | GCP_US_EAST4,GCP_US_WEST1,GCP_US_CENTRAL1,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,AZURE_EASTUS,AZURE_JAPANEAST,AZURE_CENTRALINDIA. |
service | The service name. | DATABRICKS, SNOWFLAKE, ONELAKE, SYNAPSE, AZURE_POSTGRES_WAREHOUSE, AZURE_SQL_DATA_WAREHOUSE,SOURCE, REDSHIFT |
account_id | The Fivetran account ID. | |
cloud_provider | The cloud provider name. | AWS, AZURE, GCP |
state | The state of the private link. | CREATING,UPDATING, DESTROYING,OK, FAIL. |
state_summary | The state details. | |
created_at | The date and time the membership was created. | |
created_by | The unique identifier for the User within the Fivetran system. | |
config | The private link setup configuration. The format is specific for each service. |
HTTP 400 BAD REQUEST
Service is not supported or config block inconsistent.
List all Private Links within Account
Returns a list of all private links within your Fivetran account.
Request
GET https://api.fivetran.com/v1/private-links
Query parameters
| Name | Description |
|---|---|
cursor | The paging cursor, read more about pagination |
limit | The number of records to fetch per page, accepts a number in the range 1..1000, the default value is 100 |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "string",
"name": "string",
"region": "string",
"service": "string",
"account_id": "string",
"cloud_provider": "string",
"state": "string",
"state_summary": "string",
"created_at": "2022-04-29T09:41:08.583Z",
"created_by": "string"
}
],
"next_cursor": "eyJza2lwIjoyfQ"
}
}
Fields
| Name | Description |
|---|---|
items | The collection of private links |
next_cursor | The value of the cursor parameter for the next page |
Retrieve Private Link Details
Retrieves a private link object within your Fivetran account.
Request
GET https://api.fivetran.com/v1/private-links/{link_id}
Path parameters
| Name | Description |
|---|---|
link_id (required) | Long. The unique identifier for the private link within your Fivetran account. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "string",
"name": "string",
"region": "string",
"service": "string",
"account_id": "string",
"cloud_provider": "string",
"state": "string",
"state_summary": "string",
"created_at": "2022-04-29T09:41:08.583Z",
"created_by": "string",
"config": {
"connection_service_name": "string"
},
"usage": [
{
"type": "string",
"schema_name": "string",
"consumer_name": "string",
"consumer_id": "string"
}
]}
}
| Name | Description | Possible values |
|---|---|---|
id | The unique identifier for the private link within the Fivetran system. | |
name | The private link name within the account. | |
region | Data processing location. | GCP_US_EAST4,GCP_US_WEST1,GCP_US_CENTRAL1,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,AZURE_EASTUS,AZURE_JAPANEAST,AZURE_CENTRALINDIA. |
service | The service name. | DATABRICKS, SNOWFLAKE, ONELAKE, SYNAPSE, AZURE_POSTGRES_WAREHOUSE, AZURE_SQL_DATA_WAREHOUSE,SOURCE, REDSHIFT |
account_id | The Fivetran account ID. | |
cloud_provider | The cloud provider name. | AWS, AZURE, GCP |
state | The state of the private link. | CREATING,UPDATING, DESTROYING,OK, FAIL. |
state_summary | The state details. | |
created_at | The date and time the membership was created. | |
created_by | The unique identifier for the User within the Fivetran system. | |
config | The private link setup configuration. The format is specific for each service. | |
usage | The list of private link usages. | type - one of [CONNECTOR, DESTINATION]schema_name - The service that uses this resourceconsumer_name - The connector schema name or destination group nameconsumer_id - The connector or destination id |
HTTP 404 NOT_FOUND
Private link with link_id not found.
Update a Private Link
Updates information for an existing private links within your Fivetran account.
Request
PATCH https://api.fivetran.com/v1/private-links/{link_id}
{
"config": {
"connection_service_name": "string"
}
}
Path parameters
| Name | Description |
|---|---|
link_id (required) | Long. The unique identifier for the private link within your Fivetran account. |
Payload parameters
| Name | Description |
|---|---|
config | The private link setup configuration. The format is specific for each service. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "string",
"name": "string",
"region": "string",
"service": "string",
"account_id": "string",
"cloud_provider": "string",
"state": "string",
"state_summary": "string",
"created_at": "2022-04-29T09:41:08.583Z",
"created_by": "string",
"config": {
"connection_service_name": "string"
}
}
}
| Name | Description | Possible values |
|---|---|---|
id | The unique identifier for the private link within the Fivetran system. | |
name | The private link name within the account. | |
region | Data processing location. | GCP_US_EAST4,GCP_US_WEST1,GCP_US_CENTRAL1,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,AZURE_EASTUS,AZURE_JAPANEAST,AZURE_CENTRALINDIA. |
service | The service name. | DATABRICKS, SNOWFLAKE, ONELAKE, SYNAPSE, AZURE_POSTGRES_WAREHOUSE, AZURE_SQL_DATA_WAREHOUSE,SOURCE, REDSHIFT |
account_id | The Fivetran account ID. | |
cloud_provider | The cloud provider name. | AWS, AZURE, GCP |
state | The state of the private link. | CREATING,UPDATING, DESTROYING,OK, FAIL. |
state_summary | The state details. | |
created_at | The date and time the membership was created. | |
created_by | The unique identifier for the User within the Fivetran system. | |
config | The private link setup configuration. The format is specific for each service. |
HTTP 400 BAD REQUEST
config block inconsistent.
HTTP 403 FORBIDDEN
Operation not available for current user.
HTTP 404 NOT_FOUND
Private link with link_id not found.
Delete a Private Link
Deletes a private link from your Fivetran account.
Request
DELETE https://api.fivetran.com/v1/private-links/{link_id}
Path parameters
| Name | Description |
|---|---|
link_id (required) | Long. The unique identifier for the private link within your Fivetran account. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "string"
}
HTTP 400 BAD REQUEST
Error during removal process.
HTTP 403 FORBIDDEN
Operation not available for current user.
HTTP 404 NOT_FOUND
Private link with link_id not found.