2024.10.4
Home ▸ Integrations ▸

Vultr

The Vultr integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to access information about and interact with your Vultr subscriptions (Virtual Private Servers) from Home Assistant.

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

Configuration

Obtain your API key from your Vultr Account.

Important

Ensure you allow the public IP of Home Assistant under the Access Control heading.

To integrate your Vultr subscriptions with Home Assistant, add the following section to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry
vultr:
  api_key: YOUR_API_KEY

Configuration Variables

Looking for your configuration file?
api_key string Required

Your Vultr API key.

Binary sensor

The vultr binary sensor platform allows you to monitor your Vultr subscription to see if it is powered on or not.

Configuration

To use this binary sensor, you first have to set up your Vultr hub.

Note

The following examples assume a subscription that has an ID of 123456 and a label of Web Server

Minimal configuration.yaml (produces binary_sensor.vultr_web_server):

# Example configuration.yaml entry
binary_sensor:
  - platform: vultr
    subscription: 123456

Configuration Variables

Looking for your configuration file?
subscription string Required

The subscription you want to monitor, this can be found in the URL when viewing a server.

name string (Optional)

The name you want to give this binary sensor.

Default:

Vultr {subscription label}

Full example

Full configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] (produces binary_sensor.totally_awesome_server):

binary_sensor:
  - platform: vultr
    name: totally_awesome_server
    subscription: 12345

Sensor

The vultr sensor platform will allow you to view current bandwidth usage and pending charges against your Vultr subscription.

To use this sensor, you must set up your Vultr hub.

Note

The following examples assume a subscription that has an ID of 123456 and a label of Web Server

Minimal configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] (produces sensor.vultr_web_server_current_bandwidth_used and sensor.vultr_web_server_pending_charges):

sensor:
  - platform: vultr
    subscription: 123456

Configuration Variables

Looking for your configuration file?
subscription string Required

The Vultr subscription to monitor, this can be found in the URL when viewing a subscription.

name string (Optional)

The name to give this sensor.

Default:

Vultr {Vultr subscription label} {monitored condition name}

monitored_conditions list (Optional)

List of items you want to monitor for each subscription.

current_bandwidth_gb

The current (invoice period) bandwidth usage in Gigabytes (GB).

pending_charges

The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$).

Full configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] using {} to format condition name (produces sensor.server_current_bandwidth_gb and sensor.server_pending_charges):

sensor:
  - platform: vultr
    name: Server {}
    subscription: 123456
    monitored_conditions:
      - current_bandwidth_gb
      - pending_charges

Custom configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] with only one condition monitored (produces sensor.web_server_bandwidth):

sensor:
  - platform: vultr
    name: Web Server Bandwidth
    subscription: 123456
    monitored_conditions:
      - current_bandwidth_used

Switch

The vultr switch platform allows you to control (start/stop) your Vultr subscription.

To control your Vultr subscription, you first have to set up your Vultr hub.

Configuration

Minimal configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] (produces switch.vultr_web_server):

# Example configuration.yaml entry
switch:
  - platform: vultr
    subscription: YOUR_SUBSCRIPTION_ID

Configuration Variables

Looking for your configuration file?
subscription string Required

List of droplets you want to control.

name string (Optional)

The name you want to give this switch.

Default:

Vultr {subscription label}

Additional examples

Full example that produces switch.amazing_server, assuming a subscription that has an ID of 123456 and a label of Web Server:

# Example configuration.yaml entry
switch:
  - platform: vultr
    name: Amazing Server
    subscription: 123456

Related topics