Stop Pipeline

curl -X POST 'https://api.example.com/v0/pipelines/{pipeline_name}/stop?force=<force>' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://api.example.com/v0/pipelines/{pipeline_name}/stop?force=<force>', {
  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}/stop?force=<force>', {
  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}/stop"
params = {
    "force": "<force>"
}
headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}
 
response = requests.request("post", url, params=params, 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}/stop?force=<force>", 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": "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."
  }
}

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