home-assistant.io/source/_integrations/upcloud.markdown

title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain

title	description	ha_category	ha_release	ha_iot_class	ha_codeowners	ha_domain
UpCloud	Instructions on how to integrate UpCloud within Home Assistant.	System Monitor Binary Sensor Switch	0.65	Cloud Polling	@scop	upcloud

The upcloud integration 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:

• Binary Sensor
• Switch

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 %} username: description: Your UpCloud API username. required: true type: string password: description: Your UpCloud API user password. required: true type: string scan_interval: description: Update interval in seconds. required: false type: integer default: 60 {% endconfiguration %}

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 %} servers: description: List of servers you want to monitor. required: true type: list {% endconfiguration %}

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 %} servers: description: List of servers you want to control. required: true type: list {% endconfiguration %}