> ## Documentation Index
> Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check if a blueprint service has an available update

> Returns the update availability for a deployed blueprint service, including the latest tag, and a diff of variables that are new, changed, or removed.



## OpenAPI

````yaml /api-reference/openapi.yaml get /blueprint/{blueprintId}/update
openapi: 3.0.0
info:
  version: 1.0.4
  title: Qovery API
  description: >
    - Qovery is the fastest way to deploy your full-stack apps on any Cloud
    provider.

    - ℹ️ The API is stable and still in development.
  contact:
    name: Qovery Product Team
    url: https://www.qovery.com
    email: support+api+documentation@qovery.com
  x-logo:
    url: https://console.qovery.com/assets/logos/logo-white.svg
    altText: Qovery
servers:
  - url: https://api.qovery.com
security:
  - bearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Account
  - name: Account Info
  - name: Alert Receivers
  - name: Alert Rules
  - name: Admin
  - name: ArgoCD
  - name: Application
  - name: Application Actions
  - name: Application Configuration
  - name: Application Database
  - name: Application Deployment Restriction
  - name: Application Deployment History
  - name: Application Environment Variable
  - name: Application Logs
  - name: Application Main Calls
  - name: Application Secret
  - name: Application Annotations Group
  - name: Applications
  - name: AutoscalingPolicy
  - name: Container
  - name: Container Actions
  - name: Container Configuration
  - name: Container Database
  - name: Container Deployment History
  - name: Container Environment Variable
  - name: Container Logs
  - name: Container Main Calls
  - name: Container Registry
  - name: Container Secret
  - name: Container Annotations Group
  - name: Containers
  - name: Deployment Stage Main Calls
  - name: Job
  - name: Job Actions
  - name: Job Configuration
  - name: Job Database
  - name: Job Deployment Restriction
  - name: Job Deployment History
  - name: Job Environment Variable
  - name: Job Logs
  - name: Job Main Calls
  - name: Job Registry
  - name: Job Secret
  - name: Job Annotations Group
  - name: Jobs
  - name: KedaTriggerAuthentication
  - name: Helm
  - name: Helm Actions
  - name: Helm Configuration
  - name: Helm Database
  - name: Helm Deployment Restriction
  - name: Helm Deployment History
  - name: Helm Logs
  - name: Helm Main Calls
  - name: Helm Repository
  - name: Helms
  - name: Backups
  - name: Billing
  - name: Blueprint Catalog
  - name: Cloud Provider
  - name: Cloud Provider Credentials
  - name: Clusters
  - name: Custom Domain
  - name: Container Custom Domain
  - name: Database
  - name: Database Actions
  - name: Database Application
  - name: Database Container
  - name: Database Deployment History
  - name: Database Main Calls
  - name: Database Annotations Group
  - name: Databases
  - name: Environment
  - name: Environment Actions
  - name: Environment Deployment History
  - name: Environment Deployment Rule
  - name: Environment Logs
  - name: Environment Main Calls
  - name: Environment Secret
  - name: Environment Variable
  - name: Environments
  - name: Git
  - name: Github App
  - name: Git repositories
  - name: Members
  - name: Organization
  - name: Organization Account Git Repositories
  - name: Organization Cluster Lock
  - name: Organization Main Calls
  - name: Organization Custom Role
  - name: Organization Event
  - name: Organization Api Token
  - name: Organization Webhook
  - name: Organization Annotations Group
  - name: Organization Labels Group
  - name: Organization Enterprise Connection
  - name: Project
  - name: Project Deployment Rule
  - name: Project Environment Variable
  - name: Project Main Calls
  - name: Project Secret
  - name: Projects
  - name: Referral & Rewards
  - name: Secret Manager Access
  - name: Terraforms
  - name: Terraform Main Calls
  - name: Terraform Resources
  - name: Terraform Deployment History
  - name: Terraform Deployment Restriction
  - name: Container Registries
  - name: Helm Repositories
  - name: User Sign Up
  - name: Variable Main Calls
  - name: Helm Custom Domain
  - name: Lifecycle Template Main Calls
  - name: Blueprint Main Calls
paths:
  /blueprint/{blueprintId}/update:
    get:
      tags:
        - Blueprint Main Calls
      summary: Check if a blueprint service has an available update
      description: >-
        Returns the update availability for a deployed blueprint service,
        including the latest tag, and a diff of variables that are new, changed,
        or removed.
      operationId: checkBlueprintUpdate
      parameters:
        - $ref: '#/components/parameters/blueprintId'
      responses:
        '200':
          description: Blueprint update availability
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlueprintUpdateResponse'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          description: Malformed blueprint tag
        '502':
          description: Failed to fetch blueprint manifest from GitHub
components:
  parameters:
    blueprintId:
      name: blueprintId
      in: path
      description: Blueprint ID
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    BlueprintUpdateResponse:
      type: object
      required:
        - is_up_to_date
        - latest_tag
        - new_required_values
        - new_optional_values
        - now_required_values
        - updated_values
        - removed_values
        - engine_diff
        - new_major_versions
      properties:
        is_up_to_date:
          type: boolean
        latest_tag:
          type: string
          example: aws/postgres/17/1.1.0
        new_required_values:
          type: array
          description: >-
            Variables added in the latest version that are required with no
            default
          items:
            $ref: '#/components/schemas/BlueprintUpdateNewRequiredValue'
        new_optional_values:
          type: array
          description: Variables added in the latest version that have a default value
          items:
            $ref: '#/components/schemas/BlueprintUpdateNewOptionalValue'
        now_required_values:
          type: array
          description: >-
            Variables that were optional but are now required in the latest
            version
          items:
            $ref: '#/components/schemas/BlueprintUpdateNewRequiredValue'
        updated_values:
          type: array
          description: >-
            Variables whose default value changed between the current and latest
            versions
          items:
            $ref: '#/components/schemas/BlueprintUpdateUpdatedValue'
        removed_values:
          type: array
          description: Variables that no longer exist in the latest version
          items:
            $ref: '#/components/schemas/BlueprintUpdateRemovedValue'
        engine_diff:
          $ref: '#/components/schemas/BlueprintUpdateEngineDiff'
        new_major_versions:
          type: array
          description: >-
            Major versions of the same blueprint newer than the service's
            current one (e.g. service on aws/postgres/16 while 17 and 18 exist).
            Empty when already on the latest major or when the current version
            is non-numeric.
          items:
            $ref: '#/components/schemas/BlueprintUpdateNewMajorVersion'
    BlueprintUpdateNewRequiredValue:
      type: object
      required:
        - name
        - type
        - is_secret
      properties:
        name:
          type: string
        type:
          $ref: '#/components/schemas/BlueprintManifestFieldType'
        allowed_values:
          type: array
          nullable: true
          description: Values the user may choose from. Null = unrestricted.
          items:
            type: string
        is_secret:
          type: boolean
    BlueprintUpdateNewOptionalValue:
      type: object
      required:
        - name
        - type
        - is_secret
      properties:
        name:
          type: string
        default_value:
          type: string
          nullable: true
        type:
          $ref: '#/components/schemas/BlueprintManifestFieldType'
        allowed_values:
          type: array
          nullable: true
          description: Values the user may choose from. Null = unrestricted.
          items:
            type: string
        is_secret:
          type: boolean
    BlueprintUpdateUpdatedValue:
      type: object
      required:
        - name
        - type
        - is_secret
      properties:
        name:
          type: string
        current_default_value:
          type: string
          nullable: true
        new_default_value:
          type: string
          nullable: true
        current_value:
          type: string
          nullable: true
        type:
          $ref: '#/components/schemas/BlueprintManifestFieldType'
        allowed_values:
          type: array
          nullable: true
          description: Values the user may choose from. Null = unrestricted.
          items:
            type: string
        is_secret:
          type: boolean
    BlueprintUpdateRemovedValue:
      type: object
      required:
        - name
      properties:
        name:
          type: string
    BlueprintUpdateEngineDiff:
      type: object
      description: >-
        Catalog engine-block deltas between the current and latest blueprint
        tag.
      required:
        - updated_values
      properties:
        updated_values:
          type: array
          items:
            $ref: '#/components/schemas/BlueprintUpdateEngineFieldChange'
    BlueprintUpdateNewMajorVersion:
      type: object
      description: A newer major version of the blueprint available for a major upgrade.
      required:
        - service_version
        - latest_tag
      properties:
        service_version:
          type: string
          description: The engine major version (e.g. "17").
          example: '17'
        latest_tag:
          type: string
          description: Latest catalog tag for that major version.
          example: aws/postgres/17/1.0.1
    BlueprintManifestFieldType:
      type: object
      description: >-
        Field type with its type-specific validation conditions, discriminated
        by "type".
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - string
            - bool
            - number
        pattern:
          type: string
          nullable: true
          description: Regex pattern, only present for string fields
        min_length:
          type: integer
          format: int64
          nullable: true
          description: Minimum length, only present for string fields
        max_length:
          type: integer
          format: int64
          nullable: true
          description: Maximum length, only present for string fields
        min:
          type: integer
          format: int64
          nullable: true
          description: Lower bound, only present for number fields
        max:
          type: integer
          format: int64
          nullable: true
          description: Upper bound, only present for number fields
    BlueprintUpdateEngineFieldChange:
      type: object
      description: >-
        A single engine-block field delta (e.g. version, cpu, ram). Not a
        manifest variable, so it carries no field type or constraints.
      required:
        - name
      properties:
        name:
          type: string
        current_default_value:
          type: string
          nullable: true
        new_default_value:
          type: string
          nullable: true
        current_value:
          type: string
          nullable: true
  responses:
    '401':
      description: Access token is missing or invalid
    '403':
      description: Access forbidden
    '404':
      description: Resource not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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" '
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token API are generated by Qovery to manage machine to machine
        interaction and do not have a TTL. Curl Example ' curl
        https://console.qovery.com/organization -H "Authorization: Token
        $qovery_token" '

````