0.0.2 • Published 1 year ago
adguardhome v0.0.2
AdGuardHome Node.js Module
This node module is mostly generated with https://github.com/OpenAPITools/openapi-generator from AdGuardHome's OpenAPI Docu https://github.com/AdguardTeam/AdGuardHome/blob/master/openapi/openapi.yaml. It's tested againt AdGuardHome's version 0.107.
:memo: Documentation for API Endpoints
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdGuardHome.BlockedServicesApi | blockedServicesAll | GET /blocked_services/all | Get available services to use for blocking |
| AdGuardHome.BlockedServicesApi | blockedServicesAvailableServices | GET /blocked_services/services | Get available services to use for blocking |
| AdGuardHome.BlockedServicesApi | blockedServicesList | GET /blocked_services/list | Get blocked services list |
| AdGuardHome.BlockedServicesApi | blockedServicesSchedule | GET /blocked_services/get | Get blocked services |
| AdGuardHome.BlockedServicesApi | blockedServicesScheduleUpdate | PUT /blocked_services/update | Update blocked services |
| AdGuardHome.BlockedServicesApi | blockedServicesSet | POST /blocked_services/set | Set blocked services list |
| AdGuardHome.ClientsApi | accessList | GET /access/list | List (dis)allowed clients, blocked hosts, etc. |
| AdGuardHome.ClientsApi | accessSet | POST /access/set | Set (dis)allowed clients, blocked hosts, etc. |
| AdGuardHome.ClientsApi | clientsAdd | POST /clients/add | Add a new client |
| AdGuardHome.ClientsApi | clientsDelete | POST /clients/delete | Remove a client |
| AdGuardHome.ClientsApi | clientsFind | GET /clients/find | Get information about clients by their IP addresses or ClientIDs. |
| AdGuardHome.ClientsApi | clientsStatus | GET /clients | Get information about configured clients |
| AdGuardHome.ClientsApi | clientsUpdate | POST /clients/update | Update client information |
| AdGuardHome.DhcpApi | checkActiveDhcp | POST /dhcp/find_active_dhcp | Searches for an active DHCP server on the network |
| AdGuardHome.DhcpApi | dhcpAddStaticLease | POST /dhcp/add_static_lease | Adds a static lease |
| AdGuardHome.DhcpApi | dhcpInterfaces | GET /dhcp/interfaces | Gets the available interfaces |
| AdGuardHome.DhcpApi | dhcpRemoveStaticLease | POST /dhcp/remove_static_lease | Removes a static lease |
| AdGuardHome.DhcpApi | dhcpReset | POST /dhcp/reset | Reset DHCP configuration |
| AdGuardHome.DhcpApi | dhcpResetLeases | POST /dhcp/reset_leases | Reset DHCP leases |
| AdGuardHome.DhcpApi | dhcpSetConfig | POST /dhcp/set_config | Updates the current DHCP server configuration |
| AdGuardHome.DhcpApi | dhcpStatus | GET /dhcp/status | Gets the current DHCP settings and status |
| AdGuardHome.DhcpApi | dhcpUpdateStaticLease | POST /dhcp/update_static_lease | Updates a static lease |
| AdGuardHome.FilteringApi | filteringAddURL | POST /filtering/add_url | Add filter URL or an absolute file path |
| AdGuardHome.FilteringApi | filteringCheckHost | GET /filtering/check_host | Check if host name is filtered |
| AdGuardHome.FilteringApi | filteringConfig | POST /filtering/config | Set filtering parameters |
| AdGuardHome.FilteringApi | filteringRefresh | POST /filtering/refresh | Reload filtering rules from URLs. This might be needed if new URL was just added and you don't want to wait for automatic refresh to kick in. This API request is ratelimited, so you can call it freely as often as you like, it wont create unnecessary burden on servers that host the URL. This should work as intended, a `force` parameter is offered as last-resort attempt to make filter lists fresh. If you ever find yourself using `force` to make something work that otherwise wont, this is a bug and report it accordingly. |
| AdGuardHome.FilteringApi | filteringRemoveURL | POST /filtering/remove_url | Remove filter URL |
| AdGuardHome.FilteringApi | filteringSetRules | POST /filtering/set_rules | Set user-defined filter rules |
| AdGuardHome.FilteringApi | filteringSetURL | POST /filtering/set_url | Set URL parameters |
| AdGuardHome.FilteringApi | filteringStatus | GET /filtering/status | Get filtering parameters |
| AdGuardHome.GlobalApi | beginUpdate | POST /update | Begin auto-upgrade procedure |
| AdGuardHome.GlobalApi | cacheClear | POST /cache_clear | Clear DNS cache |
| AdGuardHome.GlobalApi | dnsConfig | POST /dns_config | Set general DNS parameters |
| AdGuardHome.GlobalApi | dnsInfo | GET /dns_info | Get general DNS parameters |
| AdGuardHome.GlobalApi | getProfile | GET /profile | |
| AdGuardHome.GlobalApi | getVersionJson | POST /version.json | Gets information about the latest available version of AdGuard |
| AdGuardHome.GlobalApi | login | POST /login | Perform administrator log-in |
| AdGuardHome.GlobalApi | logout | GET /logout | Perform administrator log-out |
| AdGuardHome.GlobalApi | mobileConfigDoH | GET /apple/doh.mobileconfig | Get DNS over HTTPS .mobileconfig. |
| AdGuardHome.GlobalApi | mobileConfigDoT | GET /apple/dot.mobileconfig | Get DNS over TLS .mobileconfig. |
| AdGuardHome.GlobalApi | setProtection | POST /protection | Set protection state and duration |
| AdGuardHome.GlobalApi | status | GET /status | Get DNS server current status and general settings |
| AdGuardHome.GlobalApi | testUpstreamDNS | POST /test_upstream_dns | Test upstream configuration |
| AdGuardHome.GlobalApi | updateProfile | PUT /profile/update | Updates current user info |
| AdGuardHome.I18nApi | changeLanguage | POST /i18n/change_language | Change current language. Argument must be an ISO 639-1 two-letter code. |
| AdGuardHome.I18nApi | currentLanguage | GET /i18n/current_language | Get currently set language. Result is ISO 639-1 two-letter code. Empty result means default language. |
| AdGuardHome.InstallApi | installCheckConfig | POST /install/check_config | Checks configuration |
| AdGuardHome.InstallApi | installConfigure | POST /install/configure | Applies the initial configuration. |
| AdGuardHome.InstallApi | installGetAddresses | GET /install/get_addresses | Gets the network interfaces information. |
| AdGuardHome.LogApi | getQueryLogConfig | GET /querylog/config | Get query log parameters |
| AdGuardHome.LogApi | putQueryLogConfig | PUT /querylog/config/update | Set query log parameters |
| AdGuardHome.LogApi | queryLog | GET /querylog | Get DNS server query log. |
| AdGuardHome.LogApi | queryLogConfig | POST /querylog_config | Set query log parameters |
| AdGuardHome.LogApi | queryLogInfo | GET /querylog_info | Get query log parameters |
| AdGuardHome.LogApi | querylogClear | POST /querylog_clear | Clear query log |
| AdGuardHome.MobileconfigApi | mobileConfigDoH | GET /apple/doh.mobileconfig | Get DNS over HTTPS .mobileconfig. |
| AdGuardHome.MobileconfigApi | mobileConfigDoT | GET /apple/dot.mobileconfig | Get DNS over TLS .mobileconfig. |
| AdGuardHome.ParentalApi | parentalDisable | POST /parental/disable | Disable parental filtering |
| AdGuardHome.ParentalApi | parentalEnable | POST /parental/enable | Enable parental filtering |
| AdGuardHome.ParentalApi | parentalStatus | GET /parental/status | Get parental filtering status |
| AdGuardHome.RewriteApi | rewriteAdd | POST /rewrite/add | Add a new Rewrite rule |
| AdGuardHome.RewriteApi | rewriteDelete | POST /rewrite/delete | Remove a Rewrite rule |
| AdGuardHome.RewriteApi | rewriteList | GET /rewrite/list | Get list of Rewrite rules |
| AdGuardHome.RewriteApi | rewriteUpdate | PUT /rewrite/update | Update a Rewrite rule |
| AdGuardHome.SafebrowsingApi | safebrowsingDisable | POST /safebrowsing/disable | Disable safebrowsing |
| AdGuardHome.SafebrowsingApi | safebrowsingEnable | POST /safebrowsing/enable | Enable safebrowsing |
| AdGuardHome.SafebrowsingApi | safebrowsingStatus | GET /safebrowsing/status | Get safebrowsing status |
| AdGuardHome.SafesearchApi | safesearchDisable | POST /safesearch/disable | Disable safesearch |
| AdGuardHome.SafesearchApi | safesearchEnable | POST /safesearch/enable | Enable safesearch |
| AdGuardHome.SafesearchApi | safesearchSettings | PUT /safesearch/settings | Update safesearch settings |
| AdGuardHome.SafesearchApi | safesearchStatus | GET /safesearch/status | Get safesearch status |
| AdGuardHome.StatsApi | getStatsConfig | GET /stats/config | Get statistics parameters |
| AdGuardHome.StatsApi | putStatsConfig | PUT /stats/config/update | Set statistics parameters |
| AdGuardHome.StatsApi | stats | GET /stats | Get DNS server statistics |
| AdGuardHome.StatsApi | statsConfig | POST /stats_config | Set statistics parameters |
| AdGuardHome.StatsApi | statsInfo | GET /stats_info | Get statistics parameters |
| AdGuardHome.StatsApi | statsReset | POST /stats_reset | Reset all statistics to zeroes |
| AdGuardHome.TlsApi | tlsConfigure | POST /tls/configure | Updates current TLS configuration |
| AdGuardHome.TlsApi | tlsStatus | GET /tls/status | Returns TLS configuration and its status |
| AdGuardHome.TlsApi | tlsValidate | POST /tls/validate | Checks if the current TLS configuration is valid |
Documentation for Models
- AdGuardHome.AccessList
- AdGuardHome.AddUrlRequest
- AdGuardHome.AddressInfo
- AdGuardHome.AddressesInfo
- AdGuardHome.BlockedService
- AdGuardHome.BlockedServicesAll
- AdGuardHome.BlockedServicesSchedule
- AdGuardHome.CheckConfigRequest
- AdGuardHome.CheckConfigRequestInfo
- AdGuardHome.CheckConfigResponse
- AdGuardHome.CheckConfigResponseInfo
- AdGuardHome.CheckConfigStaticIpInfo
- AdGuardHome.CheckConfigStaticIpInfoStatic
- AdGuardHome.Client
- AdGuardHome.ClientAuto
- AdGuardHome.ClientDelete
- AdGuardHome.ClientFindSubEntry
- AdGuardHome.ClientUpdate
- AdGuardHome.Clients
- AdGuardHome.DNSConfig
- AdGuardHome.DayRange
- AdGuardHome.DhcpConfig
- AdGuardHome.DhcpConfigV4
- AdGuardHome.DhcpConfigV6
- AdGuardHome.DhcpFindActiveReq
- AdGuardHome.DhcpLease
- AdGuardHome.DhcpSearchResult
- AdGuardHome.DhcpSearchResultOtherServer
- AdGuardHome.DhcpSearchResultStaticIP
- AdGuardHome.DhcpSearchV4
- AdGuardHome.DhcpSearchV6
- AdGuardHome.DhcpStaticLease
- AdGuardHome.DhcpStatus
- AdGuardHome.DnsAnswer
- AdGuardHome.DnsInfo200Response
- AdGuardHome.DnsQuestion
- AdGuardHome.Error
- AdGuardHome.Filter
- AdGuardHome.FilterCheckHostResponse
- AdGuardHome.FilterConfig
- AdGuardHome.FilterRefreshRequest
- AdGuardHome.FilterRefreshResponse
- AdGuardHome.FilterSetUrl
- AdGuardHome.FilterSetUrlData
- AdGuardHome.FilterStatus
- AdGuardHome.GetQueryLogConfigResponse
- AdGuardHome.GetStatsConfigResponse
- AdGuardHome.GetVersionRequest
- AdGuardHome.InitialConfiguration
- AdGuardHome.LanguageSettings
- AdGuardHome.Login
- AdGuardHome.NetInterface
- AdGuardHome.ParentalStatus200Response
- AdGuardHome.ProfileInfo
- AdGuardHome.QueryLog
- AdGuardHome.QueryLogConfig
- AdGuardHome.QueryLogItem
- AdGuardHome.QueryLogItemClient
- AdGuardHome.QueryLogItemClientWhois
- AdGuardHome.RemoveUrlRequest
- AdGuardHome.ResultRule
- AdGuardHome.RewriteEntry
- AdGuardHome.RewriteUpdate
- AdGuardHome.SafeSearchConfig
- AdGuardHome.SafebrowsingStatus200Response
- AdGuardHome.Schedule
- AdGuardHome.ServerStatus
- AdGuardHome.SetProtectionRequest
- AdGuardHome.SetRulesRequest
- AdGuardHome.Stats
- AdGuardHome.StatsConfig
- AdGuardHome.TlsConfig
- AdGuardHome.TopArrayEntry
- AdGuardHome.UpstreamsConfig
- AdGuardHome.VersionInfo
:question: Get Help
For bug reports and feature requests, open issues. :bug:
:sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
Thank you to all my backers!
People
- fflorent
- Speeedy0815
- Ralf S.
- Enno L.
- Jürgen G.
- Mark MC G.
- Kay-Uwe M.
- Craig O.
- Manuel G.
Become a backer
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
— You can make one-time donations via PayPal. I'll probably buy a coffeetea. :tea:
— I'll buy a teacoffee. :coffee: :wink:
Thanks! :heart:
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.