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

# Obtenir le ClickPipe

> **Cet endpoint est en bêta.** Le contrat d’API est stable et aucune breaking change n’est attendue à l’avenir. <br /><br /> Renvoie le ClickPipe spécifié.



## OpenAPI

````yaml /fr/_specs/cloud-openapi.json get /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}
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}/services/{serviceId}/clickpipes/{clickPipeId}:
    get:
      tags:
        - ClickPipes
      summary: Obtenir le ClickPipe
      description: >-
        **Cet endpoint est en bêta.** Le contrat d’API est stable et aucune
        breaking change n’est attendue à l’avenir. <br /><br /> Renvoie le
        ClickPipe spécifié.
      parameters:
        - description: ID de l’organisation propriétaire du service.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
        - description: ID du service propriétaire du ClickPipe.
          in: path
          name: serviceId
          required: true
          schema:
            format: uuid
            type: string
        - description: ID du ClickPipe demandé.
          in: path
          name: clickPipeId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: ID unique attribué à chaque requête. UUIDv4
                    format: uuid
                    type: string
                  result:
                    $ref: '#/components/schemas/ClickPipe'
                  status:
                    description: Code de statut 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 de statut HTTP.
                    example: 400
                    type: number
                type: object
          description: >-
            Le serveur 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:
    ClickPipe:
      properties:
        createdAt:
          description: Date de création du ClickPipe.
          type: string
        destination:
          $ref: '#/components/schemas/ClickPipeDestination'
        fieldMappings:
          description: >-
            Mappages de champs du ClickPipe. Notez que toutes les colonnes de
            destination doivent être incluses dans les mappages.
          items:
            $ref: '#/components/schemas/ClickPipeFieldMapping'
          type: array
        id:
          description: ID unique du ClickPipe.
          format: uuid
          type: string
        name:
          description: Nom du ClickPipe.
          type: string
        scaling:
          $ref: '#/components/schemas/ClickPipeScaling'
        serviceId:
          description: ID du service auquel ce ClickPipe appartient.
          format: uuid
          type: string
        settings:
          $ref: '#/components/schemas/ClickPipeSettings'
        source:
          $ref: '#/components/schemas/ClickPipeSource'
        state:
          description: État actuel du ClickPipe.
          type: string
        updatedAt:
          description: Date de la dernière mise à jour du ClickPipe.
          type: string
    ClickPipeDestination:
      properties:
        columns:
          description: >-
            Colonnes de la table de destination. Champ obligatoire pour tous les
            types de pipe, sauf Postgres.
          items:
            $ref: '#/components/schemas/ClickPipeDestinationColumn'
          type: array
        database:
          description: Base de données de destination.
          type: string
        managedTable:
          description: "La table est-elle gérée par ClickPipes\_? Champ obligatoire pour tous les types de pipe, sauf Postgres."
          type: boolean
        table:
          description: >-
            Table de destination. Champ obligatoire pour tous les types de pipe,
            sauf Postgres.
          type: string
        tableDefinition:
          $ref: '#/components/schemas/ClickPipeDestinationTableDefinition'
    ClickPipeFieldMapping:
      properties:
        destinationField:
          description: Nom du champ de destination.
          type: string
        sourceField:
          description: Nom du champ source.
          type: string
    ClickPipeScaling:
      properties:
        concurrency:
          deprecated: true
          description: >-
            Niveau de concurrence souhaité. Uniquement pour les pipes S3. S’il
            est défini sur 0, la concurrence est automatiquement mise à
            l’échelle en fonction de la mémoire du cluster.
          type: integer
        replicaCpuMillicores:
          description: >-
            CPU en millicœurs pour chaque réplique. Uniquement pour les pipes de
            streaming.
          maximum: 2000
          minimum: 125
          type: integer
        replicaMemoryGb:
          description: >-
            Mémoire en Go pour chaque réplique. Uniquement pour les pipes de
            streaming.
          maximum: 8
          minimum: 0.5
          type: number
        replicas:
          description: Nombre souhaité de répliques. Uniquement pour les pipes évolutifs.
          type: integer
    ClickPipeSettings:
      properties:
        clickhouse_max_download_threads:
          description: >-
            Nombre maximal de threads de téléchargement. Nombre maximal de
            threads de téléchargement concurrents
          example: 4
          maximum: 32
          minimum: 0
          nullable: true
          type: integer
        clickhouse_max_insert_threads:
          description: >-
            Nombre maximal de threads d’insert. Nombre maximal de threads
            d’insert concurrents
          example: 1
          maximum: 16
          minimum: 0
          nullable: true
          type: integer
        clickhouse_max_threads:
          description: >-
            Nombre maximal de threads. Nombre maximal de threads concurrents
            pour le traitement des fichiers
          example: 8
          maximum: 64
          minimum: 0
          nullable: true
          type: integer
        clickhouse_min_insert_block_size_bytes:
          description: >-
            Taille minimale du bloc d’insert en octets. Taille minimale du bloc
            de données pour l’insert (en octets)
          example: 1073741824
          maximum: 10737418240
          minimum: 0
          nullable: true
          type: integer
        clickhouse_parallel_distributed_insert_select:
          description: >-
            Parallel distributed insert select. Paramètre parallel distributed
            insert select
          example: 2
          maximum: 2
          minimum: 0
          nullable: true
          type: integer
        clickhouse_parallel_view_processing:
          description: >-
            traitement parallèle des vues. Indique s’il faut activer l’envoi
            concurrent vers les vues attachées plutôt qu’un envoi séquentiel
          example: false
          nullable: true
          type: boolean
        object_storage_concurrency:
          description: >-
            Concurrence du stockage d’objets. Nombre de threads concurrents de
            traitement des fichiers
          example: 1
          maximum: 35
          minimum: 1
          nullable: true
          type: integer
        object_storage_max_file_count:
          description: >-
            Nombre maximal de fichiers. Nombre maximal de fichiers à traiter
            dans un seul lot d’insert
          example: 100
          maximum: 10000
          minimum: 1
          nullable: true
          type: integer
        object_storage_max_insert_bytes:
          description: >-
            Nombre maximal d’octets par insert. Nombre d’octets à traiter dans
            un seul lot d’insert
          example: 10737418240
          maximum: 53687091200
          minimum: 10485760
          nullable: true
          type: integer
        object_storage_polling_interval_ms:
          description: >-
            Intervalle d’interrogation du stockage d’objets. Configure
            l’intervalle de rafraîchissement pour interroger l’ingestion
            continue à la recherche de nouvelles données dans le stockage
            d’objets
          example: 30000
          maximum: 3600000
          minimum: 100
          nullable: true
          type: integer
        object_storage_use_cluster_function:
          description: >-
            utiliser la fonction cluster. Indique s’il faut utiliser la fonction
            cluster de ClickHouse pour le traitement distribué
          example: true
          nullable: true
          type: boolean
        streaming_max_insert_wait_ms:
          description: >-
            Temps d’attente maximal avant insert en streaming. Configure le
            délai d’attente maximal avant l’insertion des données dans
            ClickHouse.
          example: 5000
          maximum: 60000
          minimum: 500
          nullable: true
          type: integer
    ClickPipeSource:
      properties:
        kafka:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKafkaSource'
        kinesis:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKinesisSource'
        objectStorage:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeObjectStorageSource'
        postgres:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipePostgresSource'
    ClickPipeDestinationColumn:
      properties:
        name:
          description: Nom de la colonne.
          type: string
        type:
          description: Type de la colonne.
          type: string
    ClickPipeDestinationTableDefinition:
      properties:
        engine:
          $ref: '#/components/schemas/ClickPipeDestinationTableEngine'
        partitionBy:
          description: Expression SQL de la clé de partition.
          type: string
        primaryKey:
          description: Expression SQL de la clé primaire.
          type: string
        sortingKey:
          description: Clé de tri de la table de destination. Liste de colonnes.
          items:
            type: string
          type: array
    ClickPipeKafkaSource:
      properties:
        authentication:
          description: "Méthode d'authentification de la source Kafka. Méthodes d'authentification prises en charge\_: kafka: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, msk: SCRAM-SHA-512, IAM_ROLE, IAM_USER, MUTUAL_TLS, confluent: PLAIN, MUTUAL_TLS, warpstream: PLAIN, azureeventhub: PLAIN, redpanda: SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, dokafka: SCRAM-SHA-256, MUTUAL_TLS"
          enum:
            - PLAIN
            - SCRAM-SHA-256
            - SCRAM-SHA-512
            - IAM_ROLE
            - IAM_USER
            - MUTUAL_TLS
          type: string
        brokers:
          description: Brokers de la source Kafka.
          type: string
        caCertificate:
          description: >-
            Certificats d'autorité de certification (CA) encodés au format PEM
            pour valider le certificat du broker.
          nullable: true
          type: string
        consumerGroup:
          description: "Groupe de consommateurs de la source Kafka. Si aucune valeur n'est fournie, «\_clickpipes-<<ID>>\_» sera utilisé."
          example: my-clickpipe-consumer-group
          nullable: true
          type: string
        format:
          description: Format de la source Kafka.
          enum:
            - JSONEachRow
            - Avro
            - AvroConfluent
          type: string
        iamRole:
          description: "Rôle IAM pour la source Kafka. À utiliser avec l'authentification par rôle IAM. Pour en savoir plus, consultez la documentation ClickPipes\_: https://clickhouse.com/docs/en/integrations/clickpipes/kafka#iam"
          example: arn:aws:iam::123456789012:role/MyRole
          nullable: true
          type: string
        offset:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKafkaOffset'
        reversePrivateEndpointIds:
          description: >-
            UUID de Reverse Private Endpoint utilisés pour établir une connexion
            privée sécurisée à la source Kafka.
          items:
            type: string
          type: array
        schemaRegistry:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/ClickPipeKafkaSchemaRegistry'
        topics:
          description: Topics de la source Kafka.
          type: string
        type:
          description: Type de la source Kafka.
          enum:
            - kafka
            - redpanda
            - msk
            - confluent
            - warpstream
            - azureeventhub
            - dokafka
          type: string
    ClickPipeKinesisSource:
      properties:
        authentication:
          description: Méthode d’authentification à utiliser avec le flux Kinesis.
          enum:
            - IAM_ROLE
            - IAM_USER
          type: string
        format:
          description: Format du flux Kinesis.
          enum:
            - JSONEachRow
            - Avro
            - AvroConfluent
          type: string
        iamRole:
          description: >-
            Rôle IAM à utiliser pour l’authentification. Obligatoire si IAM_ROLE
            est utilisé.
          example: arn:aws:iam::123456789012:role/MyRole
          nullable: true
          type: string
        iteratorType:
          description: >-
            Type d’itérateur à utiliser lors de la lecture du flux Kinesis. Si
            AT_TIMESTAMP est utilisé, le champ timestamp doit être renseigné.
          enum:
            - TRIM_HORIZON
            - LATEST
            - AT_TIMESTAMP
          type: string
        region:
          description: Région AWS du flux Kinesis.
          example: us-east-1
          type: string
        streamName:
          description: Nom du flux Kinesis.
          example: my-stream
          type: string
        timestamp:
          description: >-
            Timestamp Unix à partir duquel commencer la lecture du flux Kinesis.
            Obligatoire si iteratorType est AT_TIMESTAMP.
          example: 1615766400
          nullable: true
          type: integer
        useEnhancedFanOut:
          description: Utiliser l’Enhanced Fan-Out pour le flux Kinesis.
          nullable: true
          type: boolean
    ClickPipeObjectStorageSource:
      properties:
        authentication:
          description: >-
            Méthode d’authentification. CONNECTION_STRING est utilisé pour Azure
            Blob Storage. IAM_ROLE et IAM_USER sont utilisés pour AWS
            S3/GCS/DigitalOcean. Si elle n’est pas fournie, aucune
            authentification n’est utilisée.
          enum:
            - IAM_ROLE
            - IAM_USER
            - CONNECTION_STRING
          nullable: true
          type: string
        azureContainerName:
          description: >-
            Nom du conteneur pour Azure Blob Storage. Obligatoire lorsque type
            est azureblobstorage.
          example: mycontainer
          nullable: true
          type: string
        compression:
          description: Algorithme de compression utilisé pour les fichiers.
          enum:
            - gzip
            - gz
            - brotli
            - br
            - xz
            - LZMA
            - zstd
            - auto
          example: auto
          nullable: true
          type: string
        connectionString:
          description: >-
            Chaîne de connexion pour l’authentification Azure Blob Storage.
            Obligatoire lorsque authentication est CONNECTION_STRING.
          example: >-
            DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=mykey;EndpointSuffix=core.windows.net
          nullable: true
          type: string
        delimiter:
          description: Délimiteur utilisé dans les fichiers.
          example: ','
          nullable: true
          type: string
        format:
          description: Format des fichiers.
          enum:
            - JSONEachRow
            - JSONAsObject
            - CSV
            - CSVWithNames
            - Parquet
            - Avro
          type: string
        iamRole:
          description: "Rôle IAM à utiliser avec l’authentification par rôle IAM. Pour en savoir plus, consultez la documentation ClickPipes\_: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#authentication"
          example: arn:aws:iam::123456789012:role/MyRole
          nullable: true
          type: string
        isContinuous:
          description: >-
            Si défini sur true, le pipe lira en continu les nouveaux fichiers
            depuis la source. Si défini sur false, le pipe ne lira les fichiers
            qu’une seule fois. Les nouveaux fichiers doivent être téléversés
            dans l’ordre lexicographique.
          nullable: true
          type: boolean
        path:
          description: "Chemin du ou des fichiers dans le conteneur Azure. Utilisé pour les sources Azure Blob Storage. Vous pouvez spécifier plusieurs fichiers à l’aide de caractères génériques de type bash. Pour plus d’informations, consultez la documentation sur l’utilisation des caractères génériques dans les chemins\_: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations"
          example: data/logs/*.json
          nullable: true
          type: string
        queueUrl:
          description: >-
            URL de la file d’attente SQS pour l’ingestion continue basée sur des
            événements. Lorsqu’elle est fournie, les fichiers sont ingérés à
            partir des notifications d’événements S3 plutôt qu’en suivant
            l’ordre lexicographique. S’applique uniquement lorsque isContinuous
            vaut true et que l’authentification n’est pas publique.
          example: https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue
          nullable: true
          type: string
        type:
          description: Type de la source ObjectStorage.
          enum:
            - s3
            - gcs
            - dospaces
            - azureblobstorage
          type: string
        url:
          description: "Indiquez le chemin du ou des fichiers que vous souhaitez ingérer. Vous pouvez spécifier plusieurs fichiers à l’aide de caractères génériques de type bash. Pour plus d’informations, consultez la documentation sur l’utilisation des caractères génériques dans les chemins\_: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations"
          example: >-
            https://datasets-documentation.s3.eu-west-3.amazonaws.com/http/**.ndjson.gz
          type: string
    ClickPipePostgresSource:
      properties:
        database:
          description: Base de données de l’instance Postgres à laquelle se connecter.
          type: string
        host:
          description: Hôte de l’instance Postgres à laquelle se connecter.
          type: string
        port:
          description: Port de l’instance Postgres à laquelle se connecter.
          type: number
        settings:
          $ref: '#/components/schemas/ClickPipePostgresPipeSettings'
        tableMappings:
          description: Mappages de tables pour le pipe Postgres.
          items:
            $ref: '#/components/schemas/ClickPipePostgresPipeTableMapping'
          type: array
    ClickPipeDestinationTableEngine:
      properties:
        columnIds:
          description: Noms des colonnes à additionner pour le moteur SummingMergeTree.
          items:
            type: string
          type: array
        type:
          description: Type de moteur de la table de destination.
          enum:
            - MergeTree
            - ReplacingMergeTree
            - SummingMergeTree
            - 'Null'
          type: string
        versionColumnId:
          description: >-
            Nom de la colonne à utiliser comme version pour le moteur
            ReplacingMergeTree.
          nullable: true
          type: string
    ClickPipeKafkaOffset:
      properties:
        strategy:
          description: Stratégie d’offset.
          enum:
            - from_beginning
            - from_latest
            - from_timestamp
          type: string
        timestamp:
          description: >-
            Timestamp UTC à la minute près à partir duquel démarrer. Obligatoire
            pour la stratégie "from_timestamp".
          example: 2021-01-01T00:00
          nullable: true
          type: string
    ClickPipeKafkaSchemaRegistry:
      properties:
        authentication:
          description: Type d'authentification du registre de schémas.
          enum:
            - PLAIN
          type: string
        caCertificate:
          description: >-
            Certificats d'autorité de certification (CA) encodés au format PEM
            pour valider le certificat du registre de schémas.
          nullable: true
          type: string
        url:
          description: URL du schéma. HTTPS requis.
          example: https://psrc-aa00.us-east-2.aws.confluent.cloud/schemas/ids/100004
          type: string
    ClickPipePostgresPipeSettings:
      properties:
        allowNullableColumns:
          description: Autoriser les colonnes Nullable dans la table de destination.
          type: boolean
        enableFailoverSlots:
          description: >-
            Activer le basculement pour le slot de réplication créé. Nécessite
            qu’aucun slot de réplication ne soit défini.
          type: boolean
        initialLoadParallelism:
          description: >-
            Nombre de tables à synchroniser en parallèle pendant le chargement
            initial.
          type: number
        publicationName:
          description: Nom de la publication à utiliser pour la réplication.
          type: string
        pullBatchSize:
          description: Nombre de lignes à extraire dans chaque lot.
          type: number
        replicationMode:
          description: Mode de réplication à utiliser pour le pipe.
          enum:
            - cdc
            - snapshot
            - cdc_only
          type: string
        replicationSlotName:
          description: Nom du slot de réplication à utiliser pour la réplication.
          type: string
        snapshotNumRowsPerPartition:
          description: Nombre de lignes à inclure dans le snapshot par partition.
          type: number
        snapshotNumberOfParallelTables:
          description: Nombre de tables à snapshotter en parallèle.
          type: number
        syncIntervalSeconds:
          description: >-
            Intervalle, en secondes, de synchronisation des données depuis
            Postgres.
          type: number
    ClickPipePostgresPipeTableMapping:
      properties:
        excludedColumns:
          description: Colonnes à exclure de la table cible.
          items:
            type: string
          type: array
        sortingKeys:
          description: >-
            Liste ordonnée des colonnes à utiliser comme clé de tri pour la
            table cible.
          items:
            type: string
          type: array
        sourceSchemaName:
          description: Nom du schéma source.
          type: string
        sourceTable:
          description: Nom de la table source.
          type: string
        tableEngine:
          description: Moteur de table à utiliser pour la table cible.
          enum:
            - MergeTree
            - ReplacingMergeTree
            - 'Null'
          type: string
        targetTable:
          description: Nom de la table cible.
          type: string
        useCustomSortingKey:
          description: >-
            Indique s’il faut utiliser une clé de tri personnalisée pour la
            table cible.
          type: boolean
  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

````