Create a blueprint service and report the dispatch it started

curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/blueprintDeployment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-postgres",
  "tag": "aws/postgres/17/1.0.1",
  "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/environment/{environmentId}/blueprintDeployment"

payload = {
    "name": "my-postgres",
    "tag": "aws/postgres/17/1.0.1",
    "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.0.1',
    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/environment/{environmentId}/blueprintDeployment', 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/environment/{environmentId}/blueprintDeployment",
  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.0.1',
    '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/environment/{environmentId}/blueprintDeployment"

	payload := strings.NewReader("{\n  \"name\": \"my-postgres\",\n  \"tag\": \"aws/postgres/17/1.0.1\",\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/environment/{environmentId}/blueprintDeployment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-postgres\",\n  \"tag\": \"aws/postgres/17/1.0.1\",\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/environment/{environmentId}/blueprintDeployment")

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.0.1\",\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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "catalog_url": "<string>",
  "tag": "aws/postgres/17/1.0.1",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "execution_id": "exec-abc-123"
}

Blueprint Main Calls

Create a blueprint service and report the dispatch it started

Instantiates a blueprint from the service catalog into the given environment and returns the ids of the engine dispatch it started. Pass deploy=true to trigger an immediate deployment after creation. Takes the same request as POST /environment//blueprint. That endpoint answers 201, which claims a service that does not exist yet: the dispatch creating the underlying Helm/Terraform service runs on a background executor after the transaction commits. This one always answers 202 and hands back deployment_id and execution_id, which GET /blueprint/ resolves.

POST

environment

{environmentId}

blueprintDeployment

Create a blueprint service and report the dispatch it started

curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/blueprintDeployment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-postgres",
  "tag": "aws/postgres/17/1.0.1",
  "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/environment/{environmentId}/blueprintDeployment"

payload = {
    "name": "my-postgres",
    "tag": "aws/postgres/17/1.0.1",
    "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.0.1',
    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/environment/{environmentId}/blueprintDeployment', 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/environment/{environmentId}/blueprintDeployment",
  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.0.1',
    '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/environment/{environmentId}/blueprintDeployment"

	payload := strings.NewReader("{\n  \"name\": \"my-postgres\",\n  \"tag\": \"aws/postgres/17/1.0.1\",\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/environment/{environmentId}/blueprintDeployment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-postgres\",\n  \"tag\": \"aws/postgres/17/1.0.1\",\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/environment/{environmentId}/blueprintDeployment")

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.0.1\",\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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "catalog_url": "<string>",
  "tag": "aws/postgres/17/1.0.1",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "execution_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

environmentId

string<uuid>

required

Environment ID

Query Parameters

deploy

boolean

default:false

Trigger a deployment immediately after creation

Body

application/json

name

string

required

Display name for the service

Example:

"my-postgres"

tag

string

required

Catalog tag identifying the blueprint version

Example:

"aws/postgres/17/1.0.1"

icon

string<uri>

required

Icon URL for the service

Example:

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

variables

object[]

Variable overrides for the blueprint

Show child attributes

spec_overrides

object | null

Engine-level overrides applied on top of the blueprint manifest. Only fields whose corresponding manifest field is overridable: true are accepted; submitting a non-overridable field returns 422. Terraform / OpenTofu blueprints engine_version is required on create. The value must be one of the versions listed in spec.engine.terraform.allowedValues (or opentofu.allowedValues) in the manifest. Helm blueprints engine_version, credentials, and backend are ignored. Only timeout and the resource fields apply.

Show child attributes

Example:

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

Response

Blueprint created and an engine dispatch accepted

Answer to a blueprint creation: the blueprint exists and an engine dispatch was started. The service it should materialize does not exist yet.

string<uuid>

required

catalog_url

string<uri>

required

URL to the blueprint catalog entry

tag

string

required

Example:

"aws/postgres/17/1.0.1"

environment_id

string<uuid>

required

deployment_id

string<uuid>

required

Identifier of the dispatch started by this creation. Resolve its status with GET /blueprint/{blueprintId}, and match it against latest_deployment.id there to confirm that dispatch is this one rather than a later re-dispatch.

execution_id

string

required

Engine execution identifier for this dispatch

Example:

"exec-abc-123"