Get a server
Read a server's status by its external ID.
GET/api/application/servers/{externalId}
curl https://panel.example.com/api/application/servers/whmcs-1042 \
-H "Authorization: Bearer bpnl_..."Returns 200 OK with { "server": { ... } }, or 404 if no server has that external ID.
The server object
| Field | Type | Description |
|---|---|---|
id | string | BytePanel's ID for the server. |
externalId | string | Your ID. |
name | string | |
planId | string or null | |
status | string | See below. |
suspended | boolean | true while the server is suspended. |
deployed | boolean | true once the server is placed on a node. |
url | string | The server's page in the panel. |
userId | string | The owner's account ID. |
uuid | string | The server's UUID on its node. |
Status
| Value | Meaning |
|---|---|
installing | The game is being installed. |
installed | Installed and ready. The server may be running or stopped. |
install_failed | The install script failed. The owner can reinstall from the panel. |
reinstall_failed | A reinstall failed. |
restoring_backup | A backup is being restored. |
suspended | Suspended. |