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

    Interface BlueprintCreateParams

    Parameters for creating a new Blueprint.

    interface BlueprintCreateParams {
        name: string;
        base_blueprint_id?: string | null;
        base_blueprint_name?: string | null;
        build_args?: { [key: string]: string } | null;
        build_context?: BlueprintCreateParams.BuildContext | null;
        code_mounts?: CodeMountParameters[] | null;
        dockerfile?: string | null;
        file_mounts?: { [key: string]: string } | null;
        launch_parameters?: LaunchParameters | null;
        metadata?: { [key: string]: string } | null;
        network_policy_id?: string | null;
        secrets?: { [key: string]: string } | null;
        services?: BlueprintCreateParams.Service[] | null;
        system_setup_commands?: string[] | null;
    }
    Index

    Properties

    name base_blueprint_id? base_blueprint_name? build_args? build_context? code_mounts? dockerfile? file_mounts? launch_parameters? metadata? network_policy_id? secrets? services? system_setup_commands?

    Properties

    name: string

    Name of the Blueprint.

    base_blueprint_id?: string | null

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

    base_blueprint_name?: string | null

    (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.

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

    (Optional) Arbitrary Docker build args to pass during build.

    build_context?: BlueprintCreateParams.BuildContext | null

    A build context backed by an Object.

    code_mounts?: CodeMountParameters[] | null

    A list of code mounts to be included in the Blueprint.

    dockerfile?: string | null

    Dockerfile contents to be used to build the Blueprint.

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

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

    launch_parameters?: LaunchParameters | null

    Parameters to configure your Devbox at launch time.

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

    (Optional) User defined metadata for the Blueprint.

    network_policy_id?: string | null

    (Optional) ID of the network policy to apply during blueprint build. This restricts network access during the build process. This does not affect devboxes created from this blueprint; if you want devboxes created from this blueprint to inherit the network policy, set the network_policy_id on the blueprint launch parameters.

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

    (Optional) Map of mount IDs/environment variable names to secret names. Secrets will be available to commands during the build. Secrets are NOT stored in the blueprint image. Example: {"DB_PASS": "DATABASE_PASSWORD"} makes the secret 'DATABASE_PASSWORD' available as environment variable 'DB_PASS'.

    services?: BlueprintCreateParams.Service[] | null

    (Optional) List of containerized services to include in the Blueprint. These services will be pre-pulled during the build phase for optimized startup performance.

    system_setup_commands?: string[] | null

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

    Settings

    Member Visibility

    On This Page

    Properties