Check ArgoCD connection

Test an ArgoCD URL and token before saving. The cluster agent attempts to connect to ArgoCD and returns the connection result. Always returns HTTP 200 — check the status field for the connection outcome. Requires ADMIN role.

POST /cluster/{clusterId}/argoCdConfig/check

Check ArgoCD connection

cURL

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>"
}
'

200

{
  "status": "connected",
  "app_count": 42,
  "reason": "authentication_failed"
}

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

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

200

application/json

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"