API Reference
Log In
API Reference

create one or multiple dataPipelines

Create one or multiple dataPipelines

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
string
required
string
enum
required
Allowed:
string
enum
required
Allowed:
string
enum
required
Allowed:
boolean
required
Defaults to false

It will be added to the catalogue of re-usable data pipelines

boolean
required
Defaults to true

Whether the data pipeline is enabled or disabled

boolean
required
Defaults to false

Whether the data pipeline is read-only and cannot be edited

boolean
required
Defaults to false

Whether this is a standard prebuilt pipeline that should suppress mapping warnings for empty values

boolean
Defaults to false

Whether this pipeline is a draft created during the test-before-save flow

string | null

Object storage key for the sample file used for mapping/tests

date-time | null

Timestamp of the last uploaded sample file

string | null

Raw JSON text used for mapping/tests (alternative to file upload)

string | null

Lodash-style dot-notation path to the records array within the JSON payload. When set, the parser drills into this path before extracting rows. Example: "data.all" or "0.here.0.one". When empty, the root is used.

destination

Where mapped rows are delivered. When omitted, rows are written to the database (legacy behavior). Discriminated on type; the optional config block shape depends on type. Only "database" is implemented today; the rest are scaffolded. File destinations (csv, json) write to object storage and record the key on the event (outputFileKey) for download.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json