Skip to main content
GET
List servers a bandwidth block can be assigned to

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

bandwidthBlock
string
required

The bandwidth block UUID

Example:

"23653478-238e-4db3-b263-91a221b5e7c2"

Response

The whole set, as a JSON array. There is no envelope and no paging.

id
string
required

The short uuid, which is what an attach names the machine by.

Example:

"ecc6f4f1"

uuid
string
required

The uuid UUID.

Example:

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

name
string
required

The name shown to customers.

Example:

"lambda-core"

hostname
string
required

The fully qualified hostname.

Example:

"lambda-core.blackmesa.example.com"

template_name
string | null
required

What the picker paints the machine with, the same as the dashboard.

Example:

"Ubuntu 24.04"

template_icon_url
string | null
required

The value of template_icon_url.

Example:

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

windows
boolean
required

The value of windows.

Example:

false

address
string | null
required

The machine's primary IPv4, so the picker names it the way a customer does.

Example:

"203.0.113.24"

location
string
required

The city, by display name.

Example:

"Kansas City, MO"

bandwidth_limit
integer
required

The value of bandwidth_limit.

Example:

5497558138880

bandwidth_usage
integer
required

The value of bandwidth_usage.

Example:

500000000000

exhausted
boolean
required

The value of exhausted.

Example:

false

Example: