Create reverse private endpoint

POST/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints

Create a new reverse private endpoint.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the service that owns the Reverse Private Endpoint.

format: uuid

Request bodyJSON

descriptionoptionalstring
Reverse private endpoint description. Maximum length is 255 characters.

Example: "My reverse private endpoint"
typeoptionalVPC_ENDPOINT_SERVICEorVPC_RESOURCEorMSK_MULTI_VPCorGCP_PSC_SERVICE_ATTACHMENT
Reverse private endpoint type.

Example: "VPC_ENDPOINT_SERVICE"
vpcEndpointServiceNameoptionalstring | null
VPC endpoint service name.

Example: "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567"
vpcResourceConfigurationIdoptionalstring | null
VPC resource configuration ID. Required for VPC_RESOURCE type.

Example: "rcfg-12345678901234567"
vpcResourceShareArnoptionalstring | null
VPC resource share ARN. Required for VPC_RESOURCE type.

Example: "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567"
mskClusterArnoptionalstring | null
MSK cluster ARN. Required for MSK_MULTI_VPC type.

Example: "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster"
mskAuthenticationoptionalSASL_IAMorSASL_SCRAM
MSK cluster authentication type. Required for MSK_MULTI_VPC type.

Example: "SASL_IAM"
gcpServiceAttachmentoptionalstring | null
Private Preview. GCP PSC service attachment URI. Required for GCP_PSC_SERVICE_ATTACHMENT type. Format: projects/{project}/regions/{region}/serviceAttachments/{name}.

Example: "projects/my-project/regions/us-central1/serviceAttachments/my-service"
customPrivateDnsMappingsoptionalarray ofobject
Optional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview; contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com

Example: [{"privateDnsName":"my-service.example.com"},{"privateDnsName":"*.example.com"}]
1 properties
- privateDnsNameoptionalstring
  Optional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview; contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com
  
  Example: "*.my-service.example.com"

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
15 properties
- descriptionoptionalstring
  Reverse private endpoint description. Maximum length is 255 characters.
  
  Example: "My reverse private endpoint"
- typeoptionalVPC_ENDPOINT_SERVICEorVPC_RESOURCEorMSK_MULTI_VPCorGCP_PSC_SERVICE_ATTACHMENT
  Reverse private endpoint type.
  
  Example: "VPC_ENDPOINT_SERVICE"
- vpcEndpointServiceNameoptionalstring | null
  VPC endpoint service name.
  
  Example: "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567"
- vpcResourceConfigurationIdoptionalstring | null
  VPC resource configuration ID. Required for VPC_RESOURCE type.
  
  Example: "rcfg-12345678901234567"
- vpcResourceShareArnoptionalstring | null
  VPC resource share ARN. Required for VPC_RESOURCE type.
  
  Example: "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567"
- mskClusterArnoptionalstring | null
  MSK cluster ARN. Required for MSK_MULTI_VPC type.
  
  Example: "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster"
- mskAuthenticationoptionalSASL_IAMorSASL_SCRAM
  MSK cluster authentication type. Required for MSK_MULTI_VPC type.
  
  Example: "SASL_IAM"
- gcpServiceAttachmentoptionalstring | null
  Private Preview. GCP PSC service attachment URI. Required for GCP_PSC_SERVICE_ATTACHMENT type. Format: projects/{project}/regions/{region}/serviceAttachments/{name}.
  
  Example: "projects/my-project/regions/us-central1/serviceAttachments/my-service"
- customPrivateDnsMappingsoptionalarray ofobject
  Optional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview; contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com
  
  Example: [{"privateDnsName":"my-service.example.com"},{"privateDnsName":"*.example.com"}]
  1 properties
  privateDnsNameoptionalstring
  Optional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview; contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com
  
  Example: "*.my-service.example.com"
- idoptionalstring
  Reverse private endpoint ID.
  
  format: uuid
  Example: "12345678-1234-1234-1234-123456789012"
- serviceIdoptionalstring
  ClickHouse service ID reverse private endpoint is associated with.
  
  format: uuid
  Example: "12345678-1234-1234-1234-123456789012"
- endpointIdoptionalstring
  Reverse private endpoint endpoint ID.
  
  Example: "vpce-12345678901234567"
- dnsNamesoptionalarray ofstring
  Reverse private endpoint internal DNS names.
  
  Example: ["vpce-12345678901234567-abcdefg.execute-api.us-east-1.vpce.amazonaws.com"]
- privateDnsNamesoptionalarray ofstring
  Reverse private endpoint private DNS names.
  
  Example: ["vpce-12345678901234567-abcdefg.execute-api.us-east-1.vpce.amazonaws.com"]
- statusoptionalUnknownorProvisioningorDeletingorReadyorFailedorPendingAcceptance+2 more
  Reverse private endpoint status.
  
  Example: "Ready"

Create reverse private endpoint

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipesReversePrivateEndpoints \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "My reverse private endpoint",
  "type": "VPC_ENDPOINT_SERVICE",
  "vpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567",
  "vpcResourceConfigurationId": "rcfg-12345678901234567",
  "vpcResourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567",
  "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster",
  "mskAuthentication": "SASL_IAM",
  "gcpServiceAttachment": "projects/my-project/regions/us-central1/serviceAttachments/my-service",
  "customPrivateDnsMappings": [
    {
      "privateDnsName": "my-service.example.com"
    },
    {
      "privateDnsName": "*.example.com"
    }
  ]
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipesReversePrivateEndpoints';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({
    description: 'My reverse private endpoint',
    type: 'VPC_ENDPOINT_SERVICE',
    vpcEndpointServiceName: 'com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567',
    vpcResourceConfigurationId: 'rcfg-12345678901234567',
    vpcResourceShareArn: 'arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567',
    mskClusterArn: 'arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster',
    mskAuthentication: 'SASL_IAM',
    gcpServiceAttachment: 'projects/my-project/regions/us-central1/serviceAttachments/my-service',
    customPrivateDnsMappings: [{privateDnsName: 'my-service.example.com'}, {privateDnsName: '*.example.com'}]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipesReversePrivateEndpoints"

payload = {
    "description": "My reverse private endpoint",
    "type": "VPC_ENDPOINT_SERVICE",
    "vpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567",
    "vpcResourceConfigurationId": "rcfg-12345678901234567",
    "vpcResourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567",
    "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster",
    "mskAuthentication": "SASL_IAM",
    "gcpServiceAttachment": "projects/my-project/regions/us-central1/serviceAttachments/my-service",
    "customPrivateDnsMappings": [{ "privateDnsName": "my-service.example.com" }, { "privateDnsName": "*.example.com" }]
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "description": "My reverse private endpoint",
    "type": "VPC_ENDPOINT_SERVICE",
    "vpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567",
    "vpcResourceConfigurationId": "rcfg-12345678901234567",
    "vpcResourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567",
    "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster",
    "mskAuthentication": "SASL_IAM",
    "gcpServiceAttachment": "projects/my-project/regions/us-central1/serviceAttachments/my-service",
    "customPrivateDnsMappings": [
      {
        "privateDnsName": "my-service.example.com"
      },
      {
        "privateDnsName": "*.example.com"
      }
    ],
    "id": "12345678-1234-1234-1234-123456789012",
    "serviceId": "12345678-1234-1234-1234-123456789012",
    "endpointId": "vpce-12345678901234567",
    "dnsNames": [
      "vpce-12345678901234567-abcdefg.execute-api.us-east-1.vpce.amazonaws.com"
    ],
    "privateDnsNames": [
      "vpce-12345678901234567-abcdefg.execute-api.us-east-1.vpce.amazonaws.com"
    ],
    "status": "Ready"
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}