Try our new Interactive API Reference!

Private Links Management BETAlink

Updated November 21, 2023

Our REST API supports the following private links management actions:

Create a Private Linklink

Creates a new private link within your Fivetran account.

Requestlink

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

{
  "name": "string",
  "group_id": "string",
  "service": "string",
  "config": {
    ...
  }
}
content_copy

Payload parameterslink

Name	Description
`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.
`group_id` (required)	The unique identifier for the group within the Fivetran system.
`service` (required)	Service name. We support the following services: `redshift`, `databricks`, `source`, `snowflake`.
`config` (required)	The private link setup configuration. The format is specific for each service.

Responselink

HTTP 201 Created

{
    "code": "Success",
    "data": {
        "id": long,
        "name": "string",
        "group_id": "string",
        "cloud_provider": "string",
        "service": "string",
        "region": "string",
        "state": "string",
        "state_summary": "string",
        "created_at": "2022-04-29T09:41:08.583Z",
        "created_by": "string",
        "config": {
          ...
        }
    }
}

content_copy

Name	Description
`id`	The unique identifier for the private link within the Fivetran system.
`name`	The private link name within the account.
`group_id`	The unique identifier for the group within the Fivetran system.
`cloud_provider`	The cloud provider name.
`service`	The service name. We support the following services: `redshift`, `databricks`, `source`, `snowflake`.
`region`	The data processing location.
`state`	The state of the private link. Possible values: `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 404 NOT_FOUND

Group with group_id not found.

HTTP 400 BAD REQUEST

Service is not supported or config block inconsistent.

Private link setup configurationslink

The private link setup configuration (the config field) is different for each service and cloud provider. Cloud provider is configured in a group. The following subsections provide configuration examples for the supported services and cloud providers to help get you started.

Databricks or Source for AWSlink

{
    "connection_service_name": "string"
}
content_copy

Payload parameterslink

Name	Description
`connection_service_name` (required)	The name of your connection service.

Databricks for Azurelink

{
    "connection_service_id": "string",
    "workspace_url": "string"
}
content_copy

Payload parameterslink

Name	Description
`connection_service_id` (required)	The ID of your connection service.
`workspace_url` (required)	The URL of your workspace.

Snowflake for AWSlink

{
    "account_name": "string",
    "account_url": "string",
    "vpceId": "string"
}
content_copy

Payload parameterslink

Name	Description
`account_name` (required)	The name of your account.
`account_url` (required)	The URL of your account.
`vpceId` (required)	The ID of your Virtual Private Cloud Endpoint.

Snowflake for Azurelink

{
    "account_url": "string",
    "pls_id": "string"
}
content_copy

Payload parameterslink

Name	Description
`account_url` (required)	The URL of your account
`pls_id` (required)	The ID of your Azure Private Link service.

Redshift for AWSlink

{
    "aws_account_id": "string",
    "cluster_identifier": "string"
}
content_copy

Payload parameterslink

Name	Description
`aws_account_id` (required)	The ID of your AWS account.
`cluster_identifier` (required)	The cluster identifier.

Source for Azurelink

{
    "connection_service_id": "string",
    "sub_resource_name": "string"
}
content_copy

Payload parameterslink

Name	Description
`connection_service_id` (required)	The ID of your connection service.
`sub_resource_name` (required)	The name of subresource.

Synapse for Azurelink

{
  "connection_service_id": "string"
}
content_copy

Payload parameterslink

Name	Description
`connection_service_id` (required)	The ID of your connection service.

List all Private Links within Grouplink

Returns a list of all private links within your Fivetran account.

Requestlink

GET api.fivetran.com/v1/groups/{groupId}/private-links

Path parameterslink

Name	Description
`groupId`	The unique identifier for the group within the Fivetran system.

Query parameterslink

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

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "items": [
          {
            "id": long,
            "name": "string",
            "group_id": "string",
            "cloud_provider": "string",
            "service": "string",
            "region": "string",
            "state": "string",
            "state_summary": "string",
            "created_at": "2022-04-29T09:41:08.583Z",
            "created_by": "string",
          }
        ],
        "next_cursor": "eyJza2lwIjoyfQ"
    }
}
content_copy

HTTP 404 NOT_FOUND

Group with group_id not found

Fieldslink

Name	Description
`items`	The collection of private links
`next_cursor`	The value of the `cursor` parameter for the next page

Retrieve Private Link Detailslink

Retrieves a private link object within your Fivetran account.

Requestlink

GET https://api.fivetran.com/v1/private-links/{linkId}

Query parameterslink

Name	Description
`linkId` (required)	Long. The unique identifier for the private link within your Fivetran account.

Responselink

HTTP 200 OK

{
  "code": "Success",
  "data": {
    "id": long,
    "name": "string",
    "group_id": "string",
    "cloud_provider": "string",
    "service": "string",
    "region": "string",
    "state": "string",
    "state_summary": "string",
    "created_at": "2022-04-29T09:41:08.583Z",
    "created_by": "string",
    "config": {
      ...
    }
  }
}
content_copy

Name	Description
`id`	The unique identifier for the private link within the Fivetran system.
`name`	The private link name within the account.
`group_id`	The unique identifier for the group within the Fivetran system.
`cloud_provider`	The cloud provider name.
`service`	The service name. We support the following services: `redshift`, `databricks`, `source`, `snowflake`.
`region`	The data processing location.
`state`	The state of the private link. Possible values: `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 404 NOT_FOUND

Private link with linkId not found.

Update a Private Linklink

Updates information for an existing private links within your Fivetran account.

Requestlink

PATCH https://api.fivetran.com/v1/private-links/{linkId}

{
    "name": "string",
    "config": {
      ...
    }
}
content_copy

Path parameterslink

Name	Description
`linkId` (required)	Long. The unique identifier for the private link within your Fivetran account.

Payload parameterslink

Name	Description
`name`	The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores.
`config`	The private link setup configuration. The format is specific for each service.

Responselink

HTTP 200 OK

{
  "code": "Success",
  "data": {
    "id": long,
    "name": "string",
    "group_id": "string",
    "cloud_provider": "string",
    "service": "string",
    "region": "string",
    "state": "string",
    "state_summary": "string",
    "created_at": "2022-04-29T09:41:08.583Z",
    "created_by": "string",
    "config": {
      ...
    }
  }
}
content_copy

Name	Description
`id`	The unique identifier for the private link within the Fivetran system.
`name`	The private link name within the account.
`group_id`	The unique identifier for the group within the Fivetran system.
`cloud_provider`	The cloud provider name.
`service`	The service name. We support the following services: `redshift`, `databricks`, `source`, `snowflake`.
`region`	The data processing location.
`state`	The state of the private link. Possible values: `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. Requires passing a full set of parameters corresponding to the configuration.

HTTP 400 BAD REQUEST

config block inconsistent.

HTTP 403 FORBIDDEN

Operation not available for current user.

HTTP 404 NOT_FOUND

Private link with linkId not found.

Delete a Private Linklink

Deletes a private link from your Fivetran account.

Requestlink

DELETE https://api.fivetran.com/v1/private-links/{linkId}

Path parameterslink

Name	Description
`linkId` (required)	Long. The unique identifier for the private link within your Fivetran account.

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "string"
}
content_copy

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 not found.

Documentation

Documentation

Private Links Management BETAlink

Create a Private Linklink

Requestlink

Payload parameterslink

Responselink

Private link setup configurationslink

Databricks or Source for AWSlink

Payload parameterslink

Databricks for Azurelink

Payload parameterslink

Snowflake for AWSlink

Payload parameterslink

Snowflake for Azurelink

Payload parameterslink

Redshift for AWSlink

Payload parameterslink

Source for Azurelink

Payload parameterslink

Synapse for Azurelink

Payload parameterslink

List all Private Links within Grouplink

Requestlink

Path parameterslink

Query parameterslink

Responselink

Fieldslink

Retrieve Private Link Detailslink

Requestlink

Query parameterslink

Responselink

Update a Private Linklink

Requestlink

Path parameterslink

Payload parameterslink

Responselink

Delete a Private Linklink

Requestlink

Path parameterslink

Responselink