Instaclustr Logo
Powered by Redocly

ClickHouse Provisioning

Operations related to ClickHouse provisioning

List recent cluster backup events.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster.

Responses
200

List backups and restores for a given cluster

get/cluster-management/v2/data-sources/applications/clickhouse/clusters/v2/{clusterId}/list-backups/v2/
Request samples 
Response samples 
application/json
{
  • "clusterDataCentres": [
    ],
  • "id": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
  • "name": "example-cluster"
}
List compatible node sizes for ClickHouse
SecurityBasic Authentication 
Responses 
200
Successfully retrieved compatible node sizes for ClickHouse.


get/cluster-management/v2/data-sources/applications/clickhouse/compatible-node-sizes/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
List all ClickHouse versions
SecurityBasic Authentication 
Responses 
200
Successfully retrieved versions of ClickHouse.


get/cluster-management/v2/data-sources/applications/clickhouse/versions/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Manually trigger cluster backup.
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
ID of the cluster.


 
Responses 
202
Trigger cluster backup request accepted.


post/cluster-management/v2/operations/applications/clickhouse/clusters/v2/{clusterId}/trigger-backup/v2/
Request samples 
Trigger a ClickHouse cluster restore.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
Array of objects (ClusterDataCentreRestoreConfigV2) 
An optional list of Cluster Data Centres to determine their VPC in the restored cluster.


Data centres not included will default to being restored to a new VPC.


 
pointInTime
string
Timestamp in milliseconds since epoch or ISO formatted date and time (example - 2023-11-05T13:15:30Z). All backed up data will be restored for this point in time.


Defaults to the current date and time.


 
restoredClusterName
string  [ 3 .. 48 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]*
The display name of the restored cluster.


By default, the restored cluster will be created with its current name appended with “restored” and the date & time it was requested to be restored.


 
clusterId
required
string <uuid> 
ID of the cluster


 
Responses 
202
Successfully requested ClickHouse cluster restore.


post/cluster-management/v2/operations/applications/clickhouse/restore/v2
Request samples 
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "restoredClusterName": "my-restored-cluster"
}
Response samples 
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "restoredClusterName": "my-restored-cluster"
}
Create a ClickHouse cluster.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
required
Array of objects (ClickHouseDataCentreV2)   = 1 items 
List of data centre settings.


 
currentClusterOperationStatus
string (CurrentClusterOperationStatusV2) 
Indicates if the cluster is currently performing any restructuring operation such as being created or resized


 Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"  
privateNetworkCluster
required
boolean
Creates the cluster with private network only, see Private Network Clusters.


 
name
required
string  [ 3 .. 48 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]*
Name of the cluster.


 
clickhouseVersion
required
string[0-9]+\.[0-9]+\.[0-9]+
Version of ClickHouse to run on the cluster. Available versions: 
     
  • 23.8.16
    •  
  • 24.8.2
    •  


 
description
string
A description of the cluster


 
Array of objects (TwoFactorDeleteSettingsV2)   <= 1 items 
 
Array of objects (ResizeSettingsV2)   <= 1 items 
Settings to determine how resize requests will be performed for the cluster.


 
slaTier
required
string (SlaTierV2) 
SLA Tier of the cluster. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. See SLA Tier for more information.


 Enum: "PRODUCTION" "NON_PRODUCTION"  
Responses 
202
ClickHouse Cluster provisioning requested.


post/cluster-management/v2/resources/applications/clickhouse/clusters/v2
Request samples 
application/json
{
  • "clickhouseVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "name": "MyClickHouseCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION"
}
Response samples 
application/json
{
  • "clickhouseVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "name": "MyClickHouseCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION"
}
Get ClickHouse cluster details.
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Responses 
200
ClickHouse cluster details retrieved.


get/cluster-management/v2/resources/applications/clickhouse/clusters/v2/{clusterId}
Request samples 
Response samples 
application/json
{
  • "clickhouseVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "name": "MyClickHouseCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION"
}
Update ClickHouse Cluster Details
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Request Body schema: application/json
required
required
Array of objects (ClickHouseDataCentreV2)   = 1 items 
List of data centre settings.


 
description
string
A description of the cluster


 
Array of objects (TwoFactorDeleteSettingsV2)   <= 1 items 
 
Array of objects (ResizeSettingsV2)   <= 1 items 
Settings to determine how resize requests will be performed for the cluster.


 
Responses 
202
ClickHouse cluster update request accepted.


404
ClickHouse cluster not found


put/cluster-management/v2/resources/applications/clickhouse/clusters/v2/{clusterId}
Request samples 
application/json
{
  • "dataCentres": [
    ],
  • "description": "Cluster managed by the integration team.",
  • "twoFactorDelete": [
    ],
  • "resizeSettings": [
    ]
}
Response samples 
application/json
{
  • "clickhouseVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "name": "MyClickHouseCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION"
}
Delete cluster
Delete an active cluster.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Responses 
204
Cluster delete requested.


delete/cluster-management/v2/resources/applications/clickhouse/clusters/v2/{clusterId}
Request samples 
➔ Next to Cloud Provider Details V2