Skip to content

Device Management

List Devices

pb devices list / pb devices

List all devices associated with your account. Also aliased as pb devices (without subcommand).

Example:

bash
pb devices
text
CODE               STATUS         ONLINE   CONNECTED  STARTED_AT
IDY291LX6WW6RCW   running        yes      yes        2025-01-15T08:30:00Z
IDY2A0ZNVOR00ZK   stopped        no       -          -
json
{
  "code": 200,
  "data": {
    "devices": [
      {
        "id": "abc123",
        "device_code": "IDY291LX6WW6RCW",
        "plex_status": "running",
        "is_online": true,
        "connected": true,
        "started_at": "2025-01-15T08:30:00Z"
      }
    ]
  },
  "msg": "OK"
}

Create Device

pb devices create

Create a new cloud device.

Example:

bash
pb devices create
text
✓ Device created: IDY291LX6WW6RCW (creating)
json
{
  "code": 200,
  "data": {
    "device": {
      "id": "abc123",
      "device_code": "IDY291LX6WW6RCW",
      "status": "creating"
    }
  },
  "msg": "Device created"
}

Start Device

pb devices start [device_id]

Start a stopped device. If no device ID is provided, uses the currently connected or default device.

ParameterTypeRequiredDescription
device_idstringNoDevice ID or code. Defaults to connected device

Example:

bash
pb devices start IDY291LX6WW6RCW
text
✓ Device IDY291LX6WW6RCW: start (task_xxxx)
json
{
  "code": 200,
  "data": { "task_id": "task_xxxx" },
  "msg": "Device IDY291LX6WW6RCW: start"
}

Stop Device

pb devices stop [device_id]

Stop a running device.

ParameterTypeRequiredDescription
device_idstringNoDevice ID or code. Defaults to connected device

Example:

bash
pb devices stop IDY291LX6WW6RCW

Reboot Device

pb devices reboot [device_id] / pb reboot [device_id]

Reboot a device. Also available as a top-level shortcut: pb reboot [device_id].

ParameterTypeRequiredDescription
device_idstringNoDevice ID or code. Defaults to connected device

Example:

bash
pb reboot IDY291LX6WW6RCW

Factory Reset

pb devices reset [device_id]

Factory reset a device, erasing all data and restoring to the default state.

ParameterTypeRequiredDescription
device_idstringNoDevice ID or code. Defaults to connected device

DANGER

This operation is irreversible. All data on the device (installed apps, files, settings) will be permanently erased.

Example:

bash
pb devices reset IDY291LX6WW6RCW

Restore from Snapshot

pb devices restore [device_id] --snapshot <snapshot_id>

Restore a device from a snapshot.

ParameterTypeRequiredDescription
device_idstringNoDevice ID or code. Defaults to connected device
--snapshotstringYesSnapshot ID to restore from

Example:

bash
pb devices restore IDY291LX6WW6RCW --snapshot snap_abc123
text
✓ Device restored: IDY291LX6WW6RCW (task_xxxx)
json
{
  "code": 200,
  "data": { "task_id": "task_xxxx" },
  "msg": "Device restored: IDY291LX6WW6RCW"
}

Delete Device

pb devices delete <device_id>

Permanently delete a device.

ParameterTypeRequiredDescription
device_idstringYesDevice ID or code to delete

DANGER

This operation is irreversible. The device and all associated data will be permanently deleted.

Example:

bash
pb devices delete IDY2A0ZNVOR00ZK

Device Info

pb devices info [device_id]

Get detailed information about a device.

ParameterTypeRequiredDescription
device_idstringNoDevice ID or code. Defaults to connected device

Example:

bash
pb devices info IDY291LX6WW6RCW
text
Device:     IDY291LX6WW6RCW
Status:     running
Online:     yes
Started at: 2025-01-15T08:30:00Z
Spec:       4 CPU / 4096 MB RAM / 32768 MB Storage
json
{
  "code": 200,
  "data": {
    "id": "abc123",
    "device_code": "IDY291LX6WW6RCW",
    "plex_status": "running",
    "is_online": true,
    "started_at": "2025-01-15T08:30:00Z",
    "spec": { "cpu": 4, "memory": 4096, "storage": 32768 }
  },
  "msg": "OK"
}

Device Tasks

pb devices tasks [device_id]

View task history for a device.

ParameterTypeRequiredDescription
device_idstringNoDevice ID or code. Defaults to connected device

Example:

bash
pb devices tasks IDY291LX6WW6RCW