Instaclustr Logo
Powered by Redocly

ClickHouse Integrations

Operations related to ClickHouse integrations

Retrieve all existing ClickHouse S3 FSxN integrations for the cluster.

Get all ClickHouse S3 FSxN integrations for a given cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string

ID of the ClickHouse cluster.

Responses
200

ClickHouse S3 FSxN integrations retrieved.

404

ClickHouse S3 FSxN integrations not found.

get/cluster-management/v2/data-sources/applications/clickhouse/clusters/v2/{clusterId}/integrations/list-s3-fsxns/v2/
Request samples 
Response samples 
application/json
{
  • "integrations": [
    ]
}
Add ClickHouse Domain integration.
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 ClickHouse Kafka integration.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
clusterId
required
string
ID of the ClickHouse cluster


 
required
object
Kafka cluster for the Kafka Integration


 
Responses 
202
Added ClickHouse Kafka integration.


post/cluster-management/v2/resources/applications/clickhouse/integrations/kafka/v2
Request samples 
application/json
{
  • "clusterId": "12aq0751-a169-8732-287a-21aedc6d23fd",
  • "id": "kafka-12345678-a169-8732-287a-21aedc6d23fd",
  • "kafkaCluster": {
    },
  • "namedCollection": "kafka-cluster-15gb5751-a184-8298-627a-29aedc6d23tg"
}
Response samples 
application/json
{
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "id": "kafka-12345678-32ac-4fa7-ab42-c165fe35aa55",
  • "kafkaCluster": {
    }
}
Retrieve all existing ClickHouse Kafka integrations for the cluster
Get a list of all ClickHouse Kafka integrations for a cluster


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string
id for the ClickHouse cluster.


 
Responses 
200
ClickHouse Kafka integrations retrieved


404
ClickHouse Kafka integrations not found


get/cluster-management/v2/resources/applications/clickhouse/integrations/kafka/v2/all/{clusterId}
Request samples 
Response samples 
application/json
{
  • "integrations": [
    ]
}
Retrieve an existing ClickHouse Kafka integration
Get a ClickHouse Kafka integration


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


 
Responses 
200
ClickHouse Kafka integration retrieved


404
ClickHouse Kafka integration not found


get/cluster-management/v2/resources/applications/clickhouse/integrations/kafka/v2/{id}
Request samples 
Response samples 
application/json
{
  • "clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
  • "id": "abce1234-12ec-5bd3-fg53-cg32ed15g7th",
  • "kafkaCluster": {
    },
  • "namedCollection": "kafka_cluster_f06c9a8f_2a64_4904_8e16_bb82bf254a72_topic_test1",
  • "status": "APPLIED"
}
Remove an existing integration
Delete a ClickHouse Kafka integration


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


 
Responses 
204
ClickHouse Kafka integration deleted


404
ClickHouse Kafka integration not found


delete/cluster-management/v2/resources/applications/clickhouse/integrations/kafka/v2/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Add ClickHouse S3 FSxN integration.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
required
object
FSx ONTAP file system for the S3 FSxN integration.


 
clusterId
required
string
ID of the ClickHouse cluster.


 
Responses 
202
Added ClickHouse S3 FSxN integration.


post/cluster-management/v2/resources/applications/clickhouse/integrations/s3-fsxn/v2
Request samples 
application/json
{
  • "clusterId": "12aq0751-a169-8732-287a-21aedc6d23fd",
  • "fsxnFilesystem": {
    },
  • "id": "15gb5751-a184-8298-627a-29aedc6d23",
  • "namedCollection": "fsxn_fs_03b0dec5533476086",
  • "status": "APPLIED"
}
Response samples 
application/json
{
  • "clusterId": "12aq0751-a169-8732-287a-21aedc6d23fd",
  • "fsxnFilesystem": {
    },
  • "id": "15gb5751-a184-8298-627a-29aedc6d23",
  • "namedCollection": "fsxn_fs_03b0dec5533476086",
  • "status": "APPLYING"
}
Retrieve an existing ClickHouse S3 FSxN integration.
Get a ClickHouse S3 FSxN integration.


SecurityBasic Authentication 
Request 
path Parameters
id
required
string
ID for the S3 FSxN integration.


 
Responses 
200
ClickHouse S3 FSxN integration retrieved.


404
ClickHouse S3 FSxN integration not found.


get/cluster-management/v2/resources/applications/clickhouse/integrations/s3-fsxn/v2/{id}
Request samples 
Response samples 
application/json
{
  • "clusterId": "12aq0751-a169-8732-287a-21aedc6d23fd",
  • "fsxnFilesystem": {
    },
  • "id": "15gb5751-a184-8298-627a-29aedc6d23",
  • "namedCollection": "fsxn_fs_03b0dec5533476086",
  • "status": "APPLIED"
}
Remove an existing S3 FSxN integration.
Delete a ClickHouse S3 FSxN integration.


SecurityBasic Authentication 
Request 
path Parameters
id
required
string
ID for the S3 FSxN integration.


 
Responses 
204
ClickHouse S3 FSxN integration deleted.


404
ClickHouse S3 FSxN integration not found.


delete/cluster-management/v2/resources/applications/clickhouse/integrations/s3-fsxn/v2/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Add ClickHouse Private S3 integration.
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 ClickHouse S3 Region integration.
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 Region 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 Region integration.
Get a ClickHouse S3 Region integration.


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


 
Responses 
200
ClickHouse S3 Region integration retrieved.


404
ClickHouse S3 Region 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 Region integration.
Update an existing ClickHouse S3 Region 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 Region integration.


404
ClickHouse S3 Region 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 Region integration.


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


 
Responses 
204
ClickHouse S3 Region integration deleted.


404
ClickHouse S3 Region 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