メインコンテンツへスキップ
ClickHouse Cloud では、OpenAPI を利用した API が提供されており、アカウントやサービスの一部機能をプログラムから管理できます。
このドキュメントでは ClickHouse Cloud API を扱います。データベースの API エンドポイントについては、Cloud Endpoints API を参照してください。
  1. 左側のメニューにある API Keys タブから、API キーを作成および管理できます。
  1. API Keys ページを開くと、最初は以下のように最初の API キーを作成するための案内が表示されます。最初のキーを作成すると、右上に表示される New API Key ボタンから新しいキーを作成できるようになります。
  1. API キーを作成するには、キー名、キーの権限、有効期限を指定し、Generate API Key をクリックします。

権限は ClickHouse Cloud の事前定義ロールに対応しています。developer ロールには割り当てられたサービスに対する読み取り専用権限があり、admin ロールには完全な読み取りおよび書き込み権限があります。
クエリ API エンドポイントクエリ API エンドポイント で API キーを使用するには、Organization Role を少なくとも Member に設定し、Service Role に Query Endpoints へのアクセスを付与してください。
  1. 次の画面に Key ID と Key secret が表示されます。これらの値をコピーし、vault などの安全な場所に保管してください。この画面を離れると、これらの値は再表示されません。
  1. ClickHouse Cloud API では、HTTP Basic Authentication を使用して API キーの有効性を検証します。以下は、curl を使用して API キーで ClickHouse Cloud API にリクエストを送信する例です。
$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations
  1. API Keys ページに戻ると、キー名、Key ID の末尾 4 文字、権限、ステータス、有効期限、作成者が表示されます。この画面から、キー名、権限、有効期限を編集できます。また、キーの無効化や削除もこの画面から行えます。

API キーの削除は元に戻せない操作です。このキーを使用しているサービスは、直ちに ClickHouse Cloud へアクセスできなくなります。

​
エンドポイント

エンドポイントの詳細については、API リファレンスを参照してください。 base URL https://api.clickhouse.cloud/v1 を使用し、API キー と API Secret を指定します。
最終更新日 2026年6月10日