POST
/
v1
/
blueprints
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 blueprintView = await client.blueprints.create({ name: 'name' });

  console.log(blueprintView.id);
}

main();
{
  "id": "<string>",
  "name": "<string>",
  "status": "provisioning",
  "state": "created",
  "create_time_ms": 123,
  "parameters": {
    "name": "<string>",
    "dockerfile": "<string>",
    "system_setup_commands": [
      "<string>"
    ],
    "code_mounts": [
      {
        "repo_name": "<string>",
        "repo_owner": "<string>",
        "install_command": "<string>",
        "token": "<string>"
      }
    ],
    "launch_parameters": {
      "launch_commands": [
        "<string>"
      ],
      "resource_size_request": "X_SMALL",
      "keep_alive_time_seconds": 123,
      "available_ports": [
        123
      ],
      "after_idle": {
        "idle_time_seconds": 123,
        "on_idle": "shutdown"
      },
      "custom_cpu_cores": 123,
      "custom_gb_memory": 123,
      "architecture": "x86_64",
      "user_parameters": {
        "username": "<string>",
        "uid": 123
      }
    },
    "file_mounts": {}
  },
  "failure_reason": "out_of_memory"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Response

200 - application/json
OK

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.