Private link connection

Private link connections represents the connection between your cluster private link and your virtual network private link endpoint.

Private link connections are automatically created when you create a cluster private link. This API lists, approves, or rejects these connections.

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 `ClusterPrivateLinkConnection` API resource

Response of a singleton cluster private link connection request.

Content type: application/json

Name	Type	Description
`id`	`string` in EID format	The ID of the private link connection.
`cluster_id`	`string` in EID format	The ID of cluster that the private link connection belongs to.
`name`	`string`	The name of the private link connection.
`status`	enum `string`	The status of the private link connection. Enum `approved`, `pending`, `rejected`, or `removed`.
`team_id`	`string` in EID format	The ID of the team that owns the associated cluster.

Example

{
    "cluster_id": "rvf73a77ozfsvcttryebfrnlem",
    "id": "qtrpik2jyrcebnk2qzhagw6w2a",
    "name": "my-connection",
    "status": "pending",
    "team_id": "eaevtjiudzeq7bsqbbpiscund4"
}

List private link connections

List private link connections of a cluster.

Unlike other list endpoints, this one doesn't support pagination.

GET /clusters/{cluster_id}/private-link-connections

Request

Path parameters

cluster_id: Unique ID of the cluster.

cURL example

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

Response

Status: 200

Response of a list cluster private link connections.

Content type: application/json

Name	Nullable	Type	Description
`connections`		`array` of `array`	Private link connections for a cluster.

Example

{
    "connections": [
        {
            "cluster_id": "rvf73a77ozfsvcttryebfrnlem",
            "id": "qtrpik2jyrcebnk2qzhagw6w2a",
            "name": "my-connection",
            "status": "pending",
            "team_id": "eaevtjiudzeq7bsqbbpiscund4"
        }
    ]
}

Approve a private link connection

Approve a private link connection for a cluster.

POST /clusters/{cluster_id}/private-link-connections/{connection_id}/actions/approve

Request

Path parameters

connection_id: The ID of the private link connection.
cluster_id: Unique ID of the cluster.

cURL example

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

Response

Status: 200

Responds with the standard ClusterPrivateLinkConnection API resource.

Reject a private link connection

Reject a private link connection.

POST /clusters/{cluster_id}/private-link-connections/{connection_id}/actions/reject

Request

Path parameters

connection_id: The ID of the private link connection.
cluster_id: Unique ID of the cluster.

cURL example

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

Response

Status: 200

Responds with the standard ClusterPrivateLinkConnection API resource.