Private link

Private links facilitate a secure connection between a Crunchy Bridge Postgres database and your application virtual network.

Set up a private link with these steps:

Create a private link for a cluster.
Create a private link endpoint in your application virtual network using the value of the endpoint_identifier field from the new private link.
Approve the private link connection using the private link connections API.

Part of the API reference collection

This page is part of the Crunchy Bridge API reference, and primarily meant to act as an exhaustive guide for technical integrations which are already in progress. To understand the basics of using the API, see API concepts and getting started.

The `ClusterPrivateLink` API resource

Response representing a cluster private link.

Content type: application/json

Name	Type	Description
`id`	`string` in EID format	Unique ID of the private link.
`cluster_id`	`string` in EID format	The ID of cluster that the logger belongs to.
`endpoint_identifier`	`string`	The identifier of the private link to use when setting up the link on the customer side.
`status`	enum `string`	Status of the private link. Enum `available`, or `creating`.
`team_id`	`string` in EID format	The ID of the team that owns the associated cluster.

Example

{
    "cluster_id": "rvf73a77ozfsvcttryebfrnlem",
    "endpoint_identifier": "vpce-075c50b2becc4c030",
    "id": "qtrpik2jyrcebnk2qzhagw6w2a",
    "status": "available",
    "team_id": "eaevtjiudzeq7bsqbbpiscund4"
}

Get private link

Get private link of a cluster, returns a 404 if the cluster has no private link.

GET /clusters/{cluster_id}/private-link

Request

Path parameters

cluster_id: Unique ID of the cluster.

cURL example

curl -X GET https://api.crunchybridge.com/clusters/{cluster_id}/private-link
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Responds with the standard ClusterPrivateLink API resource.

Create private link

Create a new private link for a cluster.

POST /clusters/{cluster_id}/private-link

Request

Path parameters

cluster_id: Unique ID of the cluster.

cURL example

curl -X POST https://api.crunchybridge.com/clusters/{cluster_id}/private-link
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 201

Responds with the standard ClusterPrivateLink API resource.

Destroy private link

Delete the private link of a cluster.

DELETE /clusters/{cluster_id}/private-link

Request

Path parameters

cluster_id: Unique ID of the cluster.

cURL example

curl -X DELETE https://api.crunchybridge.com/clusters/{cluster_id}/private-link
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Responds with the standard ClusterPrivateLink API resource.