override_domain#
Autogenerated API
- argus_api.lib.reputation.v1.override.override_domain.add_address_overrides(listName: str = None, listID: int = None, overrides: dict = None, clear: bool = 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 #
Add reputation IP override (INTERNAL)
- Parameters
listName (str) – The globally unique name of the override list to which we’re adding the address override entries.
listID (int) – The ID of the override list to which we’re adding the address override entries.
overrides (list) – The address override entries to add.
clear (bool) – Whether to remove all current override entries in the override list. (default false)
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.add_domain_override(listID: int = None, listName: str = None, overrides: dict = None, clear: bool = 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 #
Add reputation domain override (INTERNAL)
- Parameters
listID (int) – The ID of the override list to which we’re adding the domain override entries.
listName (str) – The globally unique name of the override list to which we’re adding the domain override entries.
overrides (list) – The domain override entries to add.
clear (bool) – Whether to remove all current override entries in the override list. (default false)
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.add_override_list(name: str = None, description: str = None, useForReputationCalc: bool = None, useForInputFiltering: bool = None, useForDefaultValues: bool = 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 #
Add reputation override list (INTERNAL)
- Parameters
name (str) – Unique Override list name => [a-zA-Z0-9_:\-.]*
description (str) – Override list description => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
useForReputationCalc (bool) – If true, enable use of the overrides in this list when calculating reputation values. (default false)
useForInputFiltering (bool) – If true, enable use of the overrides in this list for observation input filtering. (default false)
useForDefaultValues (bool) – If true, enable use of the overrides in this list as default values. (default false)
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.delete_address_override(id: int, 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 IP override (INTERNAL)
- Parameters
id (int) – ID of override entry to remove
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.delete_address_overrides(id: 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 #
Bulk delete reputation IP overrides (INTERNAL)
- Parameters
id (list) – IDs of IP overrides
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.delete_domain_override(id: int, 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 domain override (INTERNAL)
- Parameters
id (int) – ID of override entry to remove
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.delete_domain_overrides(id: 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 #
Bulk delete reputation domain overrides (INTERNAL)
- Parameters
id (list) – IDs of reputation overrides
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.delete_override_list(id: int, 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 override list (INTERNAL)
- Parameters
id (int) – ID of override list to remove
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.find_address_overrides(ranges: str = None, limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, listID: int = None, listName: str = None, includedListFlags: int = None, excludedListFlags: int = None, includeExpired: bool = None, startTimestamp: int = None, endTimestamp: int = None, timeFieldStrategy: str = None, minValue: float = None, maxValue: float = None, keywords: str = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, countMaxWait: int = None, keywordFieldStrategy: 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 IP overrides (INTERNAL)
- Parameters
ranges (list) –
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).
listID (list) – Collection of override lists’ IDs
listName (list) – Collection of override lists’ names
includedListFlags (int) – Include records with flags in override list
excludedListFlags (int) – Exclude records with flags in override list
includeExpired (bool) – Whether include expired overrides, default not include expired overrides
startTimestamp (int) – Records after this timestamp against fields defined by timeFieldStrategy
endTimestamp (int) – Records before this timestamp against fields defined by timeFieldStrategy
timeFieldStrategy (list) – TimeFieldStrategy to define which timestamp field(s) to match, default lastUpdatedTimestamp
minValue (float) – Lower bound for override value range [0,1]
maxValue (float) – Upper bound for override data value range [0,1]
keywords (list) – Set of keywords to match selected fields, depends on KeywordMatchStrategy
keywordMatchStrategy (str) – Define whether all/any keywords have to be matched with selected fields
timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
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.
keywordFieldStrategy (list) – Define which field(s) to be matched against keywords
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 rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.find_domain_overrides(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, listID: int = None, listName: str = None, includedListFlags: int = None, excludedListFlags: int = None, includeExpired: bool = None, startTimestamp: int = None, endTimestamp: int = None, timeFieldStrategy: str = None, minValue: float = None, maxValue: float = None, keywords: str = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, countMaxWait: int = None, domainPatternBases: str = None, keywordFieldStrategy: 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 domain overrides (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).
listID (list) – Collection of override lists’ IDs
listName (list) – Collection of override lists’ names
includedListFlags (int) – Include records with flags in override list
excludedListFlags (int) – Exclude records with flags in override list
includeExpired (bool) – Whether include expired overrides, default not include expired overrides
startTimestamp (int) – Records after this timestamp against fields defined by timeFieldStrategy
endTimestamp (int) – Records before this timestamp against fields defined by timeFieldStrategy
timeFieldStrategy (list) – TimeFieldStrategy to define which timestamp field(s) to match, default lastUpdatedTimestamp
minValue (float) – Lower bound for override value range [0,1]
maxValue (float) – Upper bound for override data value range [0,1]
keywords (list) – Set of keywords to match selected fields, depends on KeywordMatchStrategy
keywordMatchStrategy (str) – Define whether all/any keywords have to be matched with selected fields
timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
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.
domainPatternBases (list) – Collection of domain pattern bases
keywordFieldStrategy (list) – Define which field(s) to be matched against keywords
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 rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.get_override_for_domain(id: int, 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 domain override value by ID (INTERNAL)
- Parameters
id (int) – ID of override object
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.get_override_for_i_p(id: int, 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 :
get_override_for_i_p
is an alias forget_override_for_ip
. Exists only for backward compatibility - do not use - useget_override_for_ip
instead.
- argus_api.lib.reputation.v1.override.override_domain.get_override_for_ip(id: int, 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 IP override value by ID (INTERNAL)
- Parameters
id (int) – ID of override object
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.get_override_list_by_id(id: int, 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 #
Get override list by ID (INTERNAL)
- Parameters
id (int) – ID of OverrideList
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.get_override_lists(sortBy: str = None, keywords: str = None, includeDeleted: bool = 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 all override lists (INTERNAL)
- Parameters
sortBy (list) – Fields to sort results by (without a sign is ascending, with ‘-’ sign is descending, supported fields are: id, lastModified)
keywords (list) – Filter override lists by keywords
includeDeleted (bool) – Whether to include deleted results (not included by default)
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) – Maximum number of returned results
offset (int) – Skip a number of results
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.get_overrides_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 domain override value by FQDN (INTERNAL)
- Parameters
fqdn (str) – Domain/domain pattern to fetch overrides 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 rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.get_overrides_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 :
get_overrides_for_i_p
is an alias forget_overrides_for_ip
. Exists only for backward compatibility - do not use - useget_overrides_for_ip
instead.
- argus_api.lib.reputation.v1.override.override_domain.get_overrides_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 domain override value by IP address (INTERNAL)
- Parameters
ip (str) – IP to search overrides 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 rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.list_address_overrides(list: str = None, sortBy: str = 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 address overrides (INTERNAL)
- Parameters
list (str) – Limit results to overrides from this list
sortBy (list) – Fields to sort results by (without a sign is ascending, with ‘-’ sign is descending, supported fields are: id, lastModified, range)
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 results
offset (int) – Offset results
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.list_domain_overrides(list: str = None, sortBy: str = 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 overrides (INTERNAL)
- Parameters
list (str) – Limit results to overrides from this list
sortBy (list) – Fields to sort results by (without a sign is ascending, with ‘-’ sign is descending, supported fields are: id, lastModified, domainPattern)
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 results
offset (int) – Offset results
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.reputation.v1.override.override_domain.update_override_list(id: int, name: str = None, description: str = None, useForReputationCalc: bool = None, useForInputFiltering: bool = None, useForDefaultValues: bool = 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 #
Update reputation override list (INTERNAL)
- Parameters
id (int) – ID of reputation override list
name (str) – If set, update the name of this list => [a-zA-Z0-9_:\-.]*
description (str) – If set, update the description of this list => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
useForReputationCalc (bool) – If set, enable/disable use of the overrides in this list when calculating reputation values
useForInputFiltering (bool) – If set, enable/disable use of the overrides in this list for observation input filtering
useForDefaultValues (bool) – If set, enable/disable use of the overrides in this list as default values
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON