CrownPanel CLI App
CrownPanel API
CrownPanel CLI App
CrownPanel API

Command List

Listing All VMs

Pretty Output
JSON Output
Command
crownpanel-cli vm list
Example Output
+-------+---------+-------------------------+-----------------+----------------------------+----------------+----------+----------+-----------+
| VMID  | STATUS  |        HOSTNAME         |   IP ADDRESS    |          LOCATION          | VIRTUALIZATION | RAM (MB) | HDD (GB) | CPU CORES |
+-------+---------+-------------------------+-----------------+----------------------------+----------------+----------+----------+-----------+
|  1111 | Offline | test.vps.com            | 185.243.114.134 | Frankfurt, Germany         | KVM            |     6144 |       50 |         6 |
|  2222 | Online  | vps.server.com          | 104.200.67.114  | Los Angeles, CA            | KVM            |     2048 |       40 |         3 |
+-------+---------+-------------------------+-----------------+----------------------------+----------------+----------+----------+-----------+

Specific VM Information

Pretty Output
JSON Output
Command
crownpanel-cli vm info 2222
Example Output
user@home ~ # crownpanel-cli vm info 2222
+----------------+-----------------+
|     FIELD      |      VALUE      |
+----------------+-----------------+
| VMID           |            2222 |
| Status         | Online          |
| Hostname       | vps.server.com  |
| IP Address     | 104.200.67.114  |
| Location       | Los Angeles, CA |
| Virtualization | KVM             |
| RAM (MB)       |            2048 |
| HDD (GB)       |              40 |
| CPU Cores      |               3 |
+----------------+-----------------+

Boot/Shutdown/Reboot/Hard Reboot

Pretty Output
JSON Output
Possible Errors
Boot Command
crownpanel-cli vm boot 2222
Shutdown Command
crownpanel-cli vm shutdown 2222
Reboot Command
crownpanel-cli vm reboot 2222
Hard Reboot Command
crownpanel-cli vm hard_reboot 2222
Example Output
user@home ~ # crownpanel-cli vm boot 53790
✅ query_status: Success | Success, Task Added. Please wait for 1-2 minutes for it to complete.

Specific VM Information

Pretty Output
JSON Output
Command
crownpanel-cli vm info 2222
Example Output
user@home ~ # crownpanel-cli vm info 2222
+----------------+-----------------+
|     FIELD      |      VALUE      |
+----------------+-----------------+
| VMID           |            2222 |
| Status         | Online          |
| Hostname       | vps.server.com  |
| IP Address     | 104.200.67.114  |
| Location       | Los Angeles, CA |
| Virtualization | KVM             |
| RAM (MB)       |            2048 |
| HDD (GB)       |              40 |
| CPU Cores      |               3 |
+----------------+-----------------+

VM Task Log

Pretty Output
JSON Output
Command
crownpanel-cli vm task-log 2222
Example Output
user@home ~ # crownpanel-cli vm task-log 2222
+---------+--------------------------------+---------------------+----------+
| TASK ID |              TASK              |      ADDED ON       |  STATUS  |
+---------+--------------------------------+---------------------+----------+
| 3274223 | Restart VNC                    | 2025-08-11 22:08:12 | Complete |
| 3274197 | Change CPU Mode                | 2025-08-11 22:00:22 | Complete |
|         | [host-passthrough]             |                     |          |
| 3169925 | Hard Reboot                    | 2025-07-26 18:31:53 | Complete |
| 3111091 | Hard Reboot                    | 2025-07-17 23:51:11 | Complete |
| 3104408 | Boot                           | 2025-07-16 22:18:34 | Complete |
| 3104319 | Boot                           | 2025-07-16 21:53:10 | Complete |
| 3104317 | Boot                           | 2025-07-16 21:52:54 | Complete |
| 3104308 | Boot                           | 2025-07-16 21:50:13 | Complete |
| 3104307 | Boot                           | 2025-07-16 21:50:00 | Complete |
| 3104302 | Boot                           | 2025-07-16 21:48:41 | Complete |
| 3102865 | Boot                           | 2025-07-16 15:26:10 | Complete |
| 3102860 | Shutdown                       | 2025-07-16 15:24:23 | Complete |
+---------+--------------------------------+---------------------+----------+

VM Bandwidth Usage

Pretty Output
JSON Output
Command
crownpanel-cli vm bandwidth-usage 2222
Example Output
user@home ~ # crownpanel-cli vm bandwidth-usage 2222
1719.99

VM Bandwidth Usage Percentage

Pretty Output
JSON Output
Command
crownpanel-cli vm bandwidth-usage-percentage 2222
Example Output
user@home ~ # crownpanel-cli vm bandwidth-usage-percentage 2222
0.1640625
ON THIS PAGE