search#

Autogenerated API

argus_api.lib.pdns.v3.search.search_records(query: str = None, aggregateResult: bool = None, includeAnonymousResults: bool = None, rrClass: str = None, rrType: str = None, customerID: int = None, tlp: str = None, limit: int = None, sortBy: str = None, queryMatchStrategy: str = None, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Search against PassiveDNS with criteria and return matching records (PUBLIC)

Parameters

  • query (str) – Lookup query

  • aggregateResult (bool) – Whether aggregate results (default true)

  • includeAnonymousResults (bool) – Whether include anonymous results (default true)

  • rrClass (list) – Lookup with specified record classes

  • rrType (list) – Lookup with specified record types

  • customerID (list) – Lookup for specified customer IDs

  • tlp (list) – Lookup with specified TLPs, public usage only TLP white allowed

  • limit (int) – Max number of results to be returned, default unset means default limit 25 will be used, 0 means unlimited

  • sortBy (list) – The field on which to sort the records

  • queryMatchStrategy (str) – Query match strategy, partial must be set to use the wildcard (default exact)

  • offset (int) – Number of results to be skipped first, default 0 (default 0)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON