> ## 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.

# Gestion des clés API

> ClickHouse Cloud fournit une API basée sur OpenAPI qui vous permet de gérer votre compte et certains aspects de vos services par programmation.

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 fournit une API basée sur OpenAPI qui vous permet de gérer par programmation votre compte et certains aspects de vos services.

<Note>
  Ce document présente la ClickHouse Cloud API. Pour les endpoints de l’API de base de données, consultez [Cloud Endpoints API](/docs/fr/products/cloud/guides/sql-console/query-endpoints)
</Note>

<Steps>
  <Step title="Ouvrez la page API Keys">
    Vous pouvez utiliser l’onglet **API Keys** dans le menu de gauche pour créer et gérer vos clés 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="Onglet API Keys" border width="433" height="472" data-path="images/cloud/manage/openapi1.webp" />
  </Step>

  <Step title="Commencez à créer une clé 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.

    <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="Page API Keys" border width="1036" height="466" data-path="images/cloud/manage/openapi2.webp" />
  </Step>

  <Step title="Configurez la clé API">
    Indiquez le nom de la clé, ses permissions et sa date d’expiration.

    <Note>
      Les permissions correspondent aux [rôles prédéfinis](/docs/fr/products/cloud/reference/security/console-roles) de ClickHouse Cloud. Le rôle developer dispose de permissions en lecture seule sur les services attribués, tandis que le rôle admin dispose de permissions complètes en lecture et en écriture.
    </Note>

    <Tip>
      **Query API Endpoints**

      Pour utiliser des clés API avec les [Query API Endpoints](/docs/fr/products/cloud/guides/sql-console/query-endpoints), définissez Organization Role sur `Member` (minimum) et accordez au Service Role l’accès à `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="Formulaire de création de clé API" border width="661" height="410" data-path="images/cloud/manage/openapi3.png" />
  </Step>

  <Step title="Ajoutez des adresses IP autorisées">
    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](/docs/fr/cloud/features/query-api-endpoints#ip-access-control) pour plus de détails.

    <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="Adresses IP autorisées configurées pour une clé API" border width="1336" height="1740" data-path="images/cloud/guides/query-endpoints/specific-locations.webp" />

    Cliquez sur **Generate API Key** lorsque vous avez terminé de configurer la clé.
  </Step>

  <Step title="Enregistrez les identifiants de la clé API">
    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.

    <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="Détails de la clé API" border width="653" height="271" data-path="images/cloud/manage/openapi4.webp" />
  </Step>

  <Step title="Authentifiez les requêtes API">
    La ClickHouse Cloud API utilise l’[authentification HTTP Basic](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) 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` :

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

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

  <Step title="Gérez les clés API existantes">
    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.

    <Note>
      La suppression d’une clé API est définitive. Tous les services qui utilisent cette clé perdront immédiatement l’accès à 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="Page de gestion des API Keys" border width="1092" height="335" data-path="images/cloud/manage/openapi5.webp" />
  </Step>
</Steps>

<div id="endpoints">
  ## Endpoints
</div>

Pour en savoir plus sur les endpoints, consultez la [Référence API](/docs/fr/products/cloud/api-reference/organization/get-list-of-available-organizations).
Utilisez votre clé API et votre secret API avec l’URL de base `https://api.clickhouse.cloud/v1`.