Set the AWS Endpoint Connection state

The “status” in the response does not reflect the latest post-update status, but rather the status before the state is transitioned.

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/aws-endpoint-connections/{endpoint_id}

cURL

cURL

curl --request PATCH \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections/{endpoint_id} \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --json '{"status":"AVAILABLE"}'

200

{
  "endpoint_id": "<string>",
  "region_name": "<string>",
  "service_id": "<string>",
  "external_owner_id": "<string>"
}

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

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 is the ID for the cluster.

endpoint_id · string · required

endpoint_id is the ID for the VPC endpoint on the customer's side.

Body

application/json

status · enum<string> · required

• AVAILABLE: accept/verify the connection on the service side.
• REJECTED: reject the connection on the service side.

Available options: AVAILABLE, REJECTED

Response

200

application/json

A successful response.

cloud_provider · enum<string> · required

• GCP: The Google Cloud Platform cloud provider.
• AWS: The Amazon Web Services cloud provider.
• AZURE: The Azure cloud provider.

Available options: GCP, AWS, AZURE

endpoint_id · string · required

endpoint_id is the client side of the PrivateLink connection.

region_name · string · required

region_name is the cloud provider region name (i.e. us-east-1).

service_id · string · required

service_id is the server side of the PrivateLink connection. This is the same as AWSPrivateLinkEndpoint.service_id.

status · enum<string> · required

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

external_owner_id · string

external_owner_id represents the ID of the AWS account that owns the PrivateLink connection.