Start Pipeline

POST/v0/pipelines/{pipeline_name}/start

Authentication

JSON web token (JWT) or API key (http bearer)

Parameters

pipeline_name (path, string, required)

initial (query, string)

bootstrap_policy (query, string)

dismiss_error (query, boolean)

Start the pipeline asynchronously by updating the desired status.

The endpoint returns immediately after setting the desired status. The procedure to get to the desired status is performed asynchronously. Progress should be monitored by polling the pipeline GET endpoints.

Note the following:

A stopped pipeline can be started through calling /start?initial=running, /start?initial=paused, or /start?initial=standby.
If the pipeline is already (being) started (provisioned), it will still return success
It is not possible to call /start when the pipeline has already had /stop called and is in the process of suspending or stopping.

Authentication

Scheme	Type	Details
`JSON web token (JWT) or API key`	Bearer token	Authorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

Name	Type	Required	Description
`pipeline_name`	string	Yes	Unique pipeline name

Query parameters

Name	Type	Required	Description
`initial`	string	No	The `initial` parameter determines whether to after provisioning the pipeline make it become `standby`, `paused` or `running` (only valid values).
`bootstrap_policy`	BootstrapPolicy	No
`dismiss_error`	boolean	No

Response

Action is accepted and is being performed

curl -X POST '/v0/pipelines/{pipeline_name}/start?initial=%3Cinitial%3E&bootstrap_policy=%3Cbootstrap_policy%3E&dismiss_error=%3Cdismiss_error%3E' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Action could not be performed


{
  "message": "Deployment resources status (current: 'Stopping', desired: 'Stopped') cannot have desired changed to 'Provisioned'. Cannot restart the pipeline while it is stopping. Wait for it to stop before starting a new instance of the pipeline.",
  "error_code": "IllegalPipelineAction",
  "details": {
    "status": "Stopping",
    "current_desired_status": "Stopped",
    "new_desired_status": "Provisioned",
    "hint": "Cannot restart the pipeline while it is stopping. Wait for it to stop before starting a new instance of the pipeline."
  }
}