Preview Dockerfile definition for a Blueprint.

API Reference

Introduction

Devbox

The Devbox Object
Devbox Lifecycle
Devbox File Tools
Devbox Shell Tools
Devbox Network Tools
Devbox Persistence Tools
Devbox Observability Tools
Devbox Add-ons

Blueprint

The Blueprint Object
Blueprint Lifecycle
Blueprint Observability
- GET
  Get Blueprint build logs.
- POST
  Preview Dockerfile definition for a Blueprint.

Repository

The Repository Object
Repository Lifecycle

Code Scenario

Code Scenario Lifecycle
Scenarios Runs
Custom Scenario Scorer
Public Scenarios

Benchmark

Benchmark Lifecycle
Benchmark Runs
Public Benchmarks

POST

blueprints

preview

import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

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

  console.log(blueprintPreviewView.dockerfile);
}

main();

{
  "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..

Response

200 - application/json

dockerfile

string

required

The Dockerfile contents that will built.

Was this page helpful?

Get Blueprint build logs.The Repository Object

import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

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

  console.log(blueprintPreviewView.dockerfile);
}

main();

{
  "dockerfile": "<string>"
}