Skip to main content

Cluster Creation

When creating a cluster, it isn't immediately available upon creation. It will take some time for Kubernetes and the provider to have it ready and running, hence the message: 'Cluster creation in progress.'

Create a cluster

Provide the API with the cluster payload and your access token to spin up your cluster.

curl -X 'POST' \
'' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Cluster Test",
"machine_id": 1,
"clickhouse": {
"version_id": 1,
"shards": 3,
"replicas": 1,
"disks": [{
"name": "your_disk_name",
"type": {
"name": "ssd"
"size": 15.0,
"unit": "GB",
"autoscaling": false
"admin": {
"username": "choose_your_username",
"password": "choose_your_password"
"provider_id": 2,
"region_id": 4
# Payload response ::Dictionary
"message": "Cluster creation in progress."

The cluster payload


name  ::String

The cluster name

machine_id  ::Integer

The id of the machine you want. See the machines section

clickhouse  ::Dictionary

shards  ::Integer

The number of shards the cluster has

replicas  ::Integer

The number of replicas the cluster has

disks  ::List[Dictionary]

The array of disks

type  ::Dictionary

The disk type (hdd, ssd, gp2...)

name  ::String

The name of the disk

size  ::Float

The disk size

unit  ::String

The disk unit (GB, TB, GiB, TiB)

provider_id  ::Integer

The provider you want the cluster to be with. See the providers section

region_id  ::Integer

The region you want the region to be in. See the providers section

Cluster creation response


message  ::String

A basic response message