Dismiss Pipeline Deployment Error

POST/v0/pipelines/{pipeline_name}/dismiss_errorPipeline Lifecycle

Try it

POST/v0/pipelines/{pipeline_name}/dismiss_error

Authentication

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

Parameters

pipeline_name (path, required)

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

JSON web token (JWT) or API keyBearer token

Parameters

Path parameters

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

Response

200Deployment error has been dismissed

400Action could not be performedapplication/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.

404Pipeline with that name does not existapplication/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.

500application/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.


curl -X POST 'https://api.example.com/v0/pipelines/{pipeline_name}/dismiss_error' \
  -H 'Authorization: Bearer YOUR_TOKEN'


const response = await fetch('https://api.example.com/v0/pipelines/{pipeline_name}/dismiss_error', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
 
const data = await response.json();
console.log(data);


interface ApiResponse {
  // shape your response here
}
 
const response: Response = await fetch('https://api.example.com/v0/pipelines/{pipeline_name}/dismiss_error', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
 
const data = (await response.json()) as ApiResponse;
console.log(data);


import requests
 
url = "https://api.example.com/v0/pipelines/{pipeline_name}/dismiss_error"
headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}
 
response = requests.request("post", url, headers=headers)
print(response.json())


package main
 
import (
	"fmt"
	"io"
	"net/http"
)
 
func main() {
	req, err := http.NewRequest("POST", "https://api.example.com/v0/pipelines/{pipeline_name}/dismiss_error", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, _ := io.ReadAll(resp.Body)
	fmt.Println(string(out))
}


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