> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud: Clickhouse Click Pipe Reverse Private Endpoint Update

> Update reverse private endpoint. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Update reverse private endpoint.

<Info>
  Tool ID: `clickhouse_click_pipe_reverse_private_endpoint_update`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_click_pipe_reverse_private_endpoint_update',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000",
    "reversePrivateEndpointId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute clickhouse_click_pipe_reverse_private_endpoint_update --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "reversePrivateEndpointId": "123e4567-e89b-42d3-a456-426614174000"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "description": "Example description",
      "type": "VPC_ENDPOINT_SERVICE",
      "vpcEndpointServiceName": "Example"
    }
  }
}
```

Use `deepline tools get clickhouse_click_pipe_reverse_private_endpoint_update --json` for the latest machine-readable contract.

## Input reference

Update mutable fields for an existing reverse private endpoint. customPrivateDnsMappings is a full replacement list. Use an empty array to clear mappings.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizationId` | `string` | Yes | — | ID of the organization that owns the service. Format: `uuid`. |
| `payload.serviceId` | `string` | Yes | — | ID of the service that owns the Reverse Private Endpoint. Format: `uuid`. |
| `payload.reversePrivateEndpointId` | `string` | Yes | — | ID of the reverse private endpoint to update. Format: `uuid`. |
| `payload.customPrivateDnsMappings` | `array` | No | — | 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 |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Update mutable fields for an existing reverse private endpoint. customPrivateDnsMappings is a full replacement list. Use an empty array to clear mappings.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the organization that owns the service.",
        "format": "uuid"
      },
      "serviceId": {
        "type": "string",
        "description": "ID of the service that owns the Reverse Private Endpoint.",
        "format": "uuid"
      },
      "reversePrivateEndpointId": {
        "type": "string",
        "description": "ID of the reverse private endpoint to update.",
        "format": "uuid"
      },
      "customPrivateDnsMappings": {
        "type": "array",
        "description": "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",
        "items": {
          "properties": {
            "privateDnsName": {
              "type": "string",
              "description": "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"
            }
          },
          "additionalProperties": false
        }
      }
    },
    "required": [
      "organizationId",
      "serviceId",
      "reversePrivateEndpointId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.status` | `number` | No | — | HTTP status code. |
| `result.data.requestId` | `string` | No | — | Unique id assigned to every request. UUIDv4 Format: `uuid`. |
| `result.data.result` | `object` | No | — | — |
| `result.data.result.description` | `string` | No | — | Reverse private endpoint description. Maximum length is 255 characters. |
| `result.data.result.type` | `"VPC_ENDPOINT_SERVICE" \| "VPC_RESOURCE" \| "MSK_MULTI_VPC" \| "GCP_PSC_SERVICE_ATTACHMENT"` | No | — | Reverse private endpoint type. Allowed: `VPC_ENDPOINT_SERVICE`, `VPC_RESOURCE`, `MSK_MULTI_VPC`, `GCP_PSC_SERVICE_ATTACHMENT`. |
| `result.data.result.vpcEndpointServiceName` | `string \| null` | No | — | VPC endpoint service name. |
| `result.data.result.vpcResourceConfigurationId` | `string \| null` | No | — | VPC resource configuration ID. Required for VPC\_RESOURCE type. |
| `result.data.result.vpcResourceShareArn` | `string \| null` | No | — | VPC resource share ARN. Required for VPC\_RESOURCE type. |
| `result.data.result.mskClusterArn` | `string \| null` | No | — | MSK cluster ARN. Required for MSK\_MULTI\_VPC type. |
| `result.data.result.mskAuthentication` | `"SASL_IAM" \| "SASL_SCRAM"` | No | — | MSK cluster authentication type. Required for MSK\_MULTI\_VPC type. Allowed: `SASL_IAM`, `SASL_SCRAM`. |
| `result.data.result.gcpServiceAttachment` | `string \| null` | No | — | Private Preview. GCP PSC service attachment URI. Required for GCP\_PSC\_SERVICE\_ATTACHMENT type. Format: projects/\{project}/regions/\{region}/serviceAttachments/\{name}. |
| `result.data.result.customPrivateDnsMappings` | `array` | No | — | 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 |
| `result.data.result.customPrivateDnsMappings[].privateDnsName` | `string` | No | — | 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 |
| `result.data.result.id` | `string` | No | — | Reverse private endpoint ID. Format: `uuid`. |
| `result.data.result.serviceId` | `string` | No | — | ClickHouse service ID reverse private endpoint is associated with. Format: `uuid`. |
| `result.data.result.endpointId` | `string` | No | — | Reverse private endpoint endpoint ID. |
| `result.data.result.dnsNames` | `array` | No | — | Reverse private endpoint internal DNS names. |
| `result.data.result.privateDnsNames` | `array` | No | — | Reverse private endpoint private DNS names. |
| `result.data.result.status` | `"Unknown" \| "Provisioning" \| "Deleting" \| "Ready" \| "Failed" \| "PendingAcceptance" \| "Rejected" \| "Expired"` | No | — | Reverse private endpoint status. Allowed: `Unknown`, `Provisioning`, `Deleting`, `Ready`, `Failed`, `PendingAcceptance`, `Rejected`, `Expired`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "description": {
                "type": "string",
                "description": "Reverse private endpoint description. Maximum length is 255 characters."
              },
              "type": {
                "type": "string",
                "description": "Reverse private endpoint type.",
                "enum": [
                  "VPC_ENDPOINT_SERVICE",
                  "VPC_RESOURCE",
                  "MSK_MULTI_VPC",
                  "GCP_PSC_SERVICE_ATTACHMENT"
                ]
              },
              "vpcEndpointServiceName": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "VPC endpoint service name."
              },
              "vpcResourceConfigurationId": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "VPC resource configuration ID. Required for VPC_RESOURCE type."
              },
              "vpcResourceShareArn": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "VPC resource share ARN. Required for VPC_RESOURCE type."
              },
              "mskClusterArn": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "MSK cluster ARN. Required for MSK_MULTI_VPC type."
              },
              "mskAuthentication": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "MSK cluster authentication type. Required for MSK_MULTI_VPC type.",
                "enum": [
                  "SASL_IAM",
                  "SASL_SCRAM"
                ]
              },
              "gcpServiceAttachment": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Private Preview. GCP PSC service attachment URI. Required for GCP_PSC_SERVICE_ATTACHMENT type. Format: projects/{project}/regions/{region}/serviceAttachments/{name}."
              },
              "customPrivateDnsMappings": {
                "type": "array",
                "description": "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",
                "items": {
                  "properties": {
                    "privateDnsName": {
                      "type": "string",
                      "description": "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"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "id": {
                "type": "string",
                "description": "Reverse private endpoint ID.",
                "format": "uuid"
              },
              "serviceId": {
                "type": "string",
                "description": "ClickHouse service ID reverse private endpoint is associated with.",
                "format": "uuid"
              },
              "endpointId": {
                "type": "string",
                "description": "Reverse private endpoint endpoint ID."
              },
              "dnsNames": {
                "type": "array",
                "description": "Reverse private endpoint internal DNS names.",
                "items": {
                  "type": "string"
                }
              },
              "privateDnsNames": {
                "type": "array",
                "description": "Reverse private endpoint private DNS names.",
                "items": {
                  "type": "string"
                }
              },
              "status": {
                "type": "string",
                "description": "Reverse private endpoint status.",
                "enum": [
                  "Unknown",
                  "Provisioning",
                  "Deleting",
                  "Ready",
                  "Failed",
                  "PendingAcceptance",
                  "Rejected",
                  "Expired"
                ]
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [ClickHouse Cloud provider guide](/docs/providers/clickhouse/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.