Create Pipeline

POST

/api/v1/pipelines/

curl --request POST \
  --url https://example.com/api/v1/pipelines/ \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "name": "example", "storage": "example", "configuration": { "additionalProperty": "example" }, "clusters": [ { "label": "example", "node_type_id": "example", "driver_node_type_id": "example", "num_workers": 1, "autoscale": { "additionalProperty": 1 }, "custom_tags": { "additionalProperty": "example" }, "spark_conf": { "additionalProperty": "example" }, "spark_env_vars": { "additionalProperty": "example" }, "enable_local_disk_encryption": true, "instance_pool_id": "example" } ], "libraries": [ { "notebook": { "additionalProperty": "example" }, "file": { "additionalProperty": "example" }, "jar": "example", "maven": { "additionalProperty": "example" }, "pypi": { "additionalProperty": "example" }, "whl": "example" } ], "target": "example", "schema": "example", "continuous": true, "development": false, "photon": false, "channel": "CURRENT", "edition": "ADVANCED", "catalog": "example", "notifications": [ {} ], "serverless": true, "root_path": "example" }'

Create a new pipeline with namespaced Nexa tags (prevents config collision).

Parameters

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

PipelineSpec

DLT Pipeline specification.

object

id

Any of:

string

string

null

null

name

required

Name

Pipeline name

string

storage

Any of:

string

string

null

null

configuration

Any of:

object

object

key

additional properties

string

null

null

clusters

Any of:

Array<object>

Array<object>

PipelineCluster

DLT Pipeline cluster configuration.

All fields are optional to allow flexible cluster configuration. Databricks will use defaults for unspecified values.

object

label

Any of:

string

string

null

null

node_type_id

Any of:

string

string

null

null

driver_node_type_id

Any of:

string

string

null

null

num_workers

Any of:

integer

integer

null

null

autoscale

Any of:

object

object

key

additional properties

integer

null

null

custom_tags

Any of:

object

object

key

additional properties

string

null

null

spark_conf

Any of:

object

object

key

additional properties

string

null

null

spark_env_vars

Any of:

object

object

key

additional properties

string

null

null

enable_local_disk_encryption

Any of:

boolean

boolean

null

null

instance_pool_id

Any of:

string

string

null

null

null

null

libraries

required

Libraries

Pipeline libraries

Array<object>

PipelineLibrary

DLT Pipeline library configuration.

All fields are optional as only one library type should be specified per entry.

object

notebook

Any of:

object

object

key

additional properties

string

null

null

file

Any of:

object

object

key

additional properties

string

null

null

jar

Any of:

string

string

null

null

maven

Any of:

object

object

key

additional properties

string

null

null

pypi

Any of:

object

object

key

additional properties

string

null

null

whl

Any of:

string

string

null

null

target

Any of:

string

string

null

null

schema

Any of:

string

string

null

null

continuous

Any of:

boolean

boolean

null

null

development

Any of:

boolean

boolean

null

null

photon

Any of:

boolean

boolean

null

null

channel

Any of:

string

string

null

null

edition

Any of:

string

string

null

null

catalog

Any of:

string

string

null

null

notifications

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

serverless

Any of:

boolean

boolean

null

null

root_path

Any of:

string

string

null

null

Responses

201

Successful Response

Media typeapplication/json

PipelineResponse

Response model for a single pipeline - aligned with Databricks API.

object

pipeline_id

required

Pipeline Id

Unique identifier for the pipeline

string

name

required

Name

Name of the pipeline

string

state

Any of:

string

string

null

null

cluster_id

Any of:

string

string

null

null

creator_user_name

Any of:

string

string

null

null

nexa_managed

Nexa Managed

boolean

health

Any of:

PipelineHealthItem

PipelineHealthItem

Lightweight health info for list responses.

object

status

Status

string

default: UNKNOWN

last_update_state

Any of:

string

string

null

null

last_update_time

Any of:

Last Update Time

Last Update Time

null

null

last_success_time

Any of:

Last Success Time

Last Success Time

null

null

last_failure_time

Any of:

Last Failure Time

Last Failure Time

null

null

consecutive_failures

Consecutive Failures

integer

0

is_stale

Is Stale

boolean

longest_running_seconds

Any of:

integer

integer

null

null

last_error_message

Any of:

string

string

null

null

null

null

spec

Any of:

object

object

key

additional properties

any

null

null

latest_updates

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

run_as_user_name

Any of:

string

string

null

null

key

additional properties

any

Example

{
  "nexa_managed": false,
  "health": {
    "status": "UNKNOWN",
    "consecutive_failures": 0,
    "is_stale": false
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}