> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Управление ключами API

> ClickHouse Cloud предоставляет API на базе OpenAPI, который позволяет программно управлять вашей учетной записью и некоторыми аспектами ваших сервисов.

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

ClickHouse Cloud предоставляет API на базе OpenAPI, который позволяет программно управлять вашей учетной записью и некоторыми аспектами ваших сервисов.

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

1. Для создания ключей API и управления ими можно использовать вкладку **ключей API** в левом меню.

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi1.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=838eafd0a0de6185ae18627a1055e4ee" size="sm" alt="Вкладка ключей API" border width="433" height="472" data-path="images/cloud/manage/openapi1.png" />

2. На странице **ключей API** сначала отображается предложение создать первый ключ API, как показано ниже. После создания первого ключа вы сможете создавать новые ключи с помощью кнопки `New API Key`, которая появляется в правом верхнем углу.

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi2.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=593722f25f605525ce48422f11f9460d" size="md" alt="Страница ключей API" border width="1036" height="466" data-path="images/cloud/manage/openapi2.png" />

3. Чтобы создать ключ API, укажите имя ключа, разрешения для него и срок действия, затем нажмите `Generate API Key`.

<br />

<Note>
  Разрешения соответствуют [предопределенным ролям](/ru/products/cloud/reference/security/console-roles) ClickHouse Cloud. Роль developer имеет разрешения только для чтения для назначенных сервисов, а роль admin — полные разрешения на чтение и запись.
</Note>

<Tip>
  **конечные точки Query API**

  Чтобы использовать ключи API с [конечными точками Query API](/ru/products/cloud/guides/sql-console/query-endpoints), задайте для Organization Role значение `Member` (как минимум) и предоставьте Service Role доступ к `Query Endpoints`.
</Tip>

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi3.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=53f74d4f5f4d99eecb4e4e61842b0322" size="md" alt="Форма создания ключа API" border width="661" height="410" data-path="images/cloud/manage/openapi3.png" />

4. На следующем экране будут показаны идентификатор ключа и секрет ключа. Скопируйте эти значения и сохраните их в безопасном месте, например в хранилище секретов. После ухода с этого экрана они больше не будут отображаться.

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi4.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=008971d5bc5321463b55f2a420994ba4" size="md" alt="Сведения о ключе API" border width="653" height="271" data-path="images/cloud/manage/openapi4.png" />

5. 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
```

6. Вернувшись на страницу **ключей API**, вы увидите имя ключа, последние четыре символа идентификатора ключа, разрешения, статус, дату истечения срока действия и создателя. На этом экране можно изменить имя ключа, разрешения и дату истечения срока действия. Здесь же ключи можно отключить или удалить.

<br />

<Note>
  Удаление ключа API — необратимое действие. Все сервисы, использующие этот ключ, немедленно потеряют доступ к ClickHouse Cloud.
</Note>

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi5.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=3aa72a37b3a4f5d85c85372d50c71291" size="md" alt="Страница управления ключами API" border width="1092" height="335" data-path="images/cloud/manage/openapi5.png" />

<div id="endpoints">
  ## Конечные точки
</div>

Сведения о конечных точках см. в [справочнике API](/ru/api-reference/organization/get-list-of-available-organizations).
Используйте свой ключ API и секрет API с базовым URL `https://api.clickhouse.cloud/v1`.