ClickPipes

Create reverse private endpoint

Create a new reverse private endpoint.

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

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the service.

serviceIdstring uuid required

ID of the service that owns the Reverse Private Endpoint.

Request body

descriptionstring required

Reverse private endpoint description. Maximum length is 255 characters.

type'VPC_ENDPOINT_SERVICE' | 'VPC_RESOURCE' | 'MSK_MULTI_VPC' | 'GCP_PSC_SERVICE_ATTACHMENT' required

Reverse private endpoint type.

vpcEndpointServiceNamestring

VPC endpoint service name.

vpcResourceConfigurationIdstring

VPC resource configuration ID. Required for VPC_RESOURCE type.

vpcResourceShareArnstring

VPC resource share ARN. Required for VPC_RESOURCE type.

mskClusterArnstring

MSK cluster ARN. Required for MSK_MULTI_VPC type.

mskAuthentication'SASL_IAM' | 'SASL_SCRAM'

MSK cluster authentication type. Required for MSK_MULTI_VPC type.

gcpServiceAttachmentstring

Private Preview. GCP PSC service attachment URI. Required for GCP_PSC_SERVICE_ATTACHMENT type. Format: projects/{project}/regions/{region}/serviceAttachments/{name}.

Example request

{
  "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/a1b2c3d4-5678-90ab-cdef-1234567890ab-1",
  "mskAuthentication": "SASL_IAM",
  "gcpServiceAttachment": "projects/my-project/regions/us-central1/serviceAttachments/my-service",
  "customPrivateDnsMappings": [
    {
      "privateDnsName": "my-service.example.com"
    },
    {
      "privateDnsName": "*.example.com"
    }
  ]
}

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "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/a1b2c3d4-5678-90ab-cdef-1234567890ab-1",
    "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"
    ],
    "privateDnsMappings": [
      {
        "privateDnsName": "my-service.example.com",
        "internalDnsName": "internal.example.com"
      }
    ],
    "dnsTargets": [
      {
        "id": "rcfg-097648d8068504966",
        "kind": "RESOURCE_CONFIGURATION",
        "internalDnsName": "internal.example.com"
      }
    ],
    "status": "Ready"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.