2024.11.0
Home ▸ Integrations ▸

Ombi

The Ombi integration monitors data from your Ombi instance.

Setup

This integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] needs to authenticate to your Ombi instance with either a user password or an api_key.

To find your api_key open the Ombi web interface. Navigate to Settings and then to Ombi, you should then be able to see your api_key.

If you want to use password authentication simply use the same password you normally use to login to Ombi. Alternatively, you can set up a separate local account in Ombi designated for Home Assistant. In order to do this, open the Ombi web interface. Navigate to User Management and then press Add User To Ombi. Input your desired user details and use the same details when configuring this integration.

Configuration

If you want to enable this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], add the following lines 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
ombi:
  host: OMBI_HOST
  username: OMBI_USERNAME
  password: OMBI_PASSWORD

Configuration Variables

Looking for your configuration file?
host string Required

The hostname or IP Address Ombi is running on.

username string Required

Your Ombi username.

password string (Exclusive)

Your Ombi password. password and api_key cannot be specified concurrently.

api_key string (Exclusive)

Your Ombi API key. password and api_key cannot be specified concurrently.

port integer (Optional, default: 5000)

The port Ombi is running on.

urlbase string (Optional)

The Base URL path of your Ombi instance.

ssl boolean (Optional, default: false)

Whether or not to use SSL when connecting to Ombi.

Full example for the configuration 

# Example configuration.yaml entry
ombi:
  host: OMBI_HOST
  username: OMBI_USERNAME
  api_key: OMBI_API_KEY
  port: OMBI_PORT
  urlbase: ombi/
  ssl: true

Actions

Submit request actions

Available actions: submit_movie_request, submit_music_request, submit_tv_request

Action submit_movie_request

Searches and requests the closest matching movie.

Data attribute Optional Description
name no Search parameter.

Action submit_music_request

Searches and requests the closest matching music album.

Data attribute Optional Description
name no Search parameter.

Action submit_tv_request

Searches and requests the closest matching TV show.

Data attribute Optional Description
name no Search parameter.
season yes Which season(s) to request. Must be one of first, latest or all. Defaults to latest.

Related topics