Activate Standby Pipeline

POST/v0/pipelines/{pipeline_name}/activate

Authentication

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

Parameters

pipeline_name (path, string, required)

initial (query, string)

Requests the pipeline to activate if it is currently in standby mode, which it will do asynchronously.

Progress should be monitored by polling the pipeline GET endpoints.

This endpoint is only applicable when the pipeline is configured to start from object store and started as standby.

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`	RuntimeDesiredStatus	No

Response

application/json

Pipeline activation initiated

object
Response to a checkpoint request.
- checkpoint_sequence_numberinteger (int64)required

curl -X POST '/v0/pipelines/{pipeline_name}/activate?initial=%3Cinitial%3E' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Pipeline with that name does not exist


{
  "message": "Unknown pipeline name 'non-existent-pipeline'",
  "error_code": "UnknownPipelineName",
  "details": {
    "pipeline_name": "non-existent-pipeline"
  }
}