RErender
Blueprints

Update Blueprint

Changed on

Update the Blueprint with the provided ID.

patch/blueprints/{blueprintId}

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Request body

namestring
autoSyncboolean

Configuration value that controls whether or not this blueprint will be re-synced on each git push to the configured branch. Even when true, autoSync will not apply when the blueprint has the Created status, which indicates its first sync has not yet been approved. Other conditions, such as a locked workspace, can also prevent automatic syncing even when this is true.

pathstring

Path to the Blueprint file in the repository

branchstring

The Git branch to read the Blueprint file from. Requires Blueprint onboarding early access. The branch must contain a Blueprint file at the configured path. Updating this field does not plan a sync.

Example request

{
  "path": "render.yaml"
}

Response

Updated

idSchema required(unresolved $ref)
ownerIdstring required

ID of the workspace that owns this Blueprint.

namestring required
statusStatus required(unresolved $ref)
autoSyncAutoSync required(unresolved $ref)
repostring required
branchstring required
pathPath required(unresolved $ref)
lastSyncstring date-time

Changes

  • 6ac5d3d47362Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property pattern ^exs-[0-9a-z]{20}$ was added for the status

    • info

      added the required property to the response with the status