Instaclustr Logo
Powered by Redocly

ClickHouse Integrations

Operations related to ClickHouse integrations

Add integration for ClickHouse

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

List of S3 regions to integrate with

clusterId
string

ID of the ClickHouse cluster

Responses
202

Added ClickHouse S3 Integration

post/cluster-management/v2/resources/applications/clickhouse/integrations/s3/v2
Request samples
application/json
{
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "id": "s3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "regions": [
    ]
}
Response samples
application/json
{
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "id": "s3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "regions": [
    ]
}

Retrieve an existing ClickHouse S3 integration

Get a ClickHouse S3 integration

SecurityBasic Authentication
Request
path Parameters
id
required
string

id for the S3 integration. This should be: 's3-'

Responses
200

ClickHouse S3 integration retrieved

404

ClickHouse S3 integration not found

get/cluster-management/v2/resources/applications/clickhouse/integrations/s3/v2/{id}
Request samples 
Response samples 
application/json
{
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "id": "s3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "regions": [
    ]
}
Update a ClickHouse S3 integration
Update an existing ClickHouse S3 integration


SecurityBasic Authentication 
Request 
path Parameters
id
required
string
id for the S3 integration. This should be: 's3-'


 
Request Body schema: application/json
required
Details of S3 Integration


Array of objects
List of S3 regions to integrate with


 
clusterId
string
ID of the ClickHouse cluster


 
Responses 
202
Updated ClickHouse S3 Integration


404
ClickHouse S3 integration not found


put/cluster-management/v2/resources/applications/clickhouse/integrations/s3/v2/{id}
Request samples 
application/json
{
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "id": "s3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "regions": [
    ]
}
Response samples 
application/json
{
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "id": "s3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "regions": [
    ]
}
Remove an existing integration
Delete a ClickHouse S3 integration


SecurityBasic Authentication 
Request 
path Parameters
id
required
string
id for the S3 integration. This should be: 's3-'


 
Responses 
204
ClickHouse S3 integration deleted


404
ClickHouse S3 integration not found


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