Skip to main content
POST
/
api
/
v1
/
tap
/
run
Run a tap
curl --request POST \
  --url http://localhost:8080/api/v1/tap/run \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "pushToPipeline": "true"
}
'
{
  "tap": "<string>",
  "description": "<string>",
  "status": "success",
  "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
pushToPipeline
enum<string>

Whether to feed records into the configured target pipeline

Available options:
true,
false

Response

200 - application/json

Run result

tap
string
description
string
status
enum<string>
Available options:
success,
failure
records
object[]
recordCount
integer
dataType
string
columns
string[]
logs
string
error
string
aiExplanation
string