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

# Créer une clé

> Crée une nouvelle clé API.



## OpenAPI

````yaml /fr/_specs/cloud-openapi.json post /v1/organizations/{organizationId}/keys
openapi: 3.0.1
info:
  contact:
    email: support@clickhouse.com
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-299828
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: User management
  - name: Billing
  - name: Service
  - name: Backup
  - name: OpenAPI
  - name: Prometheus
  - name: ClickPipes
paths:
  /v1/organizations/{organizationId}/keys:
    post:
      tags:
        - OpenAPI
      summary: Créer une clé
      description: Crée une nouvelle clé API.
      parameters:
        - description: ID de l’organisation propriétaire de la clé.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiKeyPostRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: ID unique attribué à chaque requête. UUIDv4
                    format: uuid
                    type: string
                  result:
                    $ref: '#/components/schemas/ApiKeyPostResponse'
                  status:
                    description: Code d’état HTTP.
                    example: 200
                    type: number
                type: object
          description: Réponse réussie
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: Description détaillée de l’erreur.
                    type: string
                  status:
                    description: Code d’état HTTP.
                    example: 400
                    type: number
                type: object
          description: >-
            Le server ne peut pas ou ne veut pas traiter la requête en raison
            d’un élément considéré comme une erreur du client.
components:
  schemas:
    ApiKeyPostRequest:
      properties:
        expireAt:
          description: >-
            Horodatage d'expiration de la clé. S'il est absent, `null` ou vide,
            la clé n'expire jamais. ISO-8601.
          format: date-time
          nullable: true
          type: string
        hashData:
          $ref: '#/components/schemas/ApiKeyHashData'
        ipAccessList:
          description: >-
            Liste des adresses IP autorisées à accéder à l'API à l'aide de cette
            clé
          items:
            $ref: '#/components/schemas/IpAccessListEntry'
          type: array
        name:
          description: Nom de la clé.
          type: string
        roles:
          description: "Liste des rôles attribués à la clé. Contient au moins 1\_élément."
          items:
            enum:
              - admin
              - developer
              - query_endpoints
            type: string
          type: array
        state:
          description: "État initial de la clé\_: 'enabled', 'disabled'. S'il n'est pas fourni, la nouvelle clé sera 'enabled'."
          enum:
            - enabled
            - disabled
          type: string
    ApiKeyPostResponse:
      properties:
        key:
          $ref: '#/components/schemas/ApiKey'
        keyId:
          description: >-
            ID de clé généré. Fourni uniquement s'il n'y avait pas de 'hashData'
            dans la requête.
          type: string
        keySecret:
          description: >-
            Secret de clé généré. Fourni uniquement s'il n'y avait pas de
            'hashData' dans la requête.
          type: string
    ApiKeyHashData:
      properties:
        keyIdHash:
          description: 'Hachage de l’ID de la clé. '
          type: string
        keyIdSuffix:
          description: "4\_derniers chiffres de l’ID de la clé. Algorithme\_: echo -n \"yourpassword\" | sha256sum | tr -d '-' | xxd -r -p | base64"
          type: string
        keySecretHash:
          description: "Hachage du secret de la clé. Algorithme\_: echo -n \"yourpassword\" | sha256sum | tr -d '-' | xxd -r -p | base64"
          type: string
    IpAccessListEntry:
      properties:
        description:
          description: >-
            Description facultative de l’adresse IPv4 ou du CIDR IPv4 à partir
            desquels autoriser l’accès
          type: string
        source:
          description: IP ou CIDR
          type: string
    ApiKey:
      properties:
        createdAt:
          description: Horodatage de création de la clé. ISO-8601.
          format: date-time
          type: string
        expireAt:
          description: >-
            Horodatage d’expiration de la clé. S’il est absent, `null` ou vide,
            la clé n’expire jamais. ISO-8601.
          format: date-time
          nullable: true
          type: string
        id:
          description: ID de clé API unique.
          format: uuid
          type: string
        ipAccessList:
          description: Liste des adresses IP autorisées à accéder à l’API avec cette clé
          items:
            $ref: '#/components/schemas/IpAccessListEntry'
          type: array
        keySuffix:
          description: "4\_derniers caractères de la clé."
          type: string
        name:
          description: Nom de la clé
          type: string
        roles:
          description: Liste des rôles attribués à la clé. Contient au moins 1 élément.
          items:
            enum:
              - admin
              - developer
              - query_endpoints
            type: string
          type: array
        state:
          description: "État de la clé\_: 'enabled', 'disabled'."
          enum:
            - enabled
            - disabled
          type: string
        usedAt:
          description: >-
            Horodatage de la dernière utilisation de la clé. S’il est absent, la
            clé n’a jamais été utilisée. ISO-8601.
          format: date-time
          type: string
  securitySchemes:
    basicAuth:
      description: "Utilisez l’ID de la clé et le secret de la clé obtenus dans la ClickHouse Cloud console\_: https://clickhouse.com/docs/cloud/manage/openapi"
      scheme: basic
      type: http

````