Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
definition
object
required
​
name
string

Pipeline name. Only lowercase letters, numbers, and hyphens are allowed. May be provided here or inside definition.name.

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

Response

200 - application/json

Default Response

​
name
string
required
​
type
string
required
​
status
required

Current pipeline status. SUCCEEDED is terminal and only reached by job-mode pipelines (definition.job: true), which run to completion instead of staying resident — poll for it to detect that a backfill finished. UNKNOWN means the upstream status could not be mapped.

Available options:
RUNNING
​
definition
object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
resource_size
string
​
project_id
string