Remove torrent

Use this action to remove a torrent from Transmission. You can optionally delete the downloaded data along with the torrent.

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 remove a torrent 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 Transmission: Remove torrent.
  6. Select your Transmission entry and enter the ID of the torrent.
  7. Select Save.

This action does not support targets. In the UI, you select the Transmission integration through the Transmission entry field instead of choosing an area, device, entity, or label.

Options in the UI

Transmission entry (Required)

The Transmission integration entry the torrent belongs to.

ID (Required)

The ID of the torrent. You can find it with the Get torrents action or in the torrent_info attribute of the *_torrents sensors.

Delete data (Optional)

Whether to also delete the downloaded data. When off, only the torrent is removed and the data stays on disk.

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. For how an automation or a script is built in YAML, refer to Automations in YAML and Scripts.

In YAML, refer to this action as transmission.remove_torrent. A basic example looks like this:

ActionAn action makes Home Assistant do something, for example, turn on a light, send a notification, or activate a scene. Automations and scripts run a list of actions. [Learn more]
action: transmission.remove_torrent
data:
  entry_id: YOUR_TRANSMISSION_ENTRY_ID
  id: 123

Options in YAML

entry_id string Required

The Transmission integration entry the torrent belongs to.

id integer Required

The ID of the torrent. You can find it with the Get torrents action or in the torrent_info attribute of the *_torrents sensors.

delete_data boolean (Optional, default: false)

Whether to also delete the downloaded data. When off, only the torrent is removed and the data stays on disk.

Try it yourself

Ready to test this? Open Settings > 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.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup. In the visual editor, select the UI options listed in the example or paste the YAML code.

Tip

You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the visual automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.

Automation: remove finished torrents that are labeled for removal

This automation listens for the Transmission download-complete event and removes the torrent, but keeps the downloaded data, when it carries the Remove label.

  • Trigger: Manual event received
    • Event type: transmission_downloaded_torrent
  • Action: Transmission: Remove torrent
YAML example for removing labeled torrents on completion
AutomationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more]
alias: "Remove labeled torrent on completion"
triggers:
  - trigger: event
    event_type: transmission_downloaded_torrent
conditions: "{{ 'Remove' in trigger.event.data.labels }}"
  - action: transmission.remove_torrent
    data:
      entry_id: YOUR_TRANSMISSION_ENTRY_ID
      id: "{{ trigger.event.data.id }}"
      delete_data: false

Still stuck?

To test the action on its own, run it in the automation editor with Run action, and check the message that it shows. To see what the action did when the automation ran, open the trace of that run. For details, refer to Testing automations. For common problems and their solutions, refer to Troubleshooting automations.

If that doesn’t help, 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.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

Explore related actions:

  • Add torrent: Adds a new torrent to download in Transmission.

  • Get torrents: Returns the current torrents in Transmission.