Skip to main content
POST
/
pipelines
/
validate
Validate a pipeline definition
curl --request POST \
  --url https://api.goldsky.com/api/v1/pipelines/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": "ethereum-blocks",
    "resource_size": "s",
    "use_dedicated_ip": false,
    "job": false,
    "description": "Streams Ethereum blocks"
  }
}
'
{
  "valid": true,
  "errors": [
    {
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "warnings": [
    {
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
definition
object
required

Response

200 - application/json

Default Response

valid
boolean
required
errors
object[]
required
warnings
object[]
required