Skip to main content
POST
/
environment
/
{environmentId}
/
blueprint
Create a blueprint service in an environment
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/blueprint \
  --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": [],
  "specOverrides": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "catalogUrl": "<string>",
  "tag": "aws/postgres/17/1.0.1",
  "environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

​
specOverrides
object

Partial spec overrides merged on top of the blueprint manifest

Response

Blueprint created

​
id
string<uuid>
required
​
catalogUrl
string<uri>
required

URL to the blueprint catalog entry

​
tag
string
required
Example:

"aws/postgres/17/1.0.1"

​
environmentId
string<uuid>
required