Delete an agentic workflow - Qovery

Delete an agentic workflow

curl --request DELETE \
  --url https://api.qovery.com/agenticWorkflow/{agenticWorkflowId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_part_last_deployment": true,
  "status_details": {
    "sub_action": "NONE"
  },
  "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_requests_count": 123,
  "last_deployment_date": "2023-11-07T05:31:56Z",
  "steps": {
    "total_duration_sec": 123,
    "total_computing_duration_sec": 123,
    "details": [
      {
        "duration_sec": 123
      }
    ]
  },
  "execution_id": "<string>"
}

DELETE

/

agenticWorkflow

/

{agenticWorkflowId}

Delete an agentic workflow

curl --request DELETE \
  --url https://api.qovery.com/agenticWorkflow/{agenticWorkflowId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_part_last_deployment": true,
  "status_details": {
    "sub_action": "NONE"
  },
  "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_requests_count": 123,
  "last_deployment_date": "2023-11-07T05:31:56Z",
  "steps": {
    "total_duration_sec": 123,
    "total_computing_duration_sec": 123,
    "details": [
      {
        "duration_sec": 123
      }
    ]
  },
  "execution_id": "<string>"
}

Authorizations

Authorization

string

header

required

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

agenticWorkflowId

string<uuid>

required

Response

agentic workflow deletion has been queued

id

string<uuid>

required

state

enum<string>

required

Available options:

BUILDING,

BUILD_ERROR,

CANCELED,

CANCELING,

DELETED,

DELETE_ERROR,

DELETE_QUEUED,

DELETING,

DEPLOYED,

DEPLOYING,

DEPLOYMENT_ERROR,

DEPLOYMENT_QUEUED,

EXECUTING,

QUEUED,

READY,

RECAP,

RESTARTED,

RESTARTING,

RESTART_ERROR,

RESTART_QUEUED,

STOPPED,

STOPPING,

STOP_ERROR,

STOP_QUEUED,

UNAVAILABLE,

WAITING_DELETING,

WAITING_RESTARTING,

WAITING_RUNNING,

WAITING_STOPPING

service_deployment_status

enum<string>

required

Available options:

NEVER_DEPLOYED,

OUT_OF_DATE,

UP_TO_DATE

is_part_last_deployment

boolean

required

status_details

object

required

Show child attributes

deployment_request_id

string<uuid> | null

required

deployment_requests_count

integer

required

last_deployment_date

string<date-time>

steps

object

Show child attributes

execution_id

string

⌘I