Sign in

v1

latestOpenAPI 3.0.32026-07-17687987.2 KB
filtering

Check if host name is filtered

get/filtering/check_host

Query parameters

namestring

Filter by host name

Response

OK.

reason'NotFilteredNotFound' | 'NotFilteredWhiteList' | 'NotFilteredError' | 'FilteredBlackList' | 'FilteredSafeBrowsing' | 'FilteredParental' | 'FilteredInvalid' | 'FilteredSafeSearch' | 'FilteredBlockedService' | 'Rewrite' | 'RewriteEtcHosts' | 'RewriteRule'

Request filtering status.

filter_idinteger

In case if there's a rule applied to this DNS request, this is ID of the filter list that the rule belongs to. Deprecated: use rules[*].filter_list_id instead.

rulestring

Filtering rule applied to the request (if any). Deprecated: use rules[*].text instead.

service_namestring

Set if reason=FilteredBlockedService

cnamestring

Set if reason=Rewrite

ip_addrsstring[]

Set if reason=Rewrite

Example response

{
  "reason": "NotFilteredNotFound",
  "filter_id": 0,
  "service_name": "service_name",
  "cname": "cname",
  "rule": "||example.org^",
  "rules": [
    {
      "text": "||example.org^",
      "filter_list_id": 123123
    },
    {
      "text": "||example.org^",
      "filter_list_id": 123123
    }
  ],
  "ip_addrs": [
    "ip_addrs",
    "ip_addrs"
  ]
}