Get the Qovery Operator bootstrap

curl --request GET \
  --url https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/bootstrap \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/bootstrap"

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/bootstrap', 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/bootstrap",
  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/bootstrap"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/bootstrap")

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

{
  "chart_repository": "oci://public.ecr.aws/r3m4q3r9/charts",
  "chart_name": "qovery-operator",
  "chart_version": "0.2.1",
  "chart_reference": "oci://public.ecr.aws/r3m4q3r9/charts/qovery-operator",
  "namespace": "qovery",
  "release_name": "qovery-operator",
  "values": {},
  "values_yaml": "<string>",
  "helm_command": "helm upgrade --install qovery-operator oci://public.ecr.aws/r3m4q3r9/charts/qovery-operator --version 0.2.1 --namespace qovery --create-namespace --atomic --wait --timeout 15m -f values.yaml"
}

GET

organization

{organizationId}

cluster

{clusterId}

operator

bootstrap

Get the Qovery Operator bootstrap

curl --request GET \
  --url https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/bootstrap \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/bootstrap"

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/bootstrap', 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/bootstrap",
  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/bootstrap"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/operator/bootstrap")

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

{
  "chart_repository": "oci://public.ecr.aws/r3m4q3r9/charts",
  "chart_name": "qovery-operator",
  "chart_version": "0.2.1",
  "chart_reference": "oci://public.ecr.aws/r3m4q3r9/charts/qovery-operator",
  "namespace": "qovery",
  "release_name": "qovery-operator",
  "values": {},
  "values_yaml": "<string>",
  "helm_command": "helm upgrade --install qovery-operator oci://public.ecr.aws/r3m4q3r9/charts/qovery-operator --version 0.2.1 --namespace qovery --create-namespace --atomic --wait --timeout 15m -f values.yaml"
}

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

organizationId

string<uuid>

required

Organization ID

clusterId

string<uuid>

required

Cluster ID

Response

Compiled Qovery Operator bootstrap

Sensitive bootstrap material used to install or manually upgrade the Qovery Operator on a self-managed cluster.

chart_repository

string

required

Example:

"oci://public.ecr.aws/r3m4q3r9/charts"

chart_name

string

required

Example:

"qovery-operator"

chart_version

string

required

Example:

"0.2.1"

chart_reference

string

required

Example:

"oci://public.ecr.aws/r3m4q3r9/charts/qovery-operator"

namespace

string

required

Example:

"qovery"

release_name

string

required

Example:

"qovery-operator"

values

object

required

Structured Helm values. This object can contain cluster credentials.

values_yaml

string

required

Ready-to-write Helm values file. This value can contain cluster credentials.

helm_command

string

required

Ready-to-run Helm upgrade/install command using values_yaml.

Example:

"helm upgrade --install qovery-operator oci://public.ecr.aws/r3m4q3r9/charts/qovery-operator --version 0.2.1 --namespace qovery --create-namespace --atomic --wait --timeout 15m -f values.yaml"