Update egress private endpoint domain names

cURL

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

{}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

PATCH

api

clusters

{cluster_id}

networking

egress-private-endpoints

{id}

domain-names

cURL

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

{}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

This endpoint is in Limited Access and may not be available to all users. Refer to the API support policy for more details.

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.

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

A successful response.

The response is of type object.

Update egress private endpoint.List all egress rules associated with a cluster

Overview

Endpoints

Update egress private endpoint domain names

Authorizations

Path Parameters

Body

Response