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

Используйте вкладку API Keys в левом меню, чтобы создавать ключи API и управлять ими.

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

Укажите имя ключа, разрешения для него и срок действия.

Чтобы ограничить круг клиентов, которые могут использовать ключ 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.

Закончив настройку ключа, нажмите Generate API Key.

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

ClickHouse Cloud API использует HTTP Basic Authentication для проверки действительности ваших ключей API. Ниже приведён пример использования ключей API для отправки запросов в ClickHouse Cloud API с помощью curl:

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

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