Skip to main content
PATCH
/
blueprint
/
{blueprintId}
Update a blueprint service
curl --request PATCH \
  --url https://api.qovery.com/blueprint/{blueprintId} \
  --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"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "catalog_url": "<string>",
  "tag": "aws/postgres/17/1.0.1",
  "environment_id": "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

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

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

Blueprint updated

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