@runloop/api-client - v1.22.0
    Preparing search index...

    Interface BlueprintView

    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.

    interface BlueprintView {
        id: string;
        create_time_ms: number;
        name: string;
        parameters: BlueprintBuildParameters;
        state: "deleted" | "created";
        status:
            | "queued"
            | "failed"
            | "provisioning"
            | "building"
            | "build_complete";
        base_blueprint_id?: string
        | null;
        build_finish_time_ms?: number | null;
        containerized_services?: BlueprintView.ContainerizedService[] | null;
        devbox_capabilities?: ("unknown" | "docker_in_docker")[] | null;
        failure_reason?: "out_of_memory" | "out_of_disk" | "build_failed" | null;
        is_public?: boolean;
        metadata?: { [key: string]: string } | null;
    }
    Index

    Properties

    id create_time_ms name parameters state status base_blueprint_id? build_finish_time_ms? containerized_services? devbox_capabilities? failure_reason? is_public? metadata?

    Properties

    id: string

    The id of the Blueprint.

    create_time_ms: number

    Creation time of the Blueprint (Unix timestamp milliseconds).

    name: string

    The name of the Blueprint.

    parameters: BlueprintBuildParameters

    The parameters used to create Blueprint.

    state: "deleted" | "created"

    The state of the Blueprint.

    status: "queued" | "failed" | "provisioning" | "building" | "build_complete"

    The status of the Blueprint build.

    base_blueprint_id?: string | null

    The ID of the base Blueprint.

    build_finish_time_ms?: number | null

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

    containerized_services?: BlueprintView.ContainerizedService[] | null

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

    devbox_capabilities?: ("unknown" | "docker_in_docker")[] | null

    Capabilities that will be available on Devbox.

    failure_reason?: "out_of_memory" | "out_of_disk" | "build_failed" | null

    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.

    is_public?: boolean

    Whether this Blueprint is publicly accessible to all users.

    metadata?: { [key: string]: string } | null

    User defined metadata associated with the blueprint.

    Settings

    Member Visibility

    On This Page

    Properties