Skip to main content
POST
Create a pipeline
Requires a ServiceKey. See Service Keys.
The request body mirrors the YAML pipeline configuration documented under Configuration, expressed as JSON. The same destination_type values, topic format, and transforms semantics apply.

Authorizations

Authorization
string
header
required

Pipeline REST endpoints require a ServiceKey. Regular GoldRush API keys are rejected with 403. See Service Keys.

Body

application/json

Body for creating a pipeline. Read-only fields (id, created_by, group, created_at, updated_at) are ignored if supplied.

name
string
required
project
string
required
topic
string
required
destination_type
enum<string>
required
Available options:
postgres,
clickhouse,
kafka,
object_storage,
sqs,
webhook
destination_config
object
required

Destination-specific connection details. The accepted keys depend on destination_type. Examples: Postgres uses url, user, password; webhook uses url. On read, secret fields are masked as ****** and must be re-supplied in full on a PUT.

execution_mode
enum<string>
required
Available options:
bounded,
unbounded
description
string
transforms
object
execution_start_from
string
execution_stop_from
string
abi_file
object
abi_contract_addresses
string[]
abi_unmatched
enum<string>
Available options:
,
skip,
raw
status
enum<string>

Set to paused to create the pipeline without starting it. Defaults to running.

Available options:
running,
paused

Response

Pipeline created.

data
object

A configured pipeline. Sensitive fields inside destination_config (such as passwords) are masked as ****** on read.

error
boolean
error_message
string | null
error_code
string | null