> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API キーの管理

> ClickHouse Cloud は OpenAPI を利用した API を提供しており、アカウントやサービスに関する各種項目をプログラムから管理できます。

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

ClickHouse Cloud では OpenAPI を利用する API が提供されており、アカウントやサービスの各種項目をプログラムから管理できます。

<Note>
  このドキュメントでは ClickHouse Cloud API について説明します。データベース API エンドポイントについては、[Cloud Endpoints API](/docs/ja/products/cloud/guides/sql-console/query-endpoints) を参照してください。
</Note>

<Steps>
  <Step title="API キーのページを開く">
    左側のメニューにある **API Keys** タブを使用して、API キーを作成および管理できます。

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi1.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=4b5e224e02e9995b15f410c0b53cc5e7" size="sm" alt="API Keys タブ" border width="433" height="472" data-path="images/cloud/manage/openapi1.webp" />
  </Step>

  <Step title="API キーの作成を開始する">
    **API Keys** ページには、最初は下図のように最初の API キーを作成するための案内が表示されます。最初のキーを作成すると、以降は右上に表示される `New API Key` ボタンから新しいキーを作成できます。

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi2.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=3ad9d02d51c9ac4c8b0649027ccf61ec" size="md" alt="API Keys ページ" border width="1036" height="466" data-path="images/cloud/manage/openapi2.webp" />
  </Step>

  <Step title="API キーを設定する">
    キー名、キーの権限、有効期限を指定します。

    <Note>
      権限は ClickHouse Cloud の[事前定義ロール](/docs/ja/products/cloud/reference/security/console-roles)に対応しています。developer ロールには割り当てられたサービスに対する読み取り専用権限があり、admin ロールには読み取りと書き込みの両方に対する完全な権限があります。
    </Note>

    <Tip>
      **クエリ API エンドポイント**

      API キーを [クエリ API エンドポイント](/docs/ja/products/cloud/guides/sql-console/query-endpoints) で使用するには、Organization Role を `Member` (最低でも) に設定し、Service Role に `Query Endpoints` へのアクセスを付与してください。
    </Tip>

    <Image img="https://mintcdn.com/private-7c7dfe99/C7EtYbvQvbHPGmL5/images/cloud/manage/openapi3.png?fit=max&auto=format&n=C7EtYbvQvbHPGmL5&q=85&s=d85d50665cb229cce53ba16a82a27cd1" size="md" alt="API キー作成フォーム" border width="661" height="410" data-path="images/cloud/manage/openapi3.png" />
  </Step>

  <Step title="許可する IP アドレスを追加する">
    API キーを使用できるクライアントを制限するには、**Allow access to this API Key** セクションで **Specific locations** を選択します。`203.0.113.1` や `203.0.113.0/24` などの IP アドレスまたは CIDR 範囲を入力し、必要に応じて追加のエントリを加えます。

    クエリ API エンドポイントでは、API キーレベルの IP 許可リストが適用されます。リクエストは ClickHouse のインフラストラクチャ内からプロキシされるため、サービスレベルの IP 許可リストは適用されません。詳しくは [IP Access Control](/docs/ja/cloud/features/query-api-endpoints#ip-access-control) を参照してください。

    <Image img="https://mintcdn.com/private-7c7dfe99/A68-kVUDkVcT2W3b/images/cloud/guides/query-endpoints/specific-locations.webp?fit=max&auto=format&n=A68-kVUDkVcT2W3b&q=85&s=db3d75c39aa5c3e73bc0d23dad7ae25c" size="md" alt="API キーに設定された許可済み IP アドレス" border width="1336" height="1740" data-path="images/cloud/guides/query-endpoints/specific-locations.webp" />

    キーの設定が完了したら、**Generate API Key** をクリックします。
  </Step>

  <Step title="API キーの認証情報を保存する">
    次の画面に Key ID と Key secret が表示されます。これらの値をコピーし、保管庫などの安全な場所に保存してください。この画面を離れると、これらの値は再表示されません。

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi4.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=5872535bb69a2299c88f38c627ead497" size="md" alt="API キーの詳細" border width="653" height="271" data-path="images/cloud/manage/openapi4.webp" />
  </Step>

  <Step title="API リクエストを認証する">
    ClickHouse Cloud API では、API キーの有効性を確認するために [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) を使用します。以下は、API キーを使用して `curl` で ClickHouse Cloud API にリクエストを送信する例です。

    ```bash theme={null}
    $ KEY_ID=mykeyid
    $ KEY_SECRET=mykeysecret

    $ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations
    ```
  </Step>

  <Step title="既存の API キーを管理する">
    **API Keys** ページに戻ると、キー名、Key ID の末尾 4 文字、権限、ステータス、有効期限、作成者が表示されます。この画面からキー名、権限、有効期限を編集できます。また、この画面からキーを無効化または削除することもできます。

    <Note>
      API キーの削除は元に戻せない操作です。そのキーを使用しているサービスは、ただちに ClickHouse Cloud へのアクセスを失います。
    </Note>

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi5.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=e81ed237b99933a115f931acc919c8f8" size="md" alt="API Keys 管理ページ" border width="1092" height="335" data-path="images/cloud/manage/openapi5.webp" />
  </Step>
</Steps>

<div id="endpoints">
  ## エンドポイント
</div>

エンドポイントの詳細については、[API リファレンス](/docs/ja/products/cloud/api-reference/organization/get-list-of-available-organizations)を参照してください。
base URL `https://api.clickhouse.cloud/v1` を使用し、API キー と API Secret を指定します。