2024.12.5
Home ▸ Integrations ▸

SABnzbd

The SABnzbd integration will allow you to monitor and control your downloads with SABnzbd from within Home Assistant and setup automations based on the information.

Prerequisites

You need to grab your API key from your SABnzbd instance in order to configure this integration:

  • Navigate to your SABnzbd.
  • Click “Config”, then click “General”.
  • Copy your API key under “Security”.

Configuration

To add the SABnzbd integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

URL

The full URL, including port, of your SABnzbd server. Example: http://localhost:8080 or http://a02368d7-sabnzbd:8080, if you are using the add-on.

API key

The API key of your SABnzbd server. You can find this in the SABnzbd web interface under Config cog (top right) > General > Security.

Sensor

This integration will create these sensors:

  • status: The current status of SABnzbd. (Idle, Paused, etc.)
  • speed: The current download speed.
  • queue: The total size of the download queue.
  • left: The remaining size of the download queue.
  • disk: The total disk size at SABnzbd’s download location.
  • disk_free: The available disk space at SABnzbd’s download location.
  • queue_count: The number of items in the download queue.
  • total: Total GB downloaded.
  • daily_total: GB downloaded today. (disabled by default)
  • weekly_size: GB downloaded this week. (disabled by default)
  • monthly_total: GB downloaded this month. (disabled by default)

Binary sensor

This integration will create a binary sensor to indicate if SABnzbd has recorded any warnings or errors.

Button

This integration will create two buttons:

  • Pause the download queue.
  • Resume the download queue.

Number

This integration will create a number entity to set the download queue speed limit in percentage.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three-dot menu. Then, select Delete.