Instaclustr Logo
Powered by Redocly

ClickHouse Configurations

Operations related to ClickHouse configuration properties.

Create configuration

Create ClickHouse configuration with a collection of overrides.

SecurityBasic Authentication
Request
Request Body schema: application/json
required
Array of objects non-empty

List of configuration overrides

clusterId
string

ID of the ClickHouse cluster

Responses
202

ClickHouse configuration created.

404

ClickHouse cluster not found.

post/cluster-management/v2/resources/applications/clickhouse/configurations/v2
Request samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "configurationOverrides": [
    ],
  • "id": "cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246"
}
Response samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "configurationOverrides": [
    ],
  • "id": "cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246"
}

Retrieve all configuration overrides applied to the cluster

Retrieve all configuration overrides applied to the cluster.

SecurityBasic Authentication
Request
path Parameters
id
required
string

ID of the cluster's configuration. This should be of the form: 'cfg-'.

Responses
200

ClickHouse configuration overrides successfully retrieved.

404

ClickHouse configuration not found.

get/cluster-management/v2/resources/applications/clickhouse/configurations/v2/{id}
Request samples 
Response samples 
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "configurationOverrides": [
    ],
  • "id": "cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246"
}
Update ClickHouse configuration overrides
Update ClickHouse configuration overrides.


SecurityBasic Authentication 
Request 
path Parameters
id
required
string
ID of the cluster's configuration. This should be of the form: 'cfg-'.


 
Request Body schema: application/json
required
Array of objects  non-empty 
List of configuration overrides


 
clusterId
string
ID of the ClickHouse cluster


 
Responses 
202
ClickHouse configuration overrides successfully updated.


404
ClickHouse configuration not found.


put/cluster-management/v2/resources/applications/clickhouse/configurations/v2/{id}
Request samples 
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "configurationOverrides": [
    ],
  • "id": "cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246"
}
Response samples 
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "configurationOverrides": [
    ],
  • "id": "cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246"
}
Reset ClickHouse configuration
Restore all configuration properties to their corresponding defaults.


SecurityBasic Authentication 
Request 
path Parameters
id
required
string
ID of the cluster's configuration. This should be of the form: 'cfg-'.


 
Responses 
204
ClickHouse configuration overrides deleted for the cluster.


404
ClickHouse configuration not found.


delete/cluster-management/v2/resources/applications/clickhouse/configurations/v2/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to ClickHouse Integrations