home-assistant.io/source/_integrations/digital_ocean.markdown
2024-11-27 18:57:16 +01:00

2.6 KiB

title description ha_category ha_release ha_iot_class ha_codeowners ha_domain ha_platforms ha_integration_type related ha_quality_scale
Digital Ocean Instructions on how to integrate the Digital Ocean within Home Assistant.
Binary sensor
Switch
System monitor
0.30 Local Polling
@fabaff
digital_ocean
binary_sensor
switch
integration
docs title
/docs/configuration/ Configuration file
legacy

The Digital Ocean {% term integration %} allows you to access the information about your Digital Ocean droplets from Home Assistant.

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

Setup

Obtain your API key from your Digital Ocean dashboard.

Configuration

To integrate your Digital Ocean droplets with Home Assistant, add the following section to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# Example configuration.yaml entry
digital_ocean:
  access_token: YOUR_API_KEY

{% configuration %} access_token: description: Your Digital Ocean API access token. required: true type: string {% endconfiguration %}

Binary sensor

The digital_ocean binary sensor platform allows you to monitor your Digital Ocean droplets.

Configuration

To use your Digital Ocean droplets, you first have to set up your Digital Ocean hub and then add the following to your {% term "configuration.yaml" %} file:

# Example configuration.yaml entry
binary_sensor:
  - platform: digital_ocean
    droplets:
      - 'fedora-512mb-nyc3-01'
      - 'coreos-512mb-nyc3-01'

{% configuration %} droplets: description: List of droplets you want to monitor. required: true type: list {% endconfiguration %}

Switch

The digital_ocean switch platform allows you to control (start/stop) your Digital Ocean droplets.

Configuration

To use your Digital Ocean droplets, you first have to set up your Digital Ocean hub and then add the following to your {% term "configuration.yaml" %} file:

# Example configuration.yaml entry
switch:
  - platform: digital_ocean
    droplets:
      - 'fedora-512mb-nyc3-01'
      - 'coreos-512mb-nyc3-01'

{% configuration %} droplets: description: List of droplets you want to control. required: true type: list {% endconfiguration %}