Skip to Content
BytePanelBytePanel

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

FieldTypeDescription
idstringBytePanel's ID for the server.
externalIdstringYour ID.
namestring
planIdstring or null
statusstringSee below.
suspendedbooleantrue while the server is suspended.
deployedbooleantrue once the server is placed on a node.
urlstringThe server's page in the panel.
userIdstringThe owner's account ID.
uuidstringThe server's UUID on its node.

Status

ValueMeaning
installingThe game is being installed.
installedInstalled and ready. The server may be running or stopped.
install_failedThe install script failed. The owner can reinstall from the panel.
reinstall_failedA reinstall failed.
restoring_backupA backup is being restored.
suspendedSuspended.
Edit on GitHub

On this page