Sign in
Blueprint
Blueprint-Lifecycle

Create and build a Blueprint.

Starts build of custom defined container Blueprint. The Blueprint will begin in the 'provisioning' step and transition to the 'building' step once it is selected off the build queue., Upon build complete it will transition to 'building_complete' if the build is successful.

post/v1/blueprints

Request body

namestring required

Name of the Blueprint.

dockerfilestring nullable

Dockerfile contents to be used to build the Blueprint.

system_setup_commandsstring[] nullable

A list of commands to run to set up your system.

file_mountsobject nullable

(Optional) Map of paths and file contents to write before setup.

base_blueprint_idstring nullable

(Optional) ID of previously built blueprint to use as a base blueprint for this build.

base_blueprint_namestring nullable

(Optional) Name of previously built blueprint to use as a base blueprint for this build. When set, this will load the latest successfully built Blueprint with the given name. Only one of (base_blueprint_id, base_blueprint_name) should be specified.

metadataobject nullable

(Optional) User defined metadata for the Blueprint.

Response

OK

idstring required

The id of the Blueprint.

namestring required

The name of the Blueprint.

status'provisioning' | 'building' | 'failed' | 'build_complete' required

The status of the Blueprint build.

provisioning: Allocating and booting the necessary infrastructure resources to create the Blueprint image. building: Building the Blueprint image. failed: Blueprint image failed to build. See the logs on the dashboard. build_complete: Blueprint image completed build. You can now use the ID to create Devboxes.

state'created' | 'deleted' required
create_time_msinteger required

Creation time of the Blueprint (Unix timestamp milliseconds).

failure_reason'out_of_memory' | 'out_of_disk' | 'build_failed'

The cause of the failure of the Blueprint build.

out_of_memory: The build has run out of memory. Contact support if this is unexpected. out_of_disk: The build has run out of disk. Contact support if this is unexpected. build_failed: The build has failed. Use the dashboard to look at Blueprint build logs for more info.

base_blueprint_idstring nullable

The ID of the base Blueprint.

is_publicboolean

Whether this Blueprint is publicly accessible to all users.

metadataobject nullable

User defined metadata associated with the blueprint.

devbox_capabilitiesDevboxCapabilities[] nullable

Capabilities that will be available on Devbox.

Changes