ranges#

Autogenerated API

argus_api.lib.geoip.v1.ranges.add_or_update_ranges(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 or update IP ranges (DEV)

Parameters

  • 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.geoip.v1.ranges.find_ranges(country: str = None, regionID: int = None, locationID: int = None, rangeID: int = None, ipAddress: str = None, addressFamily: str = None, includeFlags: str = None, excludeFlags: str = None, includeDeleted: bool = None, startTimestamp: int = None, endTimestamp: int = None, limit: int = None, offset: int = None, sortBy: str = None, startIPAddress: str = None, fromIP: str = None, toIP: str = None, countTimeout: int = - 1, 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#

Find IP ranges (INTERNAL)

Parameters

  • country (list) – Only return ranges from these countries (by country ID or two-letter code).

  • regionID (list) – Only return ranges from these regions (by region ID).

  • locationID (list) – Only return ranges from these locations (by location ID).

  • rangeID (list) – Only return specific ranges (by ID).

  • ipAddress (list) – Only return ranges which cover any of these IP-addresses. => format:ip

  • addressFamily (str) – Only return ranges for this address family range (ipv4 or ipv6).

  • includeFlags (list) – A set of included enumerated flags of the searched ranges.

  • excludeFlags (list) – A set of excluded enumerated flags of the searched ranges.

  • includeDeleted (bool) – If true, also include ranges marked as deleted.

  • startTimestamp (int) – Search for ranges having lastUpdatedTimestamp greater than or equal to this timestamp.

  • endTimestamp (int) – Search for ranges having lastUpdatedTimestamp less than or equal to this timestamp.

  • limit (int) – Max number of results.

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

  • sortBy (list) – Fields to sort results by (without a sign is ascending, with ‘-’ sign is descending).

  • startIPAddress (list) – Only return ranges where the range start address matches one of these IP-addresses. => format:ip

  • fromIP (str) – Only return ranges where the range start address is greater than or equal to this IP-address. => format:ip

  • toIP (str) – Only return ranges where the range start address is less than or equal to this IP-address. => format:ip

  • countTimeout (int) – Max wait in seconds for the count query to run. Set the value to -1 to skip counting (count will be returned -1). Set the value to 0 to execute the count query as long as the service allows, max allowed timeout value is 30 (seconds), default value is -1. (default -1)

  • 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.geoip.v1.ranges.list_ranges(sortBy: str = 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 ranges (INTERNAL)

Parameters

  • sortBy (list) – Fields to sort results by (without a sign is ascending, with ‘-’ sign is descending, supported fields are: id, startIP, endIP, locationID)

  • limit (int) – Max number of items to return

  • offset (int) – The amount of items to skip from the beginning

  • 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.geoip.v1.ranges.lookup_ip(ip: str, 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#

Lookup IP range (INTERNAL)

Parameters

  • ip (str) – IP-address that has to be covered by the range

  • 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