GUguardllamanet
clients

Get information about clients by their IP addresses or ClientIDs.

get/clients/find

Request

  • Base URL
    /control (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP basic

Query parameters

ip0string

Filter by IP address or ClientIDs. Parameters with names ip1, ip2, and so on are also accepted and interpreted as "ip0 OR ip1 OR ip2". TODO(a.garipov): Replace with a better query API.

Response

OK.

ClientsFindEntry[] required

Client search results.

Example response

[
  {
    "cli42": null,
    "name": "Client 42",
    "ids": [
      "cli42"
    ],
    "use_global_settings": true,
    "filtering_enabled": true,
    "parental_enabled": true,
    "safebrowsing_enabled": true,
    "safesearch_enabled": true,
    "use_global_blocked_services": true,
    "blocked_services": null,
    "upstreams": null,
    "whois_info": {},
    "disallowed": false,
    "disallowed_rule": ""
  },
  {
    "1.2.3.4": null,
    "name": "Client 1-2-3-4",
    "ids": [
      "1.2.3.4"
    ],
    "use_global_settings": true,
    "filtering_enabled": true,
    "parental_enabled": true,
    "safebrowsing_enabled": true,
    "safesearch_enabled": true,
    "use_global_blocked_services": true,
    "blocked_services": null,
    "upstreams": null,
    "whois_info": {},
    "disallowed": false,
    "disallowed_rule": ""
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.