curl --request GET \
--url https://api.qovery.com/organization/{organizationId}/platformTemplate \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/organization/{organizationId}/platformTemplate"
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}/platformTemplate', 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}/platformTemplate",
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}/platformTemplate"
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}/platformTemplate")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/organization/{organizationId}/platformTemplate")
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{
"results": [
{
"key": "<string>",
"version": "<string>",
"status": "DRAFT",
"layers": [
{
"key": "<string>",
"mandatory": true,
"enabledByDefault": true,
"modes": [
"QOVERY_MANAGED"
],
"componentKeys": [
"<string>"
],
"components": [
{
"key": "<string>",
"kind": "HELM",
"fields": [
{
"key": "<string>",
"type": "string",
"required": true,
"label": "<string>",
"sensitive": true,
"constraints": {
"allowedValues": [
"<string>"
],
"min": 123,
"max": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>"
},
"defaultValue": "<string>",
"description": "<string>"
}
],
"description": "<string>"
}
],
"providers": [
"AWS"
],
"description": "<string>"
}
],
"description": "<string>"
}
]
}List platform templates
Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render. When clusterMode and cloudProvider are supplied together, component field constraints are narrowed to the effective choices for that cluster context.
curl --request GET \
--url https://api.qovery.com/organization/{organizationId}/platformTemplate \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/organization/{organizationId}/platformTemplate"
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}/platformTemplate', 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}/platformTemplate",
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}/platformTemplate"
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}/platformTemplate")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/organization/{organizationId}/platformTemplate")
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{
"results": [
{
"key": "<string>",
"version": "<string>",
"status": "DRAFT",
"layers": [
{
"key": "<string>",
"mandatory": true,
"enabledByDefault": true,
"modes": [
"QOVERY_MANAGED"
],
"componentKeys": [
"<string>"
],
"components": [
{
"key": "<string>",
"kind": "HELM",
"fields": [
{
"key": "<string>",
"type": "string",
"required": true,
"label": "<string>",
"sensitive": true,
"constraints": {
"allowedValues": [
"<string>"
],
"min": 123,
"max": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>"
},
"defaultValue": "<string>",
"description": "<string>"
}
],
"description": "<string>"
}
],
"providers": [
"AWS"
],
"description": "<string>"
}
],
"description": "<string>"
}
]
}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
Query Parameters
Cluster management mode. Must be supplied together with cloudProvider.
QOVERY_MANAGED, CUSTOMER_MANAGED Cluster cloud provider. Must be supplied together with clusterMode.
AWS, SCW, GCP, DO, AZURE, OVH, CIVO, HETZNER, ORACLE, IBM, UNKNOWN Response
Published platform template catalog
Show child attributes
Show child attributes
Was this page helpful?