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": [{"target": "www.example.com"
},
{"target": "www.anotherexample.com"
}
]
}

Response samples

202

application/json

{"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"domains": [{"status": "RUNNING",
"target": "www.example.com"
},
{"status": "GENESIS",
"target": "www.anotherexample.com"
}
],
"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

200
404

application/json

{"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"domains": [{"status": "RUNNING",
"target": "www.example.com"
},
{"status": "GENESIS",
"target": "www.anotherexample.com"
}
],
"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": [{"target": "www.example.com"
},
{"target": "www.anotherexample.com"
}
]
}

Response samples

202
404

application/json

{"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"domains": [{"status": "RUNNING",
"target": "www.example.com"
},
{"status": "GENESIS",
"target": "www.anotherexample.com"
}
],
"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

404

application/json

{"errors": [{"name": "string",
"message": "string"
}
]
}

Add integration for ClickHouse

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": {"format": "Avro",
"id": "12aq0751-a169-8732-287a-21aedc6d23fc",
"topicName": "kafka-topic"
},
"namedCollection": "kafka-cluster-15gb5751-a184-8298-627a-29aedc6d23tg"
}

Response samples

202

application/json

{"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"id": "kafka-12345678-32ac-4fa7-ab42-c165fe35aa55",
"kafkaCluster": {"format": "Avro",
"id": "10e4320e-32ac-4le7-39ft-c165fe353gb4",
"topicName": "example-topic"
}
}

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

200
404

application/json

{"integrations": [{"clusterId": "12aq0751-a169-8732-287a-21aedc6d23fd",
"id": "kafka-12345678-a169-8732-287a-21aedc6d23fd",
"kafkaCluster": {"format": "Avro",
"id": "12aq0751-a169-8732-287a-21aedc6d23fc",
"topicName": "kafka-topic"
},
"namedCollection": "kafka-cluster-15gb5751-a184-8298-627a-29aedc6d23tg"
}
]
}

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

200
404

application/json

{"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"id": "abce1234-12ec-5bd3-fg53-cg32ed15g7th",
"kafkaCluster": {"format": "Avro",
"id": "abce1234-12ec-5bd3-fg53-cg32ed15g7th",
"topicName": "example-topic"
},
"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

404

application/json

{"errors": [{"name": "string",
"message": "string"
}
]
}

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": [{"arn": "arn:aws:s3:::example-s3-bucket",
"readOnly": false
},
{"arn": "arn:aws:s3:::example-s3-bucket2",
"readOnly": true
}
],
"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"kmsKeyArns": ["arn:aws:kms:us-west-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
]
}

Response samples

202

application/json

{"buckets": [{"arn": "arn:aws:s3:::example-s3-bucket",
"readOnly": false
},
{"arn": "arn:aws:s3:::example-s3-bucket2",
"readOnly": true
}
],
"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"id": "privateS3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"kmsKeyArns": ["arn:aws:kms:us-west-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
],
"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

200
404

application/json

{"buckets": [{"arn": "arn:aws:s3:::example-s3-bucket",
"readOnly": false
},
{"arn": "arn:aws:s3:::example-s3-bucket2",
"readOnly": true
}
],
"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"id": "privateS3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"kmsKeyArns": ["arn:aws:kms:us-west-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
],
"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": [{"arn": "arn:aws:s3:::example-s3-bucket",
"readOnly": false
},
{"arn": "arn:aws:s3:::example-s3-bucket2",
"readOnly": true
}
],
"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"kmsKeyArns": ["arn:aws:kms:us-west-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
]
}

Response samples

202
404

application/json

{"buckets": [{"arn": "arn:aws:s3:::example-s3-bucket",
"readOnly": false
},
{"arn": "arn:aws:s3:::example-s3-bucket2",
"readOnly": true
}
],
"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"id": "privateS3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"kmsKeyArns": ["arn:aws:kms:us-west-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
],
"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

404

application/json

{"errors": [{"name": "string",
"message": "string"
}
]
}

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": [{"target": "US-EAST-1"
},
{"target": "US-WEST-1"
}
]
}

Response samples

202

application/json

{"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"id": "s3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"regions": [{"status": "RUNNING",
"target": "US-EAST-1"
},
{"status": "GENESIS",
"target": "US-WEST-1"
}
]
}

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

200
404

application/json

{"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"id": "s3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"regions": [{"status": "RUNNING",
"target": "US-EAST-1"
},
{"status": "GENESIS",
"target": "US-WEST-1"
}
]
}

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": [{"target": "US-EAST-1"
},
{"target": "US-WEST-1"
}
]
}

Response samples

202
404

application/json

{"clusterId": "71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"id": "s3-71e4380e-32ac-4fa7-ab42-c165fe35aa55",
"regions": [{"status": "RUNNING",
"target": "US-EAST-1"
},
{"status": "GENESIS",
"target": "US-WEST-1"
}
]
}

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

404

application/json

{"errors": [{"name": "string",
"message": "string"
}
]
}

ClickHouse Integrations

Add integration for ClickHouse

Request Body schema: application/jsonrequired

Retrieve an existing ClickHouse Domain integration

path Parameters

Update a ClickHouse Domain integration

path Parameters

Request Body schema: application/jsonrequired

Remove an existing integration

path Parameters

Add integration for ClickHouse

Request Body schema: application/jsonrequired

Retrieve all existing ClickHouse Kafka integrations for the cluster

path Parameters

Retrieve an existing ClickHouse Kafka integration

path Parameters

Remove an existing integration

path Parameters

Add private S3 integration for ClickHouse

Request Body schema: application/jsonrequired

Retrieve an existing ClickHouse Private S3 integration

path Parameters

Update a ClickHouse Private S3 integration

path Parameters

Request Body schema: application/jsonrequired

Remove an existing private S3 integration

path Parameters

Add integration for ClickHouse

Request Body schema: application/jsonrequired

Retrieve an existing ClickHouse S3 integration

path Parameters

Update a ClickHouse S3 integration

path Parameters

Request Body schema: application/jsonrequired

Remove an existing integration

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required