Ports

​

Reserved ports

• 443: This port hosts the main sandbox API and is exposed via HTTPS
• 80: Reserved for system operations
• 8080: Reserved for sandbox API functionality

​

Expose a port

import { SandboxInstance } from "@blaxel/core";

// Create a new sandbox
const sandbox = await SandboxInstance.create({
  name: "my-sandbox",
  image: "blaxel/base-image:latest",
  memory: 4096,
  region: "us-pdx-1",
  ports: [{ target: 3000 }]
});

​

Access the sandbox on a specific port

​

Via the sandbox API

https://sbx-{resource_name}-{workspace_id}.{region_id}.bl.run/port/{port_number}

​

Via a preview URL

• for file and process management in your sandbox, use the sandbox API or SDK.
• to access running applications within the sandbox (such as a NextJS preview server on port 3000), use a preview URL instead.

​

Via SDK

import { SandboxInstance } from "@blaxel/core";

const sandbox = await SandboxInstance.get("my-sandbox");

// Fetch a resource on port 3000
const response = await sandbox.fetch(3000);
console.log(await response.text());

// Fetch with a specific path
const apiResponse = await sandbox.fetch(3000, "/api/health");
console.log(await apiResponse.json());

import { SandboxInstance } from "@blaxel/core";

// Connect to existing sandbox
const sandbox = await SandboxInstance.get("my-sandbox")

// Get URL for port access
const url = `${sandbox.metadata.url}/port/3000`

// Use the URL with authenticated requests
const response = await fetch(url, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN' }
})