Skip to main content
POST
Create a blueprint service in an environment

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

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.

Example:

Response

Blueprint created (deploy=false)

id
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