curl --request GET \
--url https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status', 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/organization/{organizationId}/cluster/{clusterId}/operator/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/organization/{organizationId}/cluster/{clusterId}/operator/status"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"operator_connected": true,
"status": "NOT_ATTACHED",
"last_heartbeat": "2023-11-07T05:31:56Z",
"operator_version": "<string>",
"controller_version": "<string>",
"request_schema_version": "<string>",
"desired_image_version": "<string>",
"desired_chart_version": "<string>",
"reported_chart_version": "<string>",
"reported_identity": {
"release_digest": "<string>",
"runtime_image_id": "<string>",
"chart_version": "<string>",
"observed_at": "2023-11-07T05:31:56Z"
}
}Get the Qovery Operator status for a cluster
Returns heartbeat freshness and the image, chart, and protocol versions last reported by the running Operator, together with the current bootstrap targets and a stable drift status. A false operator_connected value means that no heartbeat was received within the presence window. The status is a display-version drift verdict, not an immutable release compatibility decision. Cluster viewer permission is sufficient.
curl --request GET \
--url https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status', 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/organization/{organizationId}/cluster/{clusterId}/operator/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/organization/{organizationId}/cluster/{clusterId}/operator/status"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"operator_connected": true,
"status": "NOT_ATTACHED",
"last_heartbeat": "2023-11-07T05:31:56Z",
"operator_version": "<string>",
"controller_version": "<string>",
"request_schema_version": "<string>",
"desired_image_version": "<string>",
"desired_chart_version": "<string>",
"reported_chart_version": "<string>",
"reported_identity": {
"release_digest": "<string>",
"runtime_image_id": "<string>",
"chart_version": "<string>",
"observed_at": "2023-11-07T05:31:56Z"
}
}Authorizations
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
Organization ID
Cluster ID
Response
Last reported Qovery Operator status
Whether the last heartbeat is within the Operator presence window.
Stable fleet classification. OUTDATED_IMAGE and OUTDATED_CHART identify which globally selected bootstrap target differs from the version reported by the running Operator.
NOT_ATTACHED, DISCONNECTED, TARGET_UNKNOWN, REPORTED_VERSION_UNKNOWN, CURRENT, OUTDATED_IMAGE, OUTDATED_CHART, OUTDATED_IMAGE_AND_CHART Display version reported by the Operator. For the POC version-reporting heartbeat, the official chart sets this to the exact installed image tag. Legacy Operators can report opaque build metadata instead.
Image tag currently selected for a newly compiled Operator bootstrap.
Helm chart version currently selected for a newly compiled Operator bootstrap.
Helm chart version reported by the Operator, even without immutable identity.
Show child attributes
Show child attributes
Was this page helpful?