curl --request GET \
--url https://api.qovery.com/blueprint/{blueprintId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/blueprint/{blueprintId}"
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/blueprint/{blueprintId}', 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/blueprint/{blueprintId}",
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/blueprint/{blueprintId}"
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/blueprint/{blueprintId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/blueprint/{blueprintId}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"catalog_url": "<string>",
"tag": "aws/postgres/17/1.0.1",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"service_type": "HELM",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latest_deployment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"execution_id": "exec-abc-123",
"status": "WAITING_RUNNING",
"started_at": "2023-11-07T05:31:56Z",
"terminated_at": "2023-11-07T05:31:56Z",
"error_message": "<string>"
}
}Get a blueprint service and the status of its latest dispatch
Returns the blueprint, the Helm/Terraform service its dispatch produced once that service exists, and the latest dispatch with its status and the engine’s error message.
This is the only way to learn that a dispatch failed. Success is pushed over the /blueprint/service-created websocket, but there is no failure counterpart, so a client that only listens on the websocket waits forever on a dispatch that errored.
curl --request GET \
--url https://api.qovery.com/blueprint/{blueprintId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/blueprint/{blueprintId}"
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/blueprint/{blueprintId}', 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/blueprint/{blueprintId}",
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/blueprint/{blueprintId}"
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/blueprint/{blueprintId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/blueprint/{blueprintId}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"catalog_url": "<string>",
"tag": "aws/postgres/17/1.0.1",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"service_type": "HELM",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latest_deployment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"execution_id": "exec-abc-123",
"status": "WAITING_RUNNING",
"started_at": "2023-11-07T05:31:56Z",
"terminated_at": "2023-11-07T05:31:56Z",
"error_message": "<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
Blueprint ID
Response
Blueprint details
URL to the blueprint catalog entry
"aws/postgres/17/1.0.1"
Type of the underlying service backing this blueprint
HELM, TERRAFORM The service the dispatch produced. Null while the dispatch is still running, and null if it failed.
Latest dispatch for this blueprint. Null if it was never dispatched.
Show child attributes
Show child attributes
Was this page helpful?