Skip to main content
GET
Get a tap configuration

Authorizations

x-api-key
string
header
required

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

Query Parameters

name
string
required

Tap name

Response

Tap configuration

Response shape of GET /api/v1/tap?name=.... Extends TapConfig with the script content fetched from MinIO and a scriptMissing flag set when the tap has a scriptPath but the object is absent from storage (e.g. deleted during an interrupted edit or re-generation). Use this flag in UIs to distinguish "never generated" (script null, flag absent) from "object vanished" (script null, scriptMissing: true).

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 (built-in storage)

scriptStorage
enum<string>

Script storage backend. Absent or minio = built-in object storage; github = the tenant's configured code repository.

Available options:
minio,
github
scriptRepoPath
string

Repo-relative script path when scriptStorage is github

scriptCommitSha
string

Commit SHA the script is pinned to when scriptStorage is github; runs read exactly this commit

scriptKind
enum<string>

Tap implementation kind. Absent or python = a script the platform executes; http = a user-hosted endpoint speaking the tap HTTP contract (endpointUrl is authoritative; script/packages fields do not apply).

Available options:
python,
http
endpointUrl
string

For scriptKind http only — absolute http(s) URL Datris POSTs the run context to on each run

source
string

Declared source identity for lineage and provenance — a provider name or host (never credentials). Optional; when absent the platform derives it from the endpoint host (HTTP taps) or the host the script references most. On update, omitting the field keeps the stored value and an empty string clears it.

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). Six fields — seconds minutes hours day-of-month month day-of-week — plus an optional year, e.g. 0 0 * * * ? (hourly). A 5-field Unix cron such as */1 * * * * is rejected with 400; the error quotes the 6-field equivalent.

enabled
boolean
default:true
tapType
enum<string>
default:structured

structured (default) — the script returns records that flow into a structured pipeline destination. document — the script returns {uri, filename, content} dicts destined for a vector-store pipeline (unstructured source + qdrant/pgvector/weaviate/milvus/chroma destination). The server rejects a document tap pointed at an incompatible pipeline with HTTP 400. Document taps also use a per-URI ledger so each file is processed once across re-runs.

Available options:
structured,
document
lastRunStatus
enum<string>
Available options:
success,
failure
lastRunTime
string
lastRunRecordCount
integer
lastRunError
string
lastRunDataType
enum<string>
Available options:
csv,
json,
xml,
text,
document
lastRunColumns
string[]
lastTestRunStatus
string
lastTestRunTime
string
lastTestRunRecordCount
integer
lastTestRunError
string
lastTestRunDataType
string
lastTestRunScriptId
string
read-only

Server-stamped identity of the exact script (or endpoint) that last passed a mode=test run (gh:<sha>, http:<url>, or sha256 of the stored script). Compared against the saved script when a cronExpression is set. Ignored in request bodies; null on pre-existing taps.

lastTestRunColumns
string[]
dependsOn
string[] | null

Taps of the same catalog whose destination tables this tap reads, declared by the user. When set (even [], meaning "none") it replaces inferredDependsOn. Omitted on an update: the stored list is kept. Blank names are refused (400); repeated names are stored once. Each name must be another tap of the same catalog (400 otherwise) and the list may not close a dependency cycle (409 with cycle). Orders and explains the catalog's enable order only; never enforced on save, test, run or schedule.

inferredDependsOn
string[] | null
read-only

Server-stamped from the stored script: same-catalog taps whose pipelines' Postgres or Mongo tables the script reads through the query or metadata endpoints. Ignored in request bodies. [] when the script was analysed and reads no other tap; null when not analysed yet (no script, or a tap saved before dependency tracking: GET /api/v1/tap and the catalog enable order analyse such a tap once and store the result).

createdAt
string
updatedAt
string
script
string | null

Python script body fetched from MinIO. Null when the tap has no script yet or when the script object is missing.

scriptMissing
boolean

Present and true only when scriptPath is set but the storage read returned no object. Omitted otherwise.