メインコンテンツへスキップ
メインコンテンツへスキップ

API リファレンス

ClickStack は、ダッシュボード、アラート、およびデータソースをプログラムから管理するための REST API を提供しています。API は Managed ClickStack（ClickHouse Cloud）と ClickStack Open Source の両方のデプロイメントで利用できますが、両者ではエンドポイントと認証方式が異なります。

API リファレンスドキュメント​

マネージド ClickStack の場合、API は ClickHouse Cloud API を経由して利用できます。ClickStack のエンドポイントは Cloud API 仕様 に記載されています。

利用可能なエンドポイントは次のとおりです。

リソース操作
Dashboardsダッシュボードの作成、一覧取得、取得、更新、および削除
Alertsアラートの作成、一覧取得、取得、更新、および削除
Sourcesデータソースの一覧取得

認証​

Managed ClickStack では、HTTP Basic Authentication による認証に ClickHouse Cloud API key を使用します。API key の作成と管理については、Managing API keys を参照してください。

HTTP Basic Authentication を使用して key ID と secret を指定します。

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/dashboards

ベースURLとリクエスト形式​

Managed ClickStack API へのすべてのリクエストは、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