Add URL

The Add URL action subscribes AdGuard Home to a new filter list. AdGuard Home downloads the rules from the URL you provide and starts blocking the domains on that list.

This is handy when you want to bring an extra blocklist online only when you need it, for example a stricter list during exam week or a seasonal list around the holidays, instead of adding it by hand in the AdGuard Home interface.

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 add a filter subscription 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 AdGuard Home: Add URL.
6. Enter a Name for the subscription and the URL of the filter list.
7. 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 adguard.add_url. A basic example looks like this:

action: adguard.add_url
data:
  name: "Example blocklist"
  url: "https://www.example.com/filter/1.txt"

This subscribes AdGuard Home to the filter list at the given URL.

Options in YAML

Good to know

• A newly added subscription is enabled right away.
• AdGuard Home does not block on the new rules until it has downloaded the list. To apply them immediately, follow this action with Refresh.

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.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: add a stricter blocklist during study time

When study time starts, subscribe to an extra blocklist and refresh AdGuard Home so the rules take effect right away.

• Trigger: A study-time helper turns on
• Action: AdGuard Home: Add URL, followed by AdGuard Home: Refresh

alias: "Add study-time blocklist"
triggers:
  - trigger: state
    entity_id: input_boolean.study_time
    to: "on"
actions:
  - action: adguard.add_url
    data:
      name: "Study-time blocklist"
      url: "https://www.example.com/study-blocklist.txt"
  - action: adguard.refresh

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:

• Remove URL: Removes a filter subscription from AdGuard Home.

• Enable URL: Enables a filter subscription in AdGuard Home.

• Disable URL: Disables a filter subscription in AdGuard Home.

• Refresh: Refreshes all filter subscriptions in AdGuard Home.