UpCloud


The upcloud component allows you to access the information about your UpCloud servers from Home Assistant.

There is currently support for the following device types within Home Assistant:

Setup

Set up your API user credentials in your UpCloud control panel.

Configuration

To integrate your UpCloud servers with Home Assistant, add the following section to your configuration.yaml file:

# Example configuration.yaml entry
upcloud:
  username: YOUR_API_USERNAME
  password: YOUR_API_PASSWORD

Configuration Variables

username

(string)(Required)Your UpCloud API username.

password

(string)(Required)Your UpCloud API user password.

scan_interval

(integer)(Optional)Update interval in seconds.

Default value: 60

Binary Sensor

The upcloud binary sensor platform allows you to monitor your UpCloud servers.

To use your UpCloud servers, you first have to set up your UpCloud hub and then add the following to your configuration.yaml file:

# Example configuration.yaml entry
binary_sensor:
  - platform: upcloud
    servers:
      - 002167b7-4cb1-44b7-869f-e0900ddeeae1
      - 00886296-6137-4074-afe3-068e16d89d00

Configuration Variables

servers

(list)(Required)List of servers you want to monitor.

Switch

The upcloud switch platform allows you to control (start/stop) your UpCloud servers.

To use your UpCloud servers, you first have to set up your UpCloud hub and then add the following to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  - platform: upcloud
    servers:
      - 002167b7-4cb1-44b7-869f-e0900ddeeae1
      - 00886296-6137-4074-afe3-068e16d89d00

Configuration Variables

servers

(list)(Required)List of servers you want to control.