Skip to main content
POST
/
api
/
v1
/
tap
/
test
Test a tap
curl --request POST \
  --url http://localhost:8080/api/v1/tap/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "targetPipeline": "<string>",
  "scriptPath": "<string>",
  "packages": [
    "<string>"
  ],
  "secretName": "<string>",
  "cronExpression": "<string>",
  "enabled": true,
  "lastRunStatus": "success",
  "lastRunTime": "<string>",
  "lastRunRecordCount": 123,
  "lastRunError": "<string>",
  "lastRunDataType": "csv",
  "lastRunColumns": [
    "<string>"
  ],
  "lastTestRunStatus": "<string>",
  "lastTestRunTime": "<string>",
  "lastTestRunRecordCount": 123,
  "lastTestRunError": "<string>",
  "lastTestRunDataType": "<string>",
  "lastTestRunColumns": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}
'
{
  "records": [
    {}
  ],
  "recordCount": 123,
  "dataType": "<string>",
  "columns": [
    "<string>"
  ],
  "logs": "<string>",
  "error": "<string>",
  "aiExplanation": "<string>"
}

Authorizations

x-api-key
string
header
required

Optional API key for authentication (enabled via application.yaml)

Body

application/json
name
string
required

Unique tap identifier

description
string
required

Plain-English instruction used to generate the script

targetPipeline
string
required

Pipeline this tap feeds into (may be empty for unattached taps)

scriptPath
string

MinIO path of the generated Python script

packages
string[]

Extra pip packages required by the script

secretName
string

Name of the tap secret (Vault) injected as env vars at runtime

cronExpression
string

Quartz CRON expression for scheduled runs (omit for manual-only)

enabled
boolean
default:true
lastRunStatus
enum<string>
Available options:
success,
failure
lastRunTime
string
lastRunRecordCount
integer
lastRunError
string
lastRunDataType
enum<string>
Available options:
csv,
json,
xml,
text
lastRunColumns
string[]
lastTestRunStatus
string
lastTestRunTime
string
lastTestRunRecordCount
integer
lastTestRunError
string
lastTestRunDataType
string
lastTestRunColumns
string[]
createdAt
string
updatedAt
string

Response

200 - application/json

Test results

records
object[]
recordCount
integer
dataType
string
columns
string[]
logs
string
error
string
aiExplanation
string