country#

Autogenerated API

argus_api.lib.geoip.v1.country.add_country(countryCode: str = None, countryName: 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#

Add new country (DEV)

Parameters

  • countryCode (str) – The two-letter country-code

  • countryName (str) – The name of the country

  • 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.country.list_countries(sortBy: str = None, limit: int = 25, offset: int = None, fromID: 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 GeoIP countries (INTERNAL)

Parameters

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

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

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

  • fromID (int) – Only return countries with numeric ID greater than or equal to this value

  • 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.country.search_countries(fromID: int = None, includeFlags: str = None, excludeFlags: str = None, includeDeleted: bool = None, limit: int = None, offset: int = 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#

Find GeoIP countries (INTERNAL)

Parameters

  • fromID (int) – Only return countries with IDs greater than or equal to this ID.

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

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

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

  • 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).

  • 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.country.update_country(id: int, countryName: 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#

Update an existing country (DEV)

Parameters

  • id (int) – Country ID

  • countryName (str) – The name of the country

  • 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