cURL
curl --request POST \
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--json '{"external_owner_id":"012345678901","type":"AWS_ACCOUNT_ID"}'{
"trusted_owner": {
"cluster_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"external_owner_id": "<string>",
"id": "<string>",
"type": "AWS_ACCOUNT_ID"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Add a private endpoint trusted owner to a cluster
Can be used by the following roles assigned at the organization, folder or cluster scope:
- CLUSTER_ADMIN
POST
/
api
/
v1
/
clusters
/
{cluster_id}
/
networking
/
private-endpoint-trusted-owners
cURL
curl --request POST \
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--json '{"external_owner_id":"012345678901","type":"AWS_ACCOUNT_ID"}'{
"trusted_owner": {
"cluster_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"external_owner_id": "<string>",
"id": "<string>",
"type": "AWS_ACCOUNT_ID"
}
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
cluster_id is the ID for the cluster.
Body
application/json
external_owner_id is the identifier of the owner within the cloud provider for private endpoint connections. A wildcard character ("*") can be used to denote all owners.
- AWS_ACCOUNT_ID: AWS_ACCOUNT_ID represents the 12-digit AWS account number.
Available options:
AWS_ACCOUNT_ID Response
A successful response.
PrivateEndpointTrustedOwner represents a trusted owner entry for private endpoint connections.
Show child attributes
Show child attributes