Skip to main content
GET
Get a server

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"

Query Parameters

include
string

Related records to include, with multiple values separated by commas.

Example:

"user"

Response

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

A server and its current configuration and status.

id
string
required

The short uuid. This is what every customer-facing URL is keyed by.

Example:

"ecc6f4f1"

uuid
string
required

The uuid UUID.

Example:

"ecc6f4f1-c89b-4dce-a20b-a330641c5b0b"

hostname
string
required

The fully qualified hostname.

Example:

"lambda-core.blackmesa.example.com"

name
string
required

The name shown to customers.

Example:

"lambda-core"

description
string | null
required

An optional description shown to customers.

Example:

"Lambda Complex test chamber telemetry"

status
enum<string> | null
required

A pending server operation, or null when there is none. starting and stopping clear when the power command finishes.

Available options:
installing,
install_failed,
suspended,
restoring_backup,
restoring_snapshot,
snapshotting,
deleting,
deletion_failed,
upgrading,
migrating,
starting,
stopping,
null
Example:

null

suspension_reason
string | null
required

Why the hold above is on, in the words of whoever put it on, or null where no reason was given. Only ever set alongside suspended: it is cleared when the suspension is lifted. Show it to the customer - it is written for them, and it is the difference between a machine that says it is suspended and one that says what to do about it.

Example:

null

power_state
enum<string> | null
required

The value of power_state.

Available options:
running,
stopped,
paused,
null
Example:

"running"

windows
boolean
required

The value of windows.

Example:

false

template_name
string | null
required

The value of template_name.

Example:

"Ubuntu 24.04"

template_icon_url
string | null
required

The icon actually in force: the customer's own pick where they have made one, otherwise the artwork snapshotted from the template.

Example:

"https://img.icons8.com/color/48/ubuntu.png"

custom_icon_url
string | null
required

The raw override, so a form can tell a pick from a default.

Example:

null

default_icon_url
string | null
required

What the icon falls back to if that override is cleared.

Example:

"https://img.icons8.com/color/48/ubuntu.png"

created_at
string
required

The date and time for created at, in UTC.

Example:

"2026-03-02T19:14:36.000000Z"

usages
ServerUsagesData · object
required

The value of usages.

Example:
limits
ServerLimitsData · object
required

The value of limits.

Example:
internal_id
integer
required

The primary key. See the note on id above.

Example:

4821

restoration_progress
integer | null
required

The value of restoration_progress.

Example:

null

installation_progress
integer | null
required

The value of installation_progress.

Example:

null

install_failed_at
string | null
required

Set only while the last install or rebuild is still an unread failure: cleared by the next attempt, and by the customer dismissing the notice it draws.

Example:

null

cpu_throttle
ServerCpuThrottleData · object | null
required

The value of cpu_throttle.

Example:

null

bandwidth
ServerBandwidthData · object | null
required

What the server's transfer really looks like once purchased blocks and pooling exist. Null, like cpu_throttle above it, whenever the plan's own allowance is the whole story.

Example:

null

provisioning_scripts_supported
boolean
required

The value of provisioning_scripts_supported.

Example:

true

snapshots_supported
boolean
required

Whether snapshot storage is available in this server's location.

Example:

true

maintenance
ServerMaintenanceData · object | null
required

Null unless maintenance that affects this server is planned or under way.

Example:

null

maintenance_events
ServerMaintenanceData · object[]
required

Every maintenance or incident that affects this server, most pressing first. maintenance is the first of these.

Example:
location
string
required

The city the server stands in, e.g. "Nuremberg, DE". A location is a city now; displayName() also reads back the older codes that carried the product alongside it in brackets.

Example:

"Kansas City, MO"

product_group_name
string | null
required

The product the server was sold as, such as Standard VPS, or null when no product is linked.

Example:

"Standard VPS"

user
AccountOwnerData · object

The account the server belongs to, present only when a caller asked for it by name.

Example: