AdGuard Home

App · 25 actions

Control AdGuard Home, the network-wide ad and tracker blocker: pause protection and turn it back on, report its statistics, search the query log, block or allow domains, manage blocklists, DNS rewrites and clients, block services such as YouTube for one device, and turn safe search or parental control on or off. Start a workflow when protection is turned off or on, a domain is blocked or a new device appears.

Actions

ActionWhat it does
Add blocklistAdd a blocklist (or an allowlist) by its address.
Add clientAdd a persistent client: a device AdGuard Home knows by name, so it can have services blocked or settings of its own.
Add DNS rewriteAnswer a domain with an address of your choosing, such as nas.home with 192.168.1.20, as Add DNS rewrite does.
Block or allow domainBlock a domain, or always allow it, with a custom filtering rule: with all its subdomains or alone, for everyone or one device.
Block servicesBlock services such as YouTube or TikTok for everyone, or for one persistent client, as Blocked services does.
Check domainFind out what AdGuard Home would do with a domain, as Check the filtering does: blocked or not, by which rule and list, or rewritten.
Get statisticsGet AdGuard Home's numbers, as its Dashboard shows them: DNS queries, how many were blocked and what share, malware and adult websites blocked, and the top domains, blocked domains and clients.
Get statusFind out whether AdGuard Home's protection is on (and when a pause ends), its version, which of safe search, parental control and browsing security are on, and the services blocked for everyone.
List blocklistsList AdGuard Home's blocklists and allowlists, with how many rules each has, whether it's on and when it was last downloaded.
List clientsList AdGuard Home's persistent clients with their settings and blocked services, and, if you ask, the devices it found by itself.
List custom rulesList AdGuard Home's custom filtering rules, with the domain and device each is for, block or allow rules only, or those with some words.
List DNS rewritesList AdGuard Home's DNS rewrites: the domains it answers with an address of your choosing.
Remove blocklistRemove a blocklist or allowlist from AdGuard Home.
Remove clientRemove a persistent client from AdGuard Home; the device then follows AdGuard Home's settings.
Remove custom ruleTake a custom filtering rule out: the rule as written, or every rule for a domain.
Remove DNS rewriteRemove a domain's DNS rewrites, or only the one with the answer given.
Search query logFind recent DNS queries in AdGuard Home's Query Log, newest first: for a domain, from a device, blocked only (or any of the Query Log's filters), within the last few minutes.
Turn blocklist on or offTurn a blocklist or allowlist on or off, keeping it in AdGuard Home, as its Enabled tick does.
Turn off protectionPause AdGuard Home's protection for some minutes, such as for a site that won't load, or until it's turned back on, as Disable protection does.
Turn on protectionTurn AdGuard Home's protection back on, ending any pause.
Turn parental control on or offTurn AdGuard's parental control web service on or off for everyone, as Use AdGuard parental control web service under Settings > General settings does: it blocks adult websites.
Turn safe search on or offTurn safe search on or off for everyone, as Use Safe Search under Settings > General settings does: family-friendly results in Google, YouTube, Bing and other search engines.
Unblock servicesUnblock services for everyone, or for one persistent client.
Update blocklistsDownload AdGuard Home's blocklists and allowlists again, as Check for updates does, and say how many changed and which turned-on lists have no rules (which is how a failed download looks).
Update clientChange a persistent client: its name, identifiers, and whether it follows AdGuard Home's settings or has its own (filtering, parental control, browsing security, safe search).

Add blocklist

Add a blocklist (or an allowlist) by its address. AdGuard Home downloads it straight away and starts using it; an address it can't download isn't added. One already there is turned on.

Inputs

AddressaddresstextRequired
The list's web address, such as https://example.com/hosts.txt, or the full path of a file on the AdGuard Home server.
Namenametext
What to call it in AdGuard Home. Leave blank to use the address.
List typelist_typetext
A blocklist blocks what's on it; an allowlist never blocks it.One of: block (Blocklist), allow (Allowlist). Default: block.

Outputs

addresstext
Its web address, or the path of its file
already_listedtrue/false
True when AdGuard Home already had it; it's turned on
enabledtrue/false
True when it's turned on
idnumber
The list's ID in AdGuard Home
kindtext
block for a blocklist, allow for an allowlist
nametext
Its name
rulesnumber
How many rules it has
updated_attext
When it was last downloaded (ISO 8601, UTC)
Example output
{
  "address": "https://adguardteam.github.io/HostlistsRegistry/assets/filter_1.txt",
  "already_listed": false,
  "enabled": true,
  "id": 1,
  "kind": "block",
  "name": "AdGuard DNS filter",
  "rules": 188645,
  "updated_at": "2026-11-10T03:30:12Z"
}

Add client

Add a persistent client: a device AdGuard Home knows by name, so it can have services blocked or settings of its own. A client of that name already there is given these details.

Inputs

NamenametextRequired
What to call the device, such as Ben's tablet.
IdentifiersidentifierstextRequired
Its IP address, a range such as 192.168.1.0/24, its MAC address or a ClientID; several separated by commas.
Blocked servicesservicestext
Services to block for it alone, such as YouTube; several separated by commas. Leave blank to follow the services blocked for everyone.

Outputs

already_existedtrue/false
True when a client of that name was there; it was given these details
blocked_service_idslist
The same services, by ID
blocked_serviceslist
The services blocked for it alone, by name
filtering_enabledtrue/false
Its own setting: block with filters
identifierslist
Its IP addresses, ranges, MAC addresses or ClientIDs
nametext
The client's name
parental_control_enabledtrue/false
Its own setting: parental control
safe_browsing_enabledtrue/false
Its own setting: browsing security
safe_search_enabledtrue/false
Its own setting: safe search
tagslist
Its tags, such as device_tablet
uses_global_blocked_servicestrue/false
True when it follows the services blocked for everyone
uses_global_settingstrue/false
True when it follows AdGuard Home's settings
Example output
{
  "already_existed": false,
  "blocked_service_ids": [
    "youtube"
  ],
  "blocked_services": [
    "YouTube"
  ],
  "filtering_enabled": true,
  "identifiers": [
    "192.168.1.40"
  ],
  "name": "Ben's tablet",
  "parental_control_enabled": false,
  "safe_browsing_enabled": false,
  "safe_search_enabled": false,
  "tags": [
    "device_tablet"
  ],
  "uses_global_blocked_services": false,
  "uses_global_settings": true
}

Add DNS rewrite

Answer a domain with an address of your choosing, such as nas.home with 192.168.1.20, as Add DNS rewrite does. One already there isn't added twice.

Inputs

DomaindomaintextRequired
The domain, such as nas.home.arpa, or *.home.arpa for every domain under it.
AnsweranswertextRequired
An IP address, such as 192.168.1.20, or a domain to answer as. A or AAAA keeps the real answer of that kind.
Replace other answersreplacetrue/false
On to remove the domain's other rewrites, so this is its only answer.Default: false.

Outputs

already_listedtrue/false
True when the rewrite was already there
answertext
What it's answered with: an IP address or a domain
domaintext
The domain, or a wildcard such as *.example.lan
enabledtrue/false
True when the rewrite is turned on
replacedlist
The domain's other answers that were removed
Example output
{
  "already_listed": false,
  "answer": "192.168.1.20",
  "domain": "nas.home.arpa",
  "enabled": true,
  "replaced": []
}

Block or allow domain

Block a domain, or always allow it, with a custom filtering rule: with all its subdomains or alone, for everyone or one device. It takes out the opposite rule for the same domain, and adds nothing when the rule is already there.

Inputs

DomaindomaintextRequired
The domain, such as ads.example.com (a link works too), or the whole rule when Match is A rule written out in full.
Block or alloweffecttext
Block it, or allow it even when a blocklist has it.One of: block, allow. Default: block.
Matchmatchtext
The domain and all its subdomains, only this exact domain, or a rule in AdGuard Home's own syntax, such as /ads[0-9]+/.One of: subdomains (The domain and all its subdomains), exact (Only this exact domain), rule (A rule written out in full). Default: subdomains.
Only for clientdevicetext
Only for this device: its IP address, a range such as 192.168.1.0/24, or a persistent client's name. Leave blank for everyone.

Outputs

actiontext
What it does: block or allow (rewrite for a hosts-file line)
already_listedtrue/false
True when the rule was already there
clienttext
The device it's only for, if any: an IP address or a name
domaintext
The domain it's about; empty for a pattern or regex
matchtext
subdomains (the domain and all its subdomains), exact, or other for a pattern or a rule with other options
replacedtext
The opposite rule for the same domain and device that was taken out, if any
ruletext
The rule as AdGuard Home keeps it, such as ||ads.example.com^
Example output
{
  "action": "block",
  "already_listed": false,
  "client": "",
  "domain": "ads.example.com",
  "match": "subdomains",
  "replaced": "",
  "rule": "||ads.example.com^"
}

Block services

Block services such as YouTube or TikTok for everyone, or for one persistent client, as Blocked services does.

Inputs

ServicesservicestextRequired
The services, such as YouTube or TikTok; several separated by commas.
For clientdevicetext
Only for this persistent client. Leave blank for everyone.

Outputs

blocked_service_idslist
The same services, by ID
blocked_serviceslist
Every service blocked for them now, by name
changedlist
The services blocked or unblocked now, by name
clienttext
The client changed; empty when it was everyone
Example output
{
  "blocked_service_ids": [
    "tiktok",
    "youtube"
  ],
  "blocked_services": [
    "TikTok",
    "YouTube"
  ],
  "changed": [
    "YouTube"
  ],
  "client": "Ben's tablet"
}

Check domain

Find out what AdGuard Home would do with a domain, as Check the filtering does: blocked or not, by which rule and list, or rewritten. For everyone or one device.

Inputs

DomaindomaintextRequired
The domain, such as ads.example.com (a link works too).
Clientdevicetext
As this device would be answered: its IP address, ClientID or persistent client name.
Record typequery_typetext
The kind of DNS question, such as A (the default), AAAA or HTTPS.

Outputs

blockedtrue/false
True when AdGuard Home would block it
cnametext
The domain a DNS rewrite points it to, if one does
domaintext
The domain checked
reasontext
What AdGuard Home would do, in words
rewritten_tolist
The addresses a DNS rewrite answers with, if one does
ruleslist
The rules that match
servicetext
The blocked service it belongs to, if any
statustext
AdGuard Home's reason code, such as FilteredBlackList
Example output
{
  "blocked": true,
  "cname": "",
  "domain": "ads.example.com",
  "reason": "blocked by a filtering rule",
  "rewritten_to": [],
  "rules": [
    {
      "list_name": "AdGuard DNS filter",
      "rule": "||ads.example.com^"
    }
  ],
  "service": "",
  "status": "FilteredBlackList"
}

Get statistics

Get AdGuard Home's numbers, as its Dashboard shows them: DNS queries, how many were blocked and what share, malware and adult websites blocked, and the top domains, blocked domains and clients. For a daily or weekly report.

Inputs

For the last (hours)hoursnumber
Only the last this many hours, such as 24. Leave blank for everything AdGuard Home keeps (its Statistics retention).From 1 to 2160.
How many in each top listcountnumber
How many top domains and clients to list. Defaults to 10.From 1 to 100.

Outputs

average_msnumber
Average time to answer, in milliseconds
blocked_adultnumber
Queries for adult websites blocked by parental control
blocked_by_filtersnumber
Queries blocked by filters (lists, rules, services)
blocked_malwarenumber
Queries blocked as malware or phishing
hoursnumber
The hours the numbers cover
percent_blockednumber
The share blocked by filters, in percent, such as 12.5
safe_search_enforcednumber
Searches made safe by safe search
top_blocked_domainslist
The domains blocked most, most first
top_clientslist
The devices that asked most, most first
top_domainslist
The domains asked for most, most first
total_queriesnumber
DNS queries
Example output
{
  "average_ms": 12.4,
  "blocked_adult": 0,
  "blocked_by_filters": 3127,
  "blocked_malware": 2,
  "hours": 24,
  "percent_blocked": 12.8,
  "safe_search_enforced": 14,
  "top_blocked_domains": [
    {
      "domain": "doubleclick.net",
      "queries": 412
    }
  ],
  "top_clients": [
    {
      "client": "192.168.1.23",
      "queries": 6120
    }
  ],
  "top_domains": [
    {
      "domain": "www.google.com",
      "queries": 1203
    }
  ],
  "total_queries": 24518
}

Get status

Find out whether AdGuard Home's protection is on (and when a pause ends), its version, which of safe search, parental control and browsing security are on, and the services blocked for everyone.

Inputs

None.

Outputs

blocked_serviceslist
The IDs of the services blocked for everyone
dns_addresseslist
The addresses its DNS server answers on
filtering_enabledtrue/false
True when it blocks domains with its filters
parental_control_enabledtrue/false
True when its parental control is on
protectiontext
Whether AdGuard Home's protection is on or off
protection_enabledtrue/false
True while AdGuard Home is protecting
runningtrue/false
True while its DNS server is running
safe_browsing_enabledtrue/false
True when browsing security (malware, phishing) is on
safe_search_enabledtrue/false
True when it enforces safe search
timer_secondsnumber
Seconds until protection turns back on by itself; 0 when it stays as it is
turns_on_attext
When protection turns back on by itself (ISO 8601, UTC); empty when it stays
versiontext
AdGuard Home's version, such as v0.107.80
Example output
{
  "blocked_services": [
    "tiktok"
  ],
  "dns_addresses": [
    "192.168.1.2"
  ],
  "filtering_enabled": true,
  "parental_control_enabled": false,
  "protection": "on",
  "protection_enabled": true,
  "running": true,
  "safe_browsing_enabled": true,
  "safe_search_enabled": false,
  "timer_seconds": 0,
  "turns_on_at": "",
  "version": "v0.107.80"
}

List blocklists

List AdGuard Home's blocklists and allowlists, with how many rules each has, whether it's on and when it was last downloaded.

Inputs

List typelist_typetext
Only blocklists or only allowlists.One of: any (Either), block (Blocklist), allow (Allowlist). Default: any.

Outputs

countnumber
How many lists there are
listslist
Every blocklist and allowlist
Example output
{
  "count": 1,
  "lists": [
    {
      "address": "https://adguardteam.github.io/HostlistsRegistry/assets/filter_1.txt",
      "enabled": true,
      "id": 1,
      "kind": "block",
      "name": "AdGuard DNS filter",
      "rules": 188645,
      "updated_at": "2026-11-10T03:30:12Z"
    }
  ]
}

List clients

List AdGuard Home's persistent clients with their settings and blocked services, and, if you ask, the devices it found by itself.

Inputs

Searchsearchtext
Only those with these words in them.
Include runtime clientsinclude_runtimetrue/false
On to also list the devices AdGuard Home found by itself (Runtime clients).Default: false.

Outputs

clientslist
The persistent clients
countnumber
How many persistent clients are listed
runtime_clientslist
Devices AdGuard Home found by itself, when asked for
Example output
{
  "clients": [
    {
      "blocked_service_ids": [
        "youtube"
      ],
      "blocked_services": [
        "YouTube"
      ],
      "filtering_enabled": true,
      "identifiers": [
        "192.168.1.40"
      ],
      "name": "Ben's tablet",
      "parental_control_enabled": false,
      "safe_browsing_enabled": false,
      "safe_search_enabled": false,
      "tags": [
        "device_tablet"
      ],
      "uses_global_blocked_services": false,
      "uses_global_settings": true
    }
  ],
  "count": 1,
  "runtime_clients": [
    {
      "ip": "192.168.1.23",
      "name": "tv.lan",
      "source": "rDNS"
    }
  ]
}

List custom rules

List AdGuard Home's custom filtering rules, with the domain and device each is for, block or allow rules only, or those with some words.

Inputs

Block or alloweffecttext
Only block rules or only allow rules.One of: any (Either), block, allow. Default: any.
Searchsearchtext
Only those with these words in them.

Outputs

countnumber
How many rules are listed
ruleslist
The custom filtering rules, in their order
Example output
{
  "count": 1,
  "rules": [
    {
      "action": "block",
      "client": "",
      "domain": "ads.example.com",
      "match": "subdomains",
      "rule": "||ads.example.com^"
    }
  ]
}

List DNS rewrites

List AdGuard Home's DNS rewrites: the domains it answers with an address of your choosing.

Inputs

Searchsearchtext
Only those with these words in them.

Outputs

countnumber
How many rewrites are listed
rewriteslist
The DNS rewrites
Example output
{
  "count": 1,
  "rewrites": [
    {
      "answer": "192.168.1.20",
      "domain": "nas.home.arpa",
      "enabled": true
    }
  ]
}

Remove blocklist

Remove a blocklist or allowlist from AdGuard Home. Nothing is removed when it isn't there.

Inputs

ListaddresstextRequired
The list's web address (or file path), as Filters > DNS blocklists shows it.
List typelist_typetext
Only the blocklist or only the allowlist with this address. Either takes both.One of: any (Either), block (Blocklist), allow (Allowlist). Default: any.

Outputs

addresstext
The list's address
listslist
The lists removed
removednumber
How many lists were removed; 0 when AdGuard Home didn't have it
Example output
{
  "address": "https://adguardteam.github.io/HostlistsRegistry/assets/filter_1.txt",
  "lists": [
    {
      "address": "https://adguardteam.github.io/HostlistsRegistry/assets/filter_1.txt",
      "enabled": true,
      "id": 1,
      "kind": "block",
      "name": "AdGuard DNS filter",
      "rules": 188645,
      "updated_at": "2026-11-10T03:30:12Z"
    }
  ],
  "removed": 1
}

Remove client

Remove a persistent client from AdGuard Home; the device then follows AdGuard Home's settings. Nothing is removed when there's none.

Inputs

ClientnametextRequired
The persistent client, by its name as Settings > Client settings shows it.

Outputs

nametext
The client's name
removedtrue/false
True when it was removed; false when there was none
Example output
{
  "name": "Ben's tablet",
  "removed": true
}

Remove custom rule

Take a custom filtering rule out: the rule as written, or every rule for a domain. Nothing is removed when there's none.

Inputs

Rule or domainruletextRequired
A rule exactly as Filters > Custom filtering rules shows it, or a domain to take out every rule for it.
Block or alloweffecttext
For a domain, take out only its block rules or only its allow rules. Either takes out both.One of: any (Either), block, allow. Default: any.

Outputs

domaintext
The domain looked for
removednumber
How many rules were taken out; 0 when there were none
ruleslist
The rules taken out
Example output
{
  "domain": "ads.example.com",
  "removed": 1,
  "rules": [
    {
      "action": "block",
      "client": "",
      "domain": "ads.example.com",
      "match": "subdomains",
      "rule": "||ads.example.com^"
    }
  ]
}

Remove DNS rewrite

Remove a domain's DNS rewrites, or only the one with the answer given. Nothing is removed when there's none.

Inputs

DomaindomaintextRequired
The domain, as DNS rewrites shows it.
Answeranswertext
Only the rewrite with this answer. Leave blank for all of the domain's.

Outputs

domaintext
The domain
removednumber
How many rewrites were removed; 0 when there were none
rewriteslist
The rewrites removed
Example output
{
  "domain": "nas.home.arpa",
  "removed": 1,
  "rewrites": [
    {
      "answer": "192.168.1.20",
      "domain": "nas.home.arpa",
      "enabled": true
    }
  ]
}

Search query log

Find recent DNS queries in AdGuard Home's Query Log, newest first: for a domain, from a device, blocked only (or any of the Query Log's filters), within the last few minutes.

Inputs

Domaindomaintext
Only queries for domains containing this, such as example.com, which also finds ads.example.com.
Clientdevicetext
Only this device: its IP address, ClientID or persistent client name, as the Query Log shows it.
Showstatustext
Which queries, as the Query Log's own filter names them.One of: all (All queries), filtered, processed, blocked, blocked_services (Blocked services), blocked_safebrowsing (Blocked Threats), blocked_parental (Blocked by Parental Control), whitelisted (Allowed), rewritten, safe_search (Safe Search). Default: all.
Within the last (minutes)minutesnumber
Only queries from the last this many minutes. Leave blank for any time the Query Log keeps.From 1 to 129600.
How manylimitnumber
The most to list. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many queries are listed
querieslist
The matching queries, newest first
statustext
The kind of queries looked for, as the Query Log's filter names it
Example output
{
  "count": 1,
  "queries": [
    {
      "answers": [
        "0.0.0.0"
      ],
      "blocked": true,
      "cached": false,
      "client_id": "",
      "client_ip": "192.168.1.23",
      "client_name": "Living room TV",
      "domain": "ads.example.com",
      "elapsed_ms": 0.12,
      "list_name": "AdGuard DNS filter",
      "query_type": "A",
      "reason": "blocked by a filtering rule",
      "response": "NOERROR",
      "rule": "||ads.example.com^",
      "service": "",
      "status": "FilteredBlackList",
      "time": "2026-11-10T17:58:03Z",
      "upstream": ""
    }
  ],
  "status": "blocked"
}

Turn blocklist on or off

Turn a blocklist or allowlist on or off, keeping it in AdGuard Home, as its Enabled tick does.

Inputs

ListaddresstextRequired
The list's web address (or file path), as Filters > DNS blocklists shows it.
Onenabledtrue/false
On to use the list, off to stop using it for now.Default: true.
List typelist_typetext
Only the blocklist or only the allowlist with this address. Either takes both.One of: any (Either), block (Blocklist), allow (Allowlist). Default: any.

Outputs

addresstext
The list's address
enabledtrue/false
True when it was turned on, false when turned off
listslist
The list (a blocklist and an allowlist when both have it)
Example output
{
  "address": "https://adguardteam.github.io/HostlistsRegistry/assets/filter_1.txt",
  "enabled": true,
  "lists": [
    {
      "address": "https://adguardteam.github.io/HostlistsRegistry/assets/filter_1.txt",
      "enabled": true,
      "id": 1,
      "kind": "block",
      "name": "AdGuard DNS filter",
      "rules": 188645,
      "updated_at": "2026-11-10T03:30:12Z"
    }
  ]
}

Turn off protection

Pause AdGuard Home's protection for some minutes, such as for a site that won't load, or until it's turned back on, as Disable protection does.

Inputs

For how long (minutes)minutesnumber
Turn protection back on by itself after this many minutes, such as 10. Leave blank to keep it off until it's turned back on.From 0.1 to 10080.

Outputs

protectiontext
Whether AdGuard Home's protection is on or off
protection_enabledtrue/false
True while AdGuard Home is protecting
timer_secondsnumber
Seconds until protection turns back on by itself; 0 when it stays as it is
turns_on_attext
When protection turns back on by itself (ISO 8601, UTC); empty when it stays
Example output
{
  "protection": "off",
  "protection_enabled": false,
  "timer_seconds": 600,
  "turns_on_at": "2026-11-10T18:10:00Z"
}

Turn on protection

Turn AdGuard Home's protection back on, ending any pause.

Inputs

None.

Outputs

protectiontext
Whether AdGuard Home's protection is on or off
protection_enabledtrue/false
True while AdGuard Home is protecting
timer_secondsnumber
Seconds until protection turns back on by itself; 0 when it stays as it is
turns_on_attext
When protection turns back on by itself (ISO 8601, UTC); empty when it stays
Example output
{
  "protection": "on",
  "protection_enabled": true,
  "timer_seconds": 0,
  "turns_on_at": ""
}

Turn parental control on or off

Turn AdGuard's parental control web service on or off for everyone, as Use AdGuard parental control web service under Settings > General settings does: it blocks adult websites.

Inputs

Onenabledtrue/false
On to block adult websites, off to stop.Default: true.

Outputs

enabledtrue/false
True when parental control is on
Example output
{
  "enabled": true
}

Turn safe search on or off

Turn safe search on or off for everyone, as Use Safe Search under Settings > General settings does: family-friendly results in Google, YouTube, Bing and other search engines.

Inputs

Onenabledtrue/false
On to enforce safe search, off to stop.Default: true.

Outputs

enabledtrue/false
True when safe search is on
engineslist
The search engines it's enforced on, such as google and youtube
Example output
{
  "enabled": true,
  "engines": [
    "bing",
    "duckduckgo",
    "google",
    "youtube"
  ]
}

Unblock services

Unblock services for everyone, or for one persistent client. A service that wasn't blocked stays as it is.

Inputs

ServicesservicestextRequired
The services, such as YouTube or TikTok; several separated by commas.
For clientdevicetext
Only for this persistent client. Leave blank for everyone.

Outputs

blocked_service_idslist
The same services, by ID
blocked_serviceslist
Every service blocked for them now, by name
changedlist
The services blocked or unblocked now, by name
clienttext
The client changed; empty when it was everyone
Example output
{
  "blocked_service_ids": [
    "tiktok"
  ],
  "blocked_services": [
    "TikTok"
  ],
  "changed": [
    "YouTube"
  ],
  "client": "Ben's tablet"
}

Update blocklists

Download AdGuard Home's blocklists and allowlists again, as Check for updates does, and say how many changed and which turned-on lists have no rules (which is how a failed download looks).

Inputs

List typelist_typetext
Only the blocklists or only the allowlists. Either updates both.One of: any (Either), block (Blocklist), allow (Allowlist). Default: any.

Outputs

countnumber
How many lists there are
empty_listslist
Turned-on lists with no rules, which is how a failed download looks
listslist
The lists, after the update
updatednumber
How many lists had changed and were updated
Example output
{
  "count": 1,
  "empty_lists": [],
  "lists": [
    {
      "address": "https://adguardteam.github.io/HostlistsRegistry/assets/filter_1.txt",
      "enabled": true,
      "id": 1,
      "kind": "block",
      "name": "AdGuard DNS filter",
      "rules": 188645,
      "updated_at": "2026-11-10T03:30:12Z"
    }
  ],
  "updated": 1
}

Update client

Change a persistent client: its name, identifiers, and whether it follows AdGuard Home's settings or has its own (filtering, parental control, browsing security, safe search).

Inputs

ClientnametextRequired
The persistent client, by its name as Settings > Client settings shows it.
New namenew_nametext
A new name for it.
Identifiersidentifierstext
Its IP addresses, ranges, MAC addresses or ClientIDs, separated by commas, replacing the ones it has.
Settingssettingstext
Follow AdGuard Home's settings, or have its own.One of: keep (Leave as they are), global (AdGuard Home's settings), own (Its own settings). Default: keep.
Filteringfilteringtext
Turn blocking with filters on or off for this client alone, which gives it settings of its own.One of: keep (Leave as it is), on, off. Default: keep.
Parental controlparental_controltext
Turn AdGuard parental control on or off for this client alone, which gives it settings of its own.One of: keep (Leave as it is), on, off. Default: keep.
Browsing securitysafe_browsingtext
Turn AdGuard browsing security on or off for this client alone, which gives it settings of its own.One of: keep (Leave as it is), on, off. Default: keep.
Safe searchsafe_searchtext
Turn safe search on or off for this client alone, which gives it settings of its own.One of: keep (Leave as it is), on, off. Default: keep.
Blocked servicesblocked_servicestext
Make it follow the services blocked for everyone again. To block or unblock one for it, use Block services.One of: keep (Leave as they are), global (AdGuard Home's blocked services). Default: keep.

Outputs

blocked_service_idslist
The same services, by ID
blocked_serviceslist
The services blocked for it alone, by name
filtering_enabledtrue/false
Its own setting: block with filters
identifierslist
Its IP addresses, ranges, MAC addresses or ClientIDs
nametext
The client's name
parental_control_enabledtrue/false
Its own setting: parental control
safe_browsing_enabledtrue/false
Its own setting: browsing security
safe_search_enabledtrue/false
Its own setting: safe search
tagslist
Its tags, such as device_tablet
uses_global_blocked_servicestrue/false
True when it follows the services blocked for everyone
uses_global_settingstrue/false
True when it follows AdGuard Home's settings
Example output
{
  "blocked_service_ids": [
    "youtube"
  ],
  "blocked_services": [
    "YouTube"
  ],
  "filtering_enabled": true,
  "identifiers": [
    "192.168.1.40"
  ],
  "name": "Ben's tablet",
  "parental_control_enabled": false,
  "safe_browsing_enabled": false,
  "safe_search_enabled": false,
  "tags": [
    "device_tablet"
  ],
  "uses_global_blocked_services": false,
  "uses_global_settings": true
}

On this page