---
title: "Test Connection"
method: POST
path: "/api/onboarding/clickhouse/test"
tags: ["clickhouse-onboarding"]
---

# Test Connection

`POST /api/onboarding/clickhouse/test`

## Request

- Base URL: `https://api.deeptrace.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.deeptrace.com/api/onboarding/clickhouse/test`
- Auth: none declared

## Request body

- ClickHouseTestRequest: Test an unsaved ClickHouse connection.
  - `host` string, required: ClickHouse host or IP
  - `port` integer
  - `username` string, required: ClickHouse username
  - `password` string, required: ClickHouse password
  - `use_ssl` boolean: Use HTTPS

## Response `200`

Successful Response

- ClickHouseTestResponse: Connection test result.
  - `success` boolean, required
  - `message` string, required
  - `server_version` string, nullable
  - `current_database` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/deeptrace/apis/deeptrace-api.md) - [All operations](https://skmtc.dev/deeptrace/apis/deeptrace-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deeptrace/apis/deeptrace-api/revisions/855e59bb07f0?raw)