Managing extensions in Managed Service for ClickHouse®

Written by

Updated at December 22, 2025

Getting the list of available extensions
Retrieving a list of installed extensions
Getting extension info
Getting information about an extension installed in a cluster
Installing an extension in a cluster
Updating an extension
Deleting an extension from a cluster
Batch installation, updating, and deleting extensions

In Managed Service for ClickHouse® clusters, the following extensions are available:

Extension	Description
CatBoost	Analyzing data with the help of CatBoost ML models
GeoDB	Managing geobases: uploading, adding, and creating custom geobases

Getting the list of available extensions

CLI

REST API

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To get the list of all extensions available for installation and their versions, run this command:

yc managed-clickhouse extension list

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the Extension.List method, e.g., via the following cURL request:

curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/extensions'

View the server response to make sure your request was successful.

You can find the list of extensions available for installation and their versions in the extensions field of the command output.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

Call the ExtensionService.List method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "folder_id": "<folder_ID>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ExtensionService.List

You can get the folder ID with the list of folders in the cloud.

View the server response to make sure your request was successful.

You can find the list of extensions available for installation and their versions in the extensions field of the command output.

Retrieving a list of installed extensions

CLI

REST API

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

To get the list of all extensions installed in your cluster and their versions, run this command:

yc managed-clickhouse cluster list-extensions <cluster_name_or_ID>

You can get the cluster ID and name with the list of clusters in the folder.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the ClusterExtension.List method, e.g., via the following cURL request:

curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/extensions'

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

Call the ClusterExtensionService.List method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<cluster_ID>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.List

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Getting extension info

CLI

REST API

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

To get detailed extension info, run this command:

yc managed-clickhouse extension get <extension_name>

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the Extension.Get method, e.g., via the following cURL request:

curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/extensions/<extension_name>'

View the server response to make sure your request was successful.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

Call the ExtensionService.Get method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "extension_name": "<extension_name>",
        "folder_id": "<folder_ID>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ExtensionService.Get

You can get the folder ID with the list of folders in the cloud.

View the server response to make sure your request was successful.

Getting information about an extension installed in a cluster

CLI

REST API

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

To get information about an extension installed in a cluster, run this command:

yc managed-clickhouse cluster get-extension <cluster_name_or_ID> \
   --extension-name <extension_name>

You can get the cluster ID and name with the list of clusters in the folder.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the ClusterExtension.Get method, e.g., via the following cURL request:

curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/extensions/<extension_name>'

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

Call the ClusterExtensionService.Get method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<cluster_ID>",
        "extension_name": "<extension_name>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.Get

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Installing an extension in a cluster

CLI

REST API

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

To install an extension in a cluster, run this command:

yc managed-clickhouse cluster add-extension <cluster_name_or_ID> \
   --extension-name <extension_name>

You can get the cluster ID and name with the list of clusters in the folder.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the ClusterExtension.Create method, e.g., via the following cURL request:

curl \
  --request POST \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/extensions'
  --data '{
            "extensionSpec": {
              "name": "<extension_name>"
            }
          }'

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

Call the ClusterExtensionService.Create method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<cluster_ID>",
        "extension_spec": {
            "name": "<extension_name>"
        }
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.Create

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Updating an extension

CLI

REST API

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

To update an extension installed in a cluster, run this command:

yc managed-clickhouse cluster update-extension <cluster_name_or_ID> \
   --extension-name <extension_name>

You can get the cluster ID and name with the list of clusters in the folder.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the ClusterExtension.Update method, e.g., via the following cURL request:

curl \
  --request PATCH \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/extensions'
  --data '{
            "extensionSpec": {
              "name": "<extension_name>"
            }
          }'

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

Call the ClusterExtensionService.Update method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<cluster_ID>",
        "extension_spec": {
            "name": "<extension_name>"
        }
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.Update

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Deleting an extension from a cluster

CLI

REST API

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

To delete an extension from a cluster, run this command:

yc managed-clickhouse cluster remove-extension <cluster_name_or_ID> \
   --extension-name <extension_name>

You can get the cluster ID and name with the list of clusters in the folder.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the ClusterExtension.Delete method, e.g., via the following cURL request:

curl \
  --request DELETE \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/extensions/<extension_name>'

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

Call the ClusterExtensionService.Delete method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<cluster_ID>",
        "extension_name": "<extension_name>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.Delete

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Batch installation, updating, and deleting extensions

You can install, update, and delete multiple extensions using a single request. Do it by including the names of all the extensions in the request. The extensions you specify will be:

Installed if not present in the cluster.
Updated to the latest version if already installed in the cluster.

Extensions not specified in the request will be deleted from the cluster.

REST API

gRPC API

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

Call the ClusterExtension.SetExtensions method, e.g., via the following cURL request:

curl \
  --request POST \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/extensions:batchSet'
  --data '{
            "extensionSpec": [
              {
                "name": "<extension_name>"
              },
              {
                "name": "<extension_2_name>"
              },
              { ... },
              {
                "name": "<extension_N_name>"
              }
            ]
          }'

You can get the cluster ID with the list of clusters in the folder.

View the server response to make sure your request was successful.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

Call the ClusterExtensionService.SetExtensions method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<cluster_ID>",
        "extension_specs": [
          {
              "name": "<extension_name>"
          },
          {
              "name": "<extension_2_name>"
          },
          { ... },
          {
              "name": "<extension_N_name>"
          }          
        ]
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.SetExtensions

You can get the cluster ID with the list of clusters in the folder.

Check the server response to make sure your request was successful.

Managing extensions in Managed Service for ClickHouse®

Getting the list of available extensionsGetting the list of available extensions

Retrieving a list of installed extensionsRetrieving a list of installed extensions

Getting extension infoGetting extension info

Getting information about an extension installed in a clusterGetting information about an extension installed in a cluster

Installing an extension in a clusterInstalling an extension in a cluster

Updating an extensionUpdating an extension

Deleting an extension from a clusterDeleting an extension from a cluster

Batch installation, updating, and deleting extensionsBatch installation, updating, and deleting extensions

Was the article helpful?

Getting the list of available extensions

Retrieving a list of installed extensions

Getting extension info

Getting information about an extension installed in a cluster

Installing an extension in a cluster

Updating an extension

Deleting an extension from a cluster

Batch installation, updating, and deleting extensions