Update egress private endpoint.

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

PATCH /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}

cURL

cURL

curl --request PATCH \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id} \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --json '{"domain_names":["example.com","api.example.com"]}'

200

{
  "domain_names": [
    "<string>"
  ],
  "endpoint_address": "<string>",
  "endpoint_connection_id": "<string>",
  "id": "<string>",
  "region": "<string>",
  "state": "PENDING",
  "target_service_identifier": "<string>",
  "target_service_type": "PRIVATE_SERVICE",
  "domain_names_state": "EMPTY"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id · string · required

cluster_id identifies the CockroachDB Cloud cluster owning the egress private endpoint.

id · string · required

id is the UUID value of the egress private endpoint in CockroachDB Cloud.

Body

application/json

domain_names · string[] · required

domain_names are the domain names to associate with the egress private endpoint.

Response

200

application/json

A successful response.

domain_names · string[] · required

domain_names are the domain names associated with the egress private endpoint.

endpoint_address · string · required

endpoint_connection_id · string · required

endpoint_connection_id is the cloud-specific id for egress private endpoints. This connection ID is visible in CRL and CSP consoles as "VPC endpoint ID" and is used to uniquely identify the endpoint in external configurations.

id · string · required

A generated ID that uniquely identifies the egress_private_endpoint for use with the CockroachDB Cloud API. This ID is generic and not specific to the cloud provider.

region · string · required

region represents the cloud region that the endpoint was created in.

state · enum<string> · required

Available options: PENDING, PENDING_ACCEPTANCE, AVAILABLE, DELETING, DELETED, REJECTED, FAILED, EXPIRED

target_service_identifier · string · required

target_service_identifier represents the identifier of the target service. User-visible in CRL and CSP consoles as the "thing" the user is telling us to connect to, i.e. Service Name for AWS, Service Attachment for GCP, or ARN for AWS MSK.

target_service_type · enum<string> · required

Available options: PRIVATE_SERVICE, MSK_SASL_SCRAM, MSK_SASL_IAM, MSK_TLS

domain_names_state · enum<string>

Available options: EMPTY, PENDING, AVAILABLE, FAILED