projects

Dry-run a bring-your-own ClickHouse connection without storing it (owner/admin)

post/v1/projects/{project_id}/clickhouse/validate

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/projects/{project_id}/clickhouse/validate
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

project_idstring required

Request body

databasestring required

the database the engine writes; it must already exist

hoststring required

hostname of the ClickHouse server, e.g. abc.eu-west-1.aws.clickhouse.cloud

http_portinteger

HTTP interface port; 0 = 8443 with tls, else 8123

native_portinteger

native protocol port; 0 = 9440 with tls, else 9000

passwordstring required

write-only; stored as an opaque secret ref and never returned

tlsboolean

speak https/native-TLS; defaults the ports to 8443 and 9440 instead of 8123 and 9000

usernamestring required

a user that already holds the required grants on that database

Response

OK

errorstring

why the check stopped, when it did

missing_grantsstring[]

privileges the user still needs on the database

okboolean required

true when the engine can be pointed at this connection as it stands

reachableboolean required
versionstring

the server's version() string

Changes

No recorded changes to this operation across all 1 revision of this API.