Gestion des clés API

Vous pouvez utiliser l’onglet API Keys dans le menu de gauche pour créer et gérer vos clés API.

La page API Keys affiche d’abord une invite vous proposant de créer votre première clé API, comme illustré ci-dessous. Une fois cette première clé créée, vous pouvez en créer de nouvelles à l’aide du bouton New API Key qui apparaît dans l’angle supérieur droit.

Indiquez le nom de la clé, ses permissions et sa date d’expiration.

Pour restreindre les clients autorisés à utiliser la clé API, dans la section Allow access to this API Key, sélectionnez Specific locations. Saisissez une adresse IP ou une plage CIDR, telle que 203.0.113.1 ou 203.0.113.0/24, puis ajoutez autant d’entrées que nécessaire.

Les Query API endpoints respectent les listes d’autorisation d’IP définies au niveau des clés API. Étant donné que les requêtes sont relayées depuis l’infrastructure de ClickHouse, les listes d’autorisation d’IP au niveau du service ne s’appliquent pas. Consultez IP Access Control pour plus de détails.

Cliquez sur Generate API Key lorsque vous avez terminé de configurer la clé.

L’écran suivant affiche votre Key ID et votre Key secret. Copiez ces valeurs et conservez-les en lieu sûr, par exemple dans un coffre-fort. Elles ne seront plus affichées après que vous aurez quitté cet écran.

La ClickHouse Cloud API utilise l’authentification HTTP Basic pour vérifier la validité de vos clés API. Voici un exemple montrant comment utiliser vos clés API pour envoyer des requêtes à la ClickHouse Cloud API avec curl :

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

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

En revenant sur la page API Keys, vous verrez le nom de la clé, les quatre derniers caractères du Key ID, les permissions, le statut, la date d’expiration et le créateur. Depuis cet écran, vous pouvez modifier le nom de la clé, les permissions et la date d’expiration. Vous pouvez également y désactiver ou supprimer des clés.