Skip to navigation
API ReferenceV3

Update a blueprint’s contents and/or position

Partial update for a single blueprint. Does NOT auto-trigger a build.

Fields honored:

  • contents — writes a new YAML version for the blueprint.
  • position — sets the repo-tier blueprint’s execution position. Returns 400 on an org-tier blueprint (those have no position).

Returns 400 when the body is empty.

Authentication

AuthorizationBearer

Personal API Key (apk_user_) or Service API Key (apk_)

Path parameters

blueprint_idstringRequired
org_idstringRequired

Request

This endpoint expects an object.
contentsstring or nullOptional
If set, replaces the blueprint's YAML body with a new version.
positioninteger or nullOptional

If set, updates the execution position of this repo-tier blueprint. Positions are not required to be unique; ties are broken arbitrarily by the server when sorting for execution.

Response

Successful Response
blueprint_idstring
created_atinteger
repo_namestring or null
typeenum
Allowed values:
updated_atinteger

Errors

422
Unprocessable Entity Error