> ## 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 предоставляет API на базе OpenAPI, который позволяет программно управлять вашим аккаунтом и некоторыми аспектами ваших сервисов.

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 предоставляет API на основе OpenAPI, который позволяет программно управлять вашим аккаунтом и отдельными аспектами ваших сервисов.

<Note>
  В этом документе рассматривается ClickHouse Cloud API. Сведения о конечных точках API базы данных см. в разделе [Cloud Endpoints API](/docs/ru/products/cloud/guides/sql-console/query-endpoints)
</Note>

<Steps>
  <Step title="Откройте страницу API Keys">
    Используйте вкладку **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>
      Разрешения соответствуют [предопределённым ролям](/docs/ru/products/cloud/reference/security/console-roles) ClickHouse Cloud. Роль developer имеет разрешения только для чтения для назначенных сервисов, а роль admin — полные разрешения на чтение и запись.
    </Note>

    <Tip>
      **Эндпоинты Query API**

      Чтобы использовать ключи API с [эндпоинтами Query API](/docs/ru/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**. Введите IP-адрес или диапазон CIDR, например `203.0.113.1` или `203.0.113.0/24`, и при необходимости добавьте дополнительные записи.

    Эндпоинты Query API учитывают списки разрешённых IP-адресов на уровне ключа API. Поскольку запросы проксируются из инфраструктуры ClickHouse, списки разрешённых IP-адресов на уровне сервиса не применяются. Подробности см. в разделе [IP Access Control](/docs/ru/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="Разрешённые IP-адреса, настроенные для ключа API" 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 использует [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) для проверки действительности ваших ключей API. Ниже приведён пример использования ключей API для отправки запросов в ClickHouse Cloud API с помощью `curl`:

    ```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, разрешения, status, дату истечения срока действия и создателя. На этом экране можно редактировать имя ключа, разрешения и срок действия. Здесь же ключи можно отключать или удалять.

    <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/ru/products/cloud/api-reference/organization/get-list-of-available-organizations).
Используйте свой ключ API и секрет API с базовым URL `https://api.clickhouse.cloud/v1`.