REredis
secure
connection

Sources Dry Run

Changed on

Tests the connection to the source database.

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

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/pipelines/sources/dry-run
  • Auth
    HTTP bearer

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

connectedboolean required
errorstring required
invalid_propertiesobject nullable

Map of invalid property names to their specific error messages

Example response

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

Changes

  • 38675c1371b2Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body anyOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • f0a3d26cc0c6Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property / to the response with the status