Skip to main content
GET
Get a server's live status

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

server
string
required

The server UUID

Example:

"ecc6f4f1"

Response

The record, as a JSON object. There is no envelope.

state
enum<string>
required

The billing state, province, or region, or null or an empty string to clear it.

Available options:
stopped,
running,
stopping,
starting,
shutting_down,
restarting
Example:

"running"

cpu_used
number
required

The value of cpu_used.

Example:

0.22

memory_total
integer
required

The value of memory_total.

Example:

4294967296

memory_used
integer
required

The value of memory_used.

Example:

2164260864

uptime
integer
required

The value of uptime.

Example:

1134000

lock
string | null
required

The value of lock.

Example:

null

qmp_state
string | null
required

The value of qmp_state.

Example:

"running"