Deploy this pipeline into production

post

https://{domain}/dsapi/pipelines/{id}/deploy/

Deploy this pipeline: merge the draft, cut the release, build the image and create the schedule — the whole sequence, owned here. Returns 202 with a deployment to poll (an image build outlasts the gateway timeout), or 422 with the plan when it is refused before any write.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The UUID of the pipeline

Body Params

source

string

ref to deploy — feature// (merges then cuts), the default branch (cuts only), or release/ (as-is). Defaults to the default branch.

releaseName

string

release to create — required unless source is already a release

packaging

string

how the pipeline is packaged — 'image' (default: build a frozen artifact) or 'release' (run straight from the release branch). Only those two values are accepted.

twins

object

templated pipelines only: list of hardware ids, or of {twin, target} where target is "cloud" (default) or "edge"

interval

integer

schedule interval in ms (required)

delay

integer

schedule delay in ms

properties

object

values for the pipeline variables

plot

boolean

produce the pipeline's PLOT steps on each triggered run (default false). Needs every twin on the cloud target — an edge device has nowhere to publish a plot.

train

boolean

retrain the pipeline's models on each triggered run (default false). Needs every twin on the cloud target AND packaging 'release': a model frozen in an image cannot be replaced, so a retrained one would be silently discarded.

write

boolean

run the pipeline's WRITE steps (default TRUE — this is what a scheduled pipeline is normally for).

version

string

environment / python version, e.g. "3.12"

triggerId

string

update this existing trigger instead of creating one

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Deployment accepted

422Refused — the plan says why