Cancel agentic workflow deployment
curl --request POST \
--url https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"force_cancel": false
}
'import requests
url = "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment"
payload = { "force_cancel": False }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({force_cancel: false})
};
fetch('https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'force_cancel' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment"
payload := strings.NewReader("{\n \"force_cancel\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"force_cancel\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"force_cancel\": false\n}"
response = http.request(request)
puts response.read_bodyAgentic Workflows
Cancel agentic workflow deployment
Cancel the deployment currently running the agentic workflow. An agentic workflow only ever runs as part of a deployment of its environment, so this cancels that environment deployment and aborts the workflow’s running job.
POST
/
agenticWorkflow
/
{agenticWorkflowId}
/
cancelDeployment
Cancel agentic workflow deployment
curl --request POST \
--url https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"force_cancel": false
}
'import requests
url = "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment"
payload = { "force_cancel": False }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({force_cancel: false})
};
fetch('https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'force_cancel' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment"
payload := strings.NewReader("{\n \"force_cancel\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"force_cancel\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}/cancelDeployment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"force_cancel\": false\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
bearerAuthApiKeyAuth
JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '
Path Parameters
Body
application/json
When false, the engine stops the deployment at the next safe point, letting the workflow's job terminate on its own. When true it stops waiting for that job and abandons it immediately.
Response
agentic workflow deployment cancelling has been requested, no response body
Was this page helpful?