Skip to main content
POST
/
cluster
/
{clusterId}
/
argoCdConfig
/
check
Check ArgoCD connection
curl --request POST \
  --url https://api.qovery.com/cluster/{clusterId}/argoCdConfig/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "argocd_url": "https://argocd.example.com",
  "argocd_token": "<string>"
}
'
import requests

url = "https://api.qovery.com/cluster/{clusterId}/argoCdConfig/check"

payload = {
    "argocd_url": "https://argocd.example.com",
    "argocd_token": "<string>"
}
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({argocd_url: 'https://argocd.example.com', argocd_token: '<string>'})
};

fetch('https://api.qovery.com/cluster/{clusterId}/argoCdConfig/check', 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/cluster/{clusterId}/argoCdConfig/check",
  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([
    'argocd_url' => 'https://argocd.example.com',
    'argocd_token' => '<string>'
  ]),
  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/cluster/{clusterId}/argoCdConfig/check"

	payload := strings.NewReader("{\n  \"argocd_url\": \"https://argocd.example.com\",\n  \"argocd_token\": \"<string>\"\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/cluster/{clusterId}/argoCdConfig/check")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"argocd_url\": \"https://argocd.example.com\",\n  \"argocd_token\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/cluster/{clusterId}/argoCdConfig/check")

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  \"argocd_url\": \"https://argocd.example.com\",\n  \"argocd_token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "connected",
  "app_count": 42,
  "reason": "authentication_failed"
}

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

clusterId
string<uuid>
required

Cluster ID

Body

application/json
argocd_url
string
required

The URL of the ArgoCD instance (e.g. https://argocd.example.com)

Example:

"https://argocd.example.com"

argocd_token
string
required

ArgoCD API authentication token

Response

Connection check result

status
enum<string>
required

Connection status of an ArgoCD instance

Available options:
connected,
error
Example:

"connected"

app_count
integer

Number of ArgoCD applications visible with the provided token. Present only when status is "connected".

Example:

42

reason
enum<string>

Failure reason. Present only when status is "error".

Available options:
authentication_failed,
unreachable,
insufficient_permissions
Example:

"authentication_failed"