Get disk space

Use this action to retrieve the disk space information for all storage locations configured in Sonarr.

This action returns its result in a response variable, which you can use in later steps of the same automation or script, for example to warn yourself when free space runs low.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get the disk space information from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select Sonarr: Get disk space.
6. Select the Sonarr entry to query and optionally a Space unit.
7. In the Response variable field, enter a name to store the disk space data in, such as disk_data.
8. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as sonarr.get_diskspace. Store the result in a response variable so you can use it in later steps:

action: sonarr.get_diskspace
data:
  entry_id: "01234567890abcdef1234567890abcde"
  space_unit: GB
response_variable: disk_data

This fetches the disk space information, with the values expressed in gigabytes.

Options in YAML

Response data

The response contains a disks key with a mapping of disk information keyed by path. Each disk includes the following fields:

• path: The storage path.
• label: The disk label, if available.
• free_space: Free space in the selected unit.
• total_space: Total space in the selected unit.
• unit: The unit used for the space values.
• usage_percent: Percentage of disk space used.

A shortened example of the response looks like this:

disks:
  "/mnt/media":
    path: "/mnt/media"
    label: "Media Storage"
    free_space: 1862.65
    total_space: 3725.29
    unit: "GB"
    usage_percent: 50.0

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Get series: Retrieves all series in your Sonarr library with their details and statistics.

• Get queue: Retrieves the episodes currently in the Sonarr download queue with their progress and details.