Skip to main content
Blueprints are ways to create customized starting points for Devboxes. They allow you to define custom starting points for Devboxes such that environment set up can be cached to improve Devbox boot times.

Blueprints are ways to create customized starting points for Devboxes. They allow you to define custom starting points for Devboxes such that environment set up can be cached to improve Devbox boot times.

id
string
required

The id of the Blueprint.

name
string
required

The name of the Blueprint.

status
enum<string>
required

The status of the Blueprint build.

Available options:
provisioning,
building,
failed,
build_complete
state
enum<string>
required

The state of the Blueprint.

Available options:
created,
deleted
create_time_ms
integer
required

Creation time of the Blueprint (Unix timestamp milliseconds).

parameters
object
required

The parameters used to create Blueprint.

build_finish_time_ms
integer | null

Build completion time of the Blueprint (Unix timestamp milliseconds).

failure_reason
enum<string> | null

The failure reason if the Blueprint build failed, if any.

Available options:
out_of_memory,
out_of_disk,
build_failed
base_blueprint_id
string | null

The ID of the base Blueprint.

containerized_services
object[] | null

List of ContainerizedServices available in the Blueprint. Services can be explicitly started when creating a Devbox.

is_public
boolean

Whether this Blueprint is publicly accessible to all users.

metadata
object | null

User defined metadata associated with the blueprint.

devbox_capabilities
enum<string>[] | null

Capabilities that will be available on Devbox.

I