v14

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-016793230.7 KB
secure
connection

Sources Dry Run

Tests the connection to the source database.

Args: body: The connection details according to the OpenAPI Scheme.

Returns: Union[ConnectionStatusSingleConnection, Error]: The connection status.

post/api/v1/pipelines/sources/dry-run

Request body

object required

Example request

{
  "type": "cdc",
  "logging": {
    "level": "debug"
  },
  "connection": {
    "type": "mysql",
    "host": "${HOST_IP}",
    "port": 3306,
    "database": "new_schema",
    "user": "${secret:local-vault:credentials:user}",
    "password": "${secret:local-vault:credentials:password}"
  }
}

Response

Successful Response

OR

Example response

{
  "invalid_properties": {
    "database.hostname": "Unable to connect: Communications link failure"
  }
}