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": [
    {
      "name": "<string>",
      "value": "<string>",
      "is_secret": false
    }
  ],
  "spec_overrides": {}
}
'
{
  "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[] | null

Variable overrides to apply in the preview

​
spec_overrides
object

Partial spec overrides merged on top of the blueprint manifest

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