> ## Documentation Index
> Fetch the complete documentation index at: https://docs.e6data.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Test a connection profile

> Tests connectivity with the provided configuration. The request body is the same as for creating a connection profile.



## OpenAPI

````yaml /openapi/ingest.yaml post /connection_profiles/test
openapi: 3.1.0
info:
  title: Ingest Engine HTTP API
  version: '1.0'
  description: >
    The Ingest Engine exposes an HTTP API for managing pipelines, connections,
    and jobs programmatically.


    All responses are JSON. Errors return an object with an `error` message.


    List endpoints use cursor-based pagination. Responses contain a `data` array
    and a `has_more` flag.

    Pass `?starting_after=<last_id>&limit=10` to get the next page.
servers:
  - url: http://{controllerHost}:8000/api/v1
    description: The Ingest Engine controller.
    variables:
      controllerHost:
        default: localhost
        description: Host name of the Ingest Engine controller.
security:
  - bearerAuth: []
tags:
  - name: Pipelines
    description: Create, update, restart, and delete pipelines.
  - name: Jobs
    description: >-
      A job is a single execution of a pipeline. Each time a pipeline starts or
      restarts, a new job is created.
  - name: Connection profiles
    description: >-
      A connection profile stores reusable connection credentials, such as Kafka
      bootstrap servers and authentication.
  - name: Connection tables
    description: >-
      A connection table defines a specific source or sink, binding a connector,
      connection profile, schema, and table-specific configuration together.
  - name: Connectors
    description: Metadata about available connectors.
  - name: Health
    description: Health checks.
paths:
  /connection_profiles/test:
    post:
      tags:
        - Connection profiles
      summary: Test a connection profile
      description: >-
        Tests connectivity with the provided configuration. The request body is
        the same as for creating a connection profile.
      operationId: testConnectionProfile
      requestBody:
        $ref: '#/components/requestBodies/ConnectionProfile'
      responses:
        '200':
          description: Result of the connectivity test.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  done:
                    type: boolean
              example:
                message: Successfully connected
                done: true
        default:
          $ref: '#/components/responses/Error'
components:
  requestBodies:
    ConnectionProfile:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
                description: Profile name.
              connector:
                type: string
                description: Connector type, for example `kafka`.
              config:
                type: object
                description: >-
                  Connector-specific connection configuration, such as bootstrap
                  servers and authentication.
          example:
            name: production-kafka
            connector: kafka
            config:
              bootstrap_servers: kafka-1:9092,kafka-2:9092
              authentication:
                type: sasl_plain
                username: user
                password: pass
  responses:
    Error:
      description: Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Descriptive error message.
      example:
        error: descriptive error message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send the API token as `Authorization: Bearer <token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.