Skip to main content
POST
/
blueprint
/
{blueprintId}
/
update
/
preview
Preview a blueprint update
curl --request POST \
  --url https://api.qovery.com/blueprint/{blueprintId}/update/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-postgres",
  "tag": "aws/postgres/17/1.1.0",
  "icon": "https://cdn.qovery.com/icons/postgresql.svg",
  "variables": {},
  "spec_overrides": {
    "engine_version": "1.13.3",
    "credentials": "cluster",
    "backend": "qovery"
  }
}
'
import requests

url = "https://api.qovery.com/blueprint/{blueprintId}/update/preview"

payload = {
"name": "my-postgres",
"tag": "aws/postgres/17/1.1.0",
"icon": "https://cdn.qovery.com/icons/postgresql.svg",
"variables": {},
"spec_overrides": {
"engine_version": "1.13.3",
"credentials": "cluster",
"backend": "qovery"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'my-postgres',
tag: 'aws/postgres/17/1.1.0',
icon: 'https://cdn.qovery.com/icons/postgresql.svg',
variables: {},
spec_overrides: {engine_version: '1.13.3', credentials: 'cluster', backend: 'qovery'}
})
};

fetch('https://api.qovery.com/blueprint/{blueprintId}/update/preview', 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}/update/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'my-postgres',
'tag' => 'aws/postgres/17/1.1.0',
'icon' => 'https://cdn.qovery.com/icons/postgresql.svg',
'variables' => [

],
'spec_overrides' => [
'engine_version' => '1.13.3',
'credentials' => 'cluster',
'backend' => 'qovery'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.qovery.com/blueprint/{blueprintId}/update/preview"

payload := strings.NewReader("{\n \"name\": \"my-postgres\",\n \"tag\": \"aws/postgres/17/1.1.0\",\n \"icon\": \"https://cdn.qovery.com/icons/postgresql.svg\",\n \"variables\": {},\n \"spec_overrides\": {\n \"engine_version\": \"1.13.3\",\n \"credentials\": \"cluster\",\n \"backend\": \"qovery\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.qovery.com/blueprint/{blueprintId}/update/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"my-postgres\",\n \"tag\": \"aws/postgres/17/1.1.0\",\n \"icon\": \"https://cdn.qovery.com/icons/postgresql.svg\",\n \"variables\": {},\n \"spec_overrides\": {\n \"engine_version\": \"1.13.3\",\n \"credentials\": \"cluster\",\n \"backend\": \"qovery\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/blueprint/{blueprintId}/update/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"my-postgres\",\n \"tag\": \"aws/postgres/17/1.1.0\",\n \"icon\": \"https://cdn.qovery.com/icons/postgresql.svg\",\n \"variables\": {},\n \"spec_overrides\": {\n \"engine_version\": \"1.13.3\",\n \"credentials\": \"cluster\",\n \"backend\": \"qovery\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "preview_id": "exec-abc-123"
}

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

blueprintId
string<uuid>
required

Blueprint ID

Body

application/json
name
string
required

Display name for the service

Example:

"my-postgres"

tag
string
required

Catalog tag identifying the target blueprint version

Example:

"aws/postgres/17/1.1.0"

icon
string<uri>
required

Icon URL for the service

Example:

"https://cdn.qovery.com/icons/postgresql.svg"

variables
object

RFC 7396 patch map keyed by variable name. Non-null value upserts the variable; null value removes it. Absent keys are left untouched. Omitting the field entirely is equivalent to an empty map — no variables are modified.

spec_overrides
object | null

JSON Merge Patch (RFC 7396) applied to the stored spec_overrides (see BlueprintSpecOverrides for the list of valid fields). A non-null field value upserts the override; a null value removes it. Pass null or omit the field entirely to leave all existing overrides unchanged.

Example:
{
"engine_version": "1.13.3",
"credentials": "cluster",
"backend": "qovery"
}

Response

Preview accepted

preview_id
string
required

Identifier of the preview execution

Example:

"exec-abc-123"

service_type
enum<string>
required

Type of the underlying service backing this blueprint

Available options:
HELM,
TERRAFORM