Set up docs MCPClickStack предоставляет REST API для программного управления панелями мониторинга, оповещениями и источниками данных. API доступен как для Управляемого ClickStack (ClickHouse Cloud), так и для развертываний ClickStack с открытым исходным кодом, хотя конечные точки и способы аутентификации в этих двух случаях различаются.
Справочник по API
В Управляемом ClickStack доступ к API осуществляется через ClickHouse Cloud API. Конечные точки ClickStack доступны в справочнике Cloud API.
Доступны следующие конечные точки:
| Ресурс | Операции |
|---|---|
| Панели мониторинга | Создание, получение списка, получение, обновление и удаление панелей мониторинга |
| Оповещения | Создание, получение списка, получение, обновление и удаление оповещений |
| Источники данных | Получение списка источников данных |
Для ClickStack с открытым исходным кодом полная спецификация API поддерживается в репозитории HyperDX; её можно просматривать интерактивно или скачать в виде спецификации OpenAPI:
Доступны следующие конечные точки:
| Ресурс | Операции |
|---|---|
| Панели мониторинга | Создание, получение списка, получение, обновление и удаление панелей мониторинга |
| Оповещения | Создание, получение списка, получение, обновление и удаление оповещений |
| Диаграммы | Запрос данных временных рядов (только POST) |
| Источники данных | Получение списка источников данных |
| Вебхуки | Получение списка вебхуков |
Аутентификация
Управляемый ClickStack использует ключ API ClickHouse Cloud для аутентификации через HTTP Basic Authentication. Сведения о создании ключей API и управлении ими см. в разделе Управление ключами API.
Передайте идентификатор ключа и секрет с помощью HTTP Basic Authentication:
export KEY_ID=<your_key_id>
export KEY_SECRET=<your_key_secret>
curl --user $KEY_ID:$KEY_SECRET \
https://api.clickhouse.cloud/v1/organizations/<ORG_ID>/services/<SERVICE_ID>/clickstack/dashboardsClickStack с открытым исходным кодом использует для аутентификации токен Bearer через Personal API Access Key.
Чтобы получить ключ API:
- Откройте HyperDX по URL-адресу вашего ClickStack (например, http://localhost:8080)
- Создайте учётную запись или войдите в систему при необходимости
- Перейдите в Team Settings → API Keys
- Скопируйте свой Personal API Access Key
По умолчанию сервер API работает на порту 8000 (отдельно от интерфейса на порту 8080). Если вы используете Docker-образ all-in-one, обязательно явно пробросьте этот порт:
docker run -p 8080:8080 -p 8000:8000 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-oneПередайте ключ в заголовке Authorization:
curl -H "Authorization: Bearer <YOUR_API_KEY>" \
http://localhost:8000/api/v2/dashboardsБазовый URL и формат запроса
Все запросы к API Управляемого ClickStack отправляются в ClickHouse Cloud API:
https://api.clickhouse.cloud/v1/organizations/<ORG_ID>/services/<SERVICE_ID>/clickstack/<resource>Свой Organization ID можно найти в консоли ClickHouse Cloud в разделе Organization → Organization details. Service ID указан в URL сервиса и на странице сведений о сервисе.
Пример: Список панелей мониторинга
curl --user $KEY_ID:$KEY_SECRET \
https://api.clickhouse.cloud/v1/organizations/<ORG_ID>/services/<SERVICE_ID>/clickstack/dashboardsПример: Создание оповещения
curl -X POST --user $KEY_ID:$KEY_SECRET \
-H "Content-Type: application/json" \
-d '{
"dashboardId": "<DASHBOARD_ID>",
"tileId": "<TILE_ID>",
"threshold": 100,
"interval": "1h",
"source": "tile",
"thresholdType": "above",
"channel": {
"type": "webhook",
"webhookId": "<WEBHOOK_ID>"
},
"name": "Error Spike Alert",
"message": "Error rate exceeded 100 in the last hour"
}' \
https://api.clickhouse.cloud/v1/organizations/<ORG_ID>/services/<SERVICE_ID>/clickstack/alertsВсе запросы к API ClickStack с открытым исходным кодом отправляются на API-сервер HyperDX на порту 8000:
http://<YOUR_HYPERDX_HOST>:8000/api/v2/<resource>Например, при локальном развертывании по умолчанию:
http://localhost:8000/api/v2/dashboardsПример: Список панелей мониторинга
curl -H "Authorization: Bearer <YOUR_API_KEY>" \
http://localhost:8000/api/v2/dashboardsПример: Создание оповещения
curl -X POST \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"dashboardId": "<DASHBOARD_ID>",
"tileId": "<TILE_ID>",
"threshold": 100,
"interval": "1h",
"source": "tile",
"thresholdType": "above",
"channel": {
"type": "webhook",
"webhookId": "<WEBHOOK_ID>"
},
"name": "Error Spike Alert",
"message": "Error rate exceeded 100 in the last hour"
}' \
http://localhost:8000/api/v2/alertsПример: Запрос данных серии для графика
curl -X POST \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"startTime": 1647014400000,
"endTime": 1647100800000,
"granularity": "1h",
"series": [
{
"sourceId": "<SOURCE_ID>",
"aggFn": "count",
"where": "SeverityText:error",
"groupBy": []
}
]
}' \
http://localhost:8000/api/v2/charts/series