Sign in

v14

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

Single Target Dry Run

Tests connection by name to the target database.

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

Request body

object required

Example request

{
  "type": "redis",
  "host": "${HOST_IP}",
  "port": 12002
}

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"
  }
}