Hosts

Hosts are physical servers in private cloud environments. You can view host statistics including CPU and memory usage, and manage host descriptions.

Host management is available for private cloud customers with dedicated hardware. CPU idle values are given as a percentage (average over 15 minutes for list, point-in-time for details), and free memory is reported in gigabytes.

GET/1.3/host

List hosts

Returns a list of all available hosts in your private cloud, along with basic statistics.

Query parameters

Name
zone
Type
string
Description
Filter by private cloud zone.

Response fields

Name
id
Type
integer
Description
Host identifier.
Name
description
Type
string
Description
Host description.
Name
zone
Type
string
Description
Private cloud zone identifier.
Name
windows_enabled
Type
string
Description
Whether Windows is enabled: "yes" or "no".
Name
stats
Type
object
Description
Host statistics including cpu_idle and memory_free.

Request

GET

/1.3/host

curl -X GET https://api.upcloud.com/1.3/host \
  -u your_username:your_password

GET/1.3/host/{host_id}

Get host details

Returns detailed information about a specific host including current statistics.

Request

GET

/1.3/host/{host_id}

curl -X GET https://api.upcloud.com/1.3/host/7653311107 \
  -u your_username:your_password

PATCH/1.3/host/{host_id}

Modify host

Modifies the description of a specific host.

Attributes

Name
description
Type
string
Description
New description for the host.

Request

PATCH

/1.3/host/{host_id}

curl -X PATCH https://api.upcloud.com/1.3/host/7653311107 \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "host": {
      "description": "Production Database Host"
    }
  }'