Start cluster analysis

Starts a read-only analysis for the cluster. The result and logs can be retrieved later from the cluster analysis endpoints.

POST /clusters/{clusterId}/analysis

Start cluster analysis

cURL

curl --request POST \
  --url https://api.qovery.com/clusters/{clusterId}/analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prometheus_url": "<string>",
  "cmd_args": [
    "--history_duration",
    "336",
    "--timeframe_duration",
    "2.5",
    "--cpu-request",
    "99",
    "--cpu-limit",
    "99",
    "--memory-buffer-percentage",
    "15",
    "--use-oomkill-data",
    "--oom-memory-buffer-percentage",
    "25",
    "-n",
    "default"
  ],
  "target_kubernetes_version": "1.32"
}
'

import requests

url = "https://api.qovery.com/clusters/{clusterId}/analysis"

payload = {
    "prometheus_url": "<string>",
    "cmd_args": ["--history_duration", "336", "--timeframe_duration", "2.5", "--cpu-request", "99", "--cpu-limit", "99", "--memory-buffer-percentage", "15", "--use-oomkill-data", "--oom-memory-buffer-percentage", "25", "-n", "default"],
    "target_kubernetes_version": "1.32"
}
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({
    prometheus_url: '<string>',
    cmd_args: [
      '--history_duration',
      '336',
      '--timeframe_duration',
      '2.5',
      '--cpu-request',
      '99',
      '--cpu-limit',
      '99',
      '--memory-buffer-percentage',
      '15',
      '--use-oomkill-data',
      '--oom-memory-buffer-percentage',
      '25',
      '-n',
      'default'
    ],
    target_kubernetes_version: '1.32'
  })
};

fetch('https://api.qovery.com/clusters/{clusterId}/analysis', 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/clusters/{clusterId}/analysis",
  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([
    'prometheus_url' => '<string>',
    'cmd_args' => [
        '--history_duration',
        '336',
        '--timeframe_duration',
        '2.5',
        '--cpu-request',
        '99',
        '--cpu-limit',
        '99',
        '--memory-buffer-percentage',
        '15',
        '--use-oomkill-data',
        '--oom-memory-buffer-percentage',
        '25',
        '-n',
        'default'
    ],
    'target_kubernetes_version' => '1.32'
  ]),
  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/clusters/{clusterId}/analysis"

	payload := strings.NewReader("{\n  \"prometheus_url\": \"<string>\",\n  \"cmd_args\": [\n    \"--history_duration\",\n    \"336\",\n    \"--timeframe_duration\",\n    \"2.5\",\n    \"--cpu-request\",\n    \"99\",\n    \"--cpu-limit\",\n    \"99\",\n    \"--memory-buffer-percentage\",\n    \"15\",\n    \"--use-oomkill-data\",\n    \"--oom-memory-buffer-percentage\",\n    \"25\",\n    \"-n\",\n    \"default\"\n  ],\n  \"target_kubernetes_version\": \"1.32\"\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/clusters/{clusterId}/analysis")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prometheus_url\": \"<string>\",\n  \"cmd_args\": [\n    \"--history_duration\",\n    \"336\",\n    \"--timeframe_duration\",\n    \"2.5\",\n    \"--cpu-request\",\n    \"99\",\n    \"--cpu-limit\",\n    \"99\",\n    \"--memory-buffer-percentage\",\n    \"15\",\n    \"--use-oomkill-data\",\n    \"--oom-memory-buffer-percentage\",\n    \"25\",\n    \"-n\",\n    \"default\"\n  ],\n  \"target_kubernetes_version\": \"1.32\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/clusters/{clusterId}/analysis")

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  \"prometheus_url\": \"<string>\",\n  \"cmd_args\": [\n    \"--history_duration\",\n    \"336\",\n    \"--timeframe_duration\",\n    \"2.5\",\n    \"--cpu-request\",\n    \"99\",\n    \"--cpu-limit\",\n    \"99\",\n    \"--memory-buffer-percentage\",\n    \"15\",\n    \"--use-oomkill-data\",\n    \"--oom-memory-buffer-percentage\",\n    \"25\",\n    \"-n\",\n    \"default\"\n  ],\n  \"target_kubernetes_version\": \"1.32\"\n}"

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

202

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "triggered_by": "<string>",
  "error_message": "<string>"
}

Authorizations

bearerAuthApiKeyAuth

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

clusterId · string<uuid> · required

Cluster ID

Body

application/json

kind · enum<string> · required

Available options: COST_RECOMMENDATION, DEPRECATED_API_CHECK

output_format · enum<string> · required

Available options: TABLE, JSON, CSV

prometheus_url · string | null

Optional Prometheus URL for COST_RECOMMENDATION analysis. When omitted, the engine resolves the default Qovery OBS endpoint.

cmd_args · string[]

Optional allowlisted KRR arguments for COST_RECOMMENDATION analysis. The engine validates and rejects unsupported or unsafe KRR flags.

Example:

[
  "--history_duration",
  "336",
  "--timeframe_duration",
  "2.5",
  "--cpu-request",
  "99",
  "--cpu-limit",
  "99",
  "--memory-buffer-percentage",
  "15",
  "--use-oomkill-data",
  "--oom-memory-buffer-percentage",
  "25",
  "-n",
  "default"
]

target_kubernetes_version · string | null

Optional target Kubernetes version for DEPRECATED_API_CHECK analysis.

Example:

"1.32"

Response

202

application/json

Cluster analysis started

id · string<uuid> · required

cluster_id · string<uuid> · required

organization_id · string<uuid> · required

kind · enum<string> · required

Available options: COST_RECOMMENDATION, DEPRECATED_API_CHECK

status · enum<string> · required

Available options: PENDING, RUNNING, SUCCEEDED, FAILED, TERMINATED

output_format · enum<string> · required

Available options: TABLE, JSON, CSV

created_at · string<date-time> · required

updated_at · string<date-time> · required

triggered_by · string · required

error_message · string | null