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 domains to integrate with

clusterId
string

ID of the ClickHouse cluster

Responses
202

Added ClickHouse Domain Integration

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

Retrieve an existing ClickHouse Domain integration

Get a ClickHouse Domain integration

SecurityBasic Authentication
Request
path Parameters
id
required
string

id for the Domain integration. This should be: 'domain-'

Responses
200

ClickHouse Domain integration retrieved

404

ClickHouse Domain integration not found

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


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


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


Array of objects
List of domains to integrate with


 
clusterId
string
ID of the ClickHouse cluster


 
Responses 
202
Updated ClickHouse Domain Integration


404
ClickHouse Domain integration not found


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


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


 
Responses 
204
ClickHouse Domain integration deleted


404
ClickHouse Domain integration not found


delete/cluster-management/v2/resources/applications/clickhouse/integrations/domain/v2/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Add private S3 integration for ClickHouse
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
kmsKeyArns
Array of strings  >= 0 items 
List of KMS key ARNs


 
required
Array of objects  non-empty 
S3 buckets for the Private S3 Integration


 
clusterId
required
string
ID of the ClickHouse cluster


 
Responses 
202
Added ClickHouse Private S3 Integration


post/cluster-management/v2/resources/applications/clickhouse/integrations/s3-private/v2
Request samples 
application/json
{
  • "buckets": [
    ],
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "kmsKeyArns": [
    ]
}
Response samples 
application/json
{
  • "buckets": [
    ],
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "id": "privateS3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "kmsKeyArns": [
    ],
  • "status": "APPLIED"
}
Retrieve an existing ClickHouse Private S3 integration
Get a ClickHouse Private S3 integration


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


 
Responses 
200
ClickHouse Private S3 integration retrieved


404
ClickHouse Private S3 integration not found


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


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


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


kmsKeyArns
Array of strings  >= 0 items 
List of KMS key ARNs


 
required
Array of objects  non-empty 
S3 buckets for the Private S3 Integration


 
clusterId
required
string
ID of the ClickHouse cluster


 
Responses 
202
Updated ClickHouse Private S3 Integration


404
ClickHouse Private S3 integration not found


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


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


 
Responses 
204
ClickHouse Private S3 integration deleted


404
ClickHouse Private S3 integration not found


delete/cluster-management/v2/resources/applications/clickhouse/integrations/s3-private/v2/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Add integration for ClickHouse
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
Array of objects  non-empty 
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",
  • "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  non-empty 
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",
  • "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