observation#

Autogenerated API

argus_api.lib.reputation.v1.observation.add_observations(sourceID: int = None, sourceAlias: str = None, observations: dict = None, addAddresses: bool = True, addDomains: bool = True, 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#

Add reputation observations (INTERNAL)

Parameters

  • sourceID (int) – The source’s ID.

  • sourceAlias (str) – The source’s globally unique alias.

  • observations (list) – Observations to add. Invalid observations will be rejected but not fail the entire request.

  • addAddresses (bool) – Whether to add addresses (default true)

  • addDomains (bool) – Whether to add domains (default true)

  • 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

dictionary translated from JSON

argus_api.lib.reputation.v1.observation.delete_observations(sourceAlias: str = None, address: str = None, fqdn: str = None, sourceID: 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#

Delete reputation observations (INTERNAL)

Parameters

  • sourceAlias (str) – Source alias

  • address (list) – IP Addresses

  • fqdn (list) – Domain names

  • sourceID (int) – Source ID

  • 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

dictionary translated from JSON

argus_api.lib.reputation.v1.observation.fetch_observations_for_domain(fqdn: str, countMaxWait: 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#

Look up reputation observations for the given domain (INTERNAL)

Parameters

  • fqdn (str) – Domain to fetch observations for

  • countMaxWait (int) – Max wait time for result count calculation. 0 equates to unlimited wait and -1 to skip counting altogether. Defaults to 2 seconds.

  • 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

dictionary translated from JSON

argus_api.lib.reputation.v1.observation.fetch_observations_for_i_p(ip: str, countMaxWait: 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#

DEPRECATED : fetch_observations_for_i_p is an alias for fetch_observations_for_ip. Exists only for backward compatibility - do not use - use fetch_observations_for_ip instead.

argus_api.lib.reputation.v1.observation.fetch_observations_for_ip(ip: str, countMaxWait: 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#

Look up reputation observations for the given IP (INTERNAL)

Parameters

  • ip (str) – IP address to fetch observations for

  • countMaxWait (int) – Max wait time for result count calculation. 0 equates to unlimited wait and -1 to skip counting altogether. Defaults to 2 seconds.

  • 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

dictionary translated from JSON

argus_api.lib.reputation.v1.observation.find_address_observations(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, minimumState: int = None, minimumConfidence: float = None, sourceID: int = None, startTimestamp: int = None, endTimestamp: int = None, countMaxWait: int = None, fromAddress: dict = None, afterAddress: dict = None, addresses: dict = None, sortBy: str = 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 for IP observations (INTERNAL)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • includeFlags (int) – Only include objects which have includeFlags set.

  • excludeFlags (int) – Exclude objects which have excludeFlags set.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • minimumState (int) – Filter results by observations with at least this state

  • minimumConfidence (float) – Filter results by observations with at least this confidence

  • sourceID (list) – Filter results by observations from these sources

  • startTimestamp (int) – Filter results by observations last updated >= this timestamp

  • endTimestamp (int) – Filter results by observations last updated <= this timestamp

  • countMaxWait (int) – How many seconds to wait for count calculation to complete. -1: Skip counting altogether to return search results immediately. 0: Unlimited count time for when the count matters and response time does not. Defaults to 2 seconds.

  • fromAddress (dict) –

  • afterAddress (dict) –

  • addresses (list) – Filter results by these IP addresses

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • 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

dictionary translated from JSON

argus_api.lib.reputation.v1.observation.find_domain_observations(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, minimumState: int = None, minimumConfidence: float = None, sourceID: int = None, startTimestamp: int = None, endTimestamp: int = None, countMaxWait: int = None, fromDomainName: dict = None, afterDomainName: dict = None, domainNames: dict = None, domains: str = None, sortBy: str = 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 for domain observations (INTERNAL)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • includeFlags (int) – Only include objects which have includeFlags set.

  • excludeFlags (int) – Exclude objects which have excludeFlags set.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • minimumState (int) – Filter results by observations with at least this state

  • minimumConfidence (float) – Filter results by observations with at least this confidence

  • sourceID (list) – Filter results by observations from these sources

  • startTimestamp (int) – Filter results by observations last updated >= this timestamp

  • endTimestamp (int) – Filter results by observations last updated <= this timestamp

  • countMaxWait (int) – How many seconds to wait for count calculation to complete. -1: Skip counting altogether to return search results immediately. 0: Unlimited count time for when the count matters and response time does not. Defaults to 2 seconds.

  • fromDomainName (dict) –

  • afterDomainName (dict) –

  • domainNames (list) – DEPRECATED: Search for observations by domain name. Deprecated, use domains instead.

  • domains (list) – Search for observations by domain name.

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • 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

dictionary translated from JSON

argus_api.lib.reputation.v1.observation.list_address_observations(sourceID: int = None, minimumState: int = None, minimumConfidence: float = None, countMaxWait: int = None, limit: int = 25, 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#

List IP observations (INTERNAL)

Parameters

  • sourceID (int) – Limit result to observations from specified source

  • minimumState (int) – Limit result to observations with this state or higher

  • minimumConfidence (float) – Limit result to observations bound to sources with at least this confidence

  • countMaxWait (int) – Max wait time for result count calculation. 0 equates to unlimited wait and -1 to skip counting altogether. Defaults to 2 seconds.

  • limit (int) – Limit result

  • offset (int) – Offset result

  • 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

dictionary translated from JSON

argus_api.lib.reputation.v1.observation.list_domain_observations(sourceID: int = None, minimumState: int = None, minimumConfidence: float = None, countMaxWait: int = None, limit: int = 25, 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#

List domain observations (INTERNAL)

Parameters

  • sourceID (int) – Limit result to observations from specified source

  • minimumState (int) – Limit result to observations with this state or higher

  • minimumConfidence (float) – Limit result to observations bound to sources with at least this confidence

  • countMaxWait (int) – Max wait time for result count calculation. 0 equates to unlimited wait and -1 to skip counting altogether. Defaults to 2 seconds.

  • limit (int) – Limit result

  • offset (int) – Offset result

  • 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

dictionary translated from JSON