List box

JavaScript

import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  const boxes = await gboxSDK.list();

  boxes.operators.forEach((operator) => {
    console.log(operator.data.id);
  });

  const boxInfo = await gboxSDK.listInfo();

  boxInfo.data.forEach((item) => {
    console.log(item.id);
  });
}

main();

{
  "total": 100,
  "page": 1,
  "pageSize": 10,
  "data": [
    {
      "id": "c9bdc193-b54b-4ddb-a035-5ac0c598d32d",
      "type": "linux",
      "status": "running",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:35:00.000Z",
      "expiresAt": "2024-01-15T10:40:00.000Z",
      "config": {
        "os": {
          "version": "ubuntu-20.04"
        },
        "workingDir": "/home/user",
        "labels": {
          "environment": "development"
        },
        "envs": {
          "NODE_ENV": "production"
        },
        "cpu": 2,
        "memory": 1024,
        "storage": 30
      }
    },
    {
      "id": "f7e8a2c1-9d4e-4b3a-8c6f-1e5d7a9b2c4e",
      "type": "android",
      "status": "pending",
      "createdAt": "2024-01-15T10:32:00.000Z",
      "updatedAt": "2024-01-15T10:32:00.000Z",
      "expiresAt": "2024-01-15T10:47:00.000Z",
      "config": {
        "os": {
          "version": "12"
        },
        "deviceType": "virtual",
        "workingDir": "/data/local/tmp",
        "labels": {
          "app": "mobile-testing"
        },
        "envs": {
          "ANDROID_HOME": "/opt/android-sdk"
        },
        "cpu": 2,
        "memory": 2048,
        "storage": 20
      }
    }
  ]
}

GET

boxes

JavaScript

import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  const boxes = await gboxSDK.list();

  boxes.operators.forEach((operator) => {
    console.log(operator.data.id);
  });

  const boxInfo = await gboxSDK.listInfo();

  boxInfo.data.forEach((item) => {
    console.log(item.id);
  });
}

main();

{
  "total": 100,
  "page": 1,
  "pageSize": 10,
  "data": [
    {
      "id": "c9bdc193-b54b-4ddb-a035-5ac0c598d32d",
      "type": "linux",
      "status": "running",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:35:00.000Z",
      "expiresAt": "2024-01-15T10:40:00.000Z",
      "config": {
        "os": {
          "version": "ubuntu-20.04"
        },
        "workingDir": "/home/user",
        "labels": {
          "environment": "development"
        },
        "envs": {
          "NODE_ENV": "production"
        },
        "cpu": 2,
        "memory": 1024,
        "storage": 30
      }
    },
    {
      "id": "f7e8a2c1-9d4e-4b3a-8c6f-1e5d7a9b2c4e",
      "type": "android",
      "status": "pending",
      "createdAt": "2024-01-15T10:32:00.000Z",
      "updatedAt": "2024-01-15T10:32:00.000Z",
      "expiresAt": "2024-01-15T10:47:00.000Z",
      "config": {
        "os": {
          "version": "12"
        },
        "deviceType": "virtual",
        "workingDir": "/data/local/tmp",
        "labels": {
          "app": "mobile-testing"
        },
        "envs": {
          "ANDROID_HOME": "/opt/android-sdk"
        },
        "cpu": 2,
        "memory": 2048,
        "storage": 20
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter your API Key in the format: Bearer . Get it from https://gbox.ai

Query Parameters

page

integer

default:1

Page number

Example:

1

pageSize

integer

default:10

Page size

Example:

10

status

enum<string>[]

Filter boxes by their current status (pending, running, stopped, error, terminated, all). Must be an array of statuses. Use 'all' to get boxes with any status.

Available options:

all,

pending,

running,

error,

terminated

Example:

["running"]

type

enum<string>[]

Filter boxes by their type (linux, android, all). Must be an array of types. Use 'all' to get boxes of any type.

Available options:

all,

linux,

android

Example:

["linux"]

labels

object

Filter boxes by their labels. Labels are key-value pairs that help identify and categorize boxes. Use this to filter boxes that match specific label criteria. For example, you can filter by project, environment, team, or any custom labels you've added to your boxes.

deviceType

string

Filter boxes by their device type (virtual, physical)

Example:

"virtual"

Response

200 - application/json

List box

Response containing paginated list of box instances

total

integer

required

Total number of items

Example:

100

page

integer

default:1

required

Page number

Example:

1

pageSize

integer

default:10

required

Page size

Example:

10

data

(Linux Box · object | Android Box · object)[]

required

A box instance that can be either Linux or Android type

Linux box instance with full configuration and status

Linux Box
Android Box

Show child attributes

data.id

string

required

Unique identifier for the box

Example:

"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

data.status

enum<string>

required

The current status of a box instance

Available options:

pending,

running,

error,

terminated

Example:

"running"

data.createdAt

string<date-time>

required

Creation timestamp of the box

Example:

"2024-01-15T10:30:00.000Z"

data.updatedAt

string<date-time>

required

Last update timestamp of the box

Example:

"2024-01-15T10:35:00.000Z"

data.expiresAt

string<date-time> | null

required

Expiration timestamp of the box

Example:

"2024-01-15T10:40:00.000Z"

data.type

enum<string>

default:linux

required

Box type is Linux

Available options:

linux

Example:

"linux"

data.config

LinuxBox · object

required

Configuration for a Linux box instance

Show child attributes

data.config.os

LinuxConfig · object

required

Operating system configuration

Show child attributes

data.config.os.version

string

required

OS version string (e.g. 'ubuntu-20.04')

Example:

"ubuntu-20.04"

Example:

{ "version": "ubuntu-20.04" }

data.config.workingDir

string

required

Working directory path for the box. This directory serves as the default starting point for all operations including command execution, code running, and file system operations. When you execute commands or run code, they will start from this directory unless explicitly specified otherwise.

Example:

"/home/user"

data.config.labels

LinuxConfig · object

required

Key-value pairs of labels for the box. Labels are used to add custom metadata to help identify, categorize, and manage boxes. Common use cases include project names, environments, teams, applications, or any other organizational tags that help you organize and filter your boxes.

Show child attributes

data.config.labels.{key}

string

Example:

{
  "project": "web-scraper",
  "environment": "production",
  "team": "backend",
  "version": "v1.2.0"
}

data.config.envs

LinuxConfig · object

required

Environment variables for the box. These variables will be available in all operations including command execution, code running, and other box behaviors

Show child attributes

data.config.envs.{key}

string

Example:

{ "MY_ENV_KEY": "env value" }

data.config.cpu

number

required

CPU cores allocated to the box

Example:

2

data.config.memory

number

required

Memory allocated to the box in MiB

Example:

1024

data.config.storage

number

required

Storage allocated to the box in GiB.

Example:

30

data.config.publicIp

string

required

Public IP allocated to the box.

Example:

"8.8.8.8"

data.config.deviceType

enum<string>

default:container

Device type - container or vm Linux device

Available options:

container,

vm

Example:

"container"

data.config.snapshotName

string

Snapshot name

data.config.snapshotId

string

Snapshot id

Example:

{
  "os": { "version": "ubuntu-20.04" },
  "deviceType": "physical",
  "workingDir": "/home/user",
  "labels": {
    "environment": "development",
    "team": "qa"
  },
  "envs": {
    "NODE_ENV": "production",
    "PATH": "/usr/bin:/bin"
  },
  "cpu": 2,
  "memory": 1024,
  "storage": 30
}

data.reason

string | null

The reason for the current status, if any

Example:

"Box terminated by user"

Example:

[
  {
    "id": "c9bdc193-b54b-4ddb-a035-5ac0c598d32d",
    "type": "linux",
    "status": "running",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:35:00.000Z",
    "expiresAt": "2024-01-15T10:40:00.000Z",
    "config": {
      "os": { "version": "ubuntu-20.04" },
      "workingDir": "/home/user",
      "labels": { "environment": "development" },
      "envs": { "NODE_ENV": "production" },
      "cpu": 2,
      "memory": 1024,
      "storage": 30
    }
  },
  {
    "id": "f7e8a2c1-9d4e-4b3a-8c6f-1e5d7a9b2c4e",
    "type": "android",
    "status": "pending",
    "createdAt": "2024-01-15T10:32:00.000Z",
    "updatedAt": "2024-01-15T10:32:00.000Z",
    "expiresAt": "2024-01-15T10:47:00.000Z",
    "config": {
      "os": { "version": "12" },
      "deviceType": "virtual",
      "workingDir": "/data/local/tmp",
      "labels": { "app": "mobile-testing" },
      "envs": { "ANDROID_HOME": "/opt/android-sdk" },
      "cpu": 2,
      "memory": 2048,
      "storage": 20
    }
  }
]

Create linux box Terminate box

⌘I

Model

Box

UI Action

Run Code

Command

File System

Browser

Android

Media

Authorizations

Query Parameters

Response