Pause Pipeline

POST/v0/pipelines/{pipeline_name}/pause

Authentication

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

Parameters

pipeline_name (path, string, required)

Requests the pipeline to pause, which it will do asynchronously.

Progress should be monitored by polling the pipeline GET endpoints.

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

Response

Action is accepted and is being performed

curl -X POST '/v0/pipelines/{pipeline_name}/pause' \
  -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."
  }
}