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

Example response

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

Changes

Changed in 3 of the 14 revisions of this API.35

Feb 2, 2026f0a3d26cc0c622See the full diff
- ●
  removed the optional property errors from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property errors from the response with the 403 status
  response-optional-property-removed
- ○
  removed the non-success response with the status 422
  response-non-success-status-removed
- ○
  added the optional property anyOf[subschema #1: ConnectionStatusSingleConnection]/invalid_properties to the response with the 200 status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 16, 2025557b7644b9432See the full diff
- ○
  added the optional property errors to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors to the response with the 403 status
  response-optional-property-added
Feb 27, 2025b0ed6c7dac4211See the full diff
- ●
  removed the optional property anyOf[subschema #1: ConnectionStatusSingleConnection]/invalid_properties from the response with the 200 status
  response-optional-property-removed
- ○
  added the non-success response with the status 422
  response-non-success-status-added
This revision also has 37 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history