Skip to main content
POST
/
pipelines
Create a pipeline
curl --request POST \
  --url https://api.goldsky.com/api/v1/pipelines/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "ethereum-blocks",
  "resource_size": "s",
  "use_dedicated_ip": false,
  "job": false,
  "description": "Streams Ethereum blocks",
  "definition": {
    "sources": {
      "my_source": {
        "dataset_name": "ethereum.raw_blocks",
        "start_at": "latest",
        "type": "dataset",
        "version": "1.0.0"
      }
    },
    "transforms": {
      "my_transform": {
        "from": "my_source",
        "primary_key": "id",
        "type": "handler",
        "url": "https://handler.com"
      }
    },
    "sinks": {
      "my_sink": {
        "from": "my_transform",
        "type": "blackhole"
      }
    }
  }
}
'
{
  "name": "<string>",
  "type": "<string>",
  "status": "RUNNING",
  "definition": {
    "sources": {},
    "transforms": {},
    "sinks": {},
    "description": "<string>",
    "resource_size": "<string>",
    "use_dedicated_ip": true,
    "job": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "resource_size": "<string>",
  "version": 123,
  "project_id": "<string>"
}

Authorizations

Authorization
string
header
required

API token generated from the Goldsky Dashboard. Pass as: Authorization: Bearer

Body

application/json
name
string
required

Pipeline name. Only lowercase letters, numbers, and hyphens are allowed.

Required string length: 1 - 50
Pattern: ^[a-z0-9-]{1,50}$
definition
object
required
resource_size
string
description
string
use_dedicated_ip
boolean

Response

200 - application/json

Default Response

name
string
required
type
string
required
status
required
Available options:
RUNNING
definition
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
resource_size
string
version
number
project_id
string