POST
/
v1
/
blueprints
/
preview
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: 'My Bearer Token',
});

const blueprintPreviewView = await client.blueprints.preview({ name: 'name' });

console.log(blueprintPreviewView.dockerfile);
{
  "dockerfile": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name of the Blueprint.

​
dockerfile
string | null

Dockerfile contents to be used to build the Blueprint.

​
system_setup_commands
string[] | null

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

​
code_mounts
object[] | null

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

​
launch_parameters
object

Parameters to configure your Devbox at launch time.

​
file_mounts
object | null

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

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

​
services
object[] | 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.

​
metadata
object | null

(Optional) User defined metadata for the Blueprint.

Response

200 - application/json

OK

​
dockerfile
string
required

The Dockerfile contents that will built.