Skip to main content
GET
List servers that can join a private network

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

privateNetwork
string
required

The private network UUID

Example:

"5220f263-0e8e-4917-bf4f-4cae109ca4c5"

Response

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

id
string
required

The machine's uuid, which is what an attach names it by.

Example:

"304e1794-a5b7-41f2-9a20-c0d444eb6683"

uuid_short
string
required

The value of uuid_short.

Example:

"304e1794"

name
string
required

The name shown to customers.

Example:

"sector-c-db"

hostname
string
required

The fully qualified hostname.

Example:

"sector-c-db.blackmesa.example.com"

template_name
string | null
required

The value of template_name.

Example:

"Debian 13"

template_icon_url
string | null
required

The custom icon where the customer set one, the template's otherwise.

Example:

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

windows
boolean
required

The value of windows.

Example:

false

address
string | null
required

The machine's primary IPv4, so the picker matches other server selectors.

Example:

"203.0.113.57"

Example: