Skip to Content
API ReferencePipeline LifecycleDismiss Pipeline Deployment Error

Dismiss Pipeline Deployment Error

POST/v0/pipelines/{pipeline_name}/dismiss_error
Authentication
Parameters

Clears the deployment_error field of the pipeline, such that a subsequent call to /start?dismiss_error=false succeeds. It will return an error if the pipeline is not fully stopped (i.e., both current and desired status must be Stopped) AND a deployment error is present.

Authentication

SchemeTypeDetails
JSON web token (JWT) or API keyBearer tokenAuthorization 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

NameTypeRequiredDescription
pipeline_namestringYesUnique pipeline name

Response

Deployment error has been dismissed
Request
curl -X POST '/v0/pipelines/{pipeline_name}/dismiss_error' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
Pipeline with that name does not exist
{ "message": "Unknown pipeline name 'non-existent-pipeline'", "error_code": "UnknownPipelineName", "details": { "pipeline_name": "non-existent-pipeline" } }