Response Objects¶
-
class
apilityio.model.
BaseDict
¶ Create a Generic object from dict.
-
class
apilityio.model.
Response
(status_code=200, error=None, json=None)¶ Create a basic response object.
- Keyword Arguments:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.
- Attributes:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.
-
class
apilityio.model.
BadIPResponse
(status_code=200, error=None, blacklists=[], json=None)¶ Response object with the result of a query to check if the IP address has been found in any blacklist.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or 404 (NOT_FOUND), the error returned by the server.json
: JSON object returned by the REST API without modifications.blacklists
: List of strings with the name of the Blacklists of the IP.
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or 404 (NOT_FOUND), the error returned by the server.json
: JSON object returned by the REST API without modifications.blacklists
: List of strings with the name of the Blacklists of the IP.
-
class
apilityio.model.
IPBlacklist
(ip_address, blacklists)¶ Object to pair IP adress and blacklists. This object contains an IP address and a list with the blacklists it was found.
- Keyword Arguments:
ip_address
: the ip address of the pairblacklists
: the list of strings with the blacklists names of the IP address
- Attributes:
ip_address
: the ip address of the pairblacklists
: the list of strings with the blacklists names of the IP address
-
class
apilityio.model.
BadBatchIPResponse
(status_code=200, error=None, ipblacklists_set={}, json=None)¶ Response object with the result of a query to check if a group of IP addresses have been found in any blacklist.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.ipblacklists_set
: Set ofIPBlacklist()
objects that contains the result of the check performed on each IP address.
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.ipblacklists_set
: Set ofIPBlacklist()
objects that contains the result of the check performed on each IP address.
-
class
apilityio.model.
ContinentNames
¶ Object to cointain all the translations of a continent.
- Keyword Arguments:
continent_names
: Dictionary containing all the names in different languages of a given continent.
- Attributes:
en
: Englishpt-BR
: Portuguesefr
: Frenchja
: Japanesde
: Germanzh-CN
: Chinesees
: Spanishru
: Russian
-
class
apilityio.model.
CountryNames
¶ Object to cointain all the translations of a country. It is only guaranteed to exists the english (en) attribute.
- Keyword Arguments:
country_names
: Dictionary containing all the names in different languages of a given country
- Attributes:
en
: Englishpt-BR
: Portuguesefr
: Frenchja
: Japanesde
: Germanzh-CN
: Chinesees
: Spanishru
: Russian
-
class
apilityio.model.
GeoIP
(geoip)¶ Object to cointain all geolocation data of the IP address.
- Keyword Arguments:
geoip
: Dictionary containing all the geo location data as described in https://apility.io/apidocs/#geoip
- Attributes:
longitude
: Longitude where the IP has been foundlatitude
: Latitude where the IP has been foundhostname
: Name of the host resolved from the IPaddress
: IPv4 or IPv6 address of the requestcontinent
: 2 letter code of the continent.country
: ISO 3166-1 Country code.region
: Name of the region, by default the english translation in ‘region_names’.city
: Name of the city, by default the english translation in ‘city_names’.postal
: Postal code or Zip codetime_zone
: Time zone of the locationaccuracy_radius
: The approximate radius in kilometers around the latitude and longitude for the geographical entity. -1 if unknown.continent_geoname_id
: Id of the continent in the geonames.org database. -1 if the continent cannot be geolocated.country_geoname_id
: Id of the country in the geonames.org database. -1 if the country cannot be geolocated.region_geoname_id
: Id of the region in the geonames.org database. -1 if the region cannot be geolocated.city_geoname_id
: Id of the city in the geonames.org database. -1 if the city cannot be geolocated.continent_names
: Object containing theContinentNames()
data.country_names
: Object containing theCountryNames()
data.region_names
: JSON structure containing the different names of the region in different languages. Languages are in ISO 639-1. Empty if region cannot be geolocated.city_names
: JSON structure containing the different names of the city in different languages. Languages are in ISO 639-1. Empty if city cannot be geolocated.asystem
: Object containing theASystem()
data.
-
class
apilityio.model.
ASystem
¶ Object to cointain all the information of an Autonomous System.
- Keyword Arguments:
asystem
: Dictionary containing all the autonomous system information described in https://apility.io/apidocs/#as
- Attributes:
asn
: AS numbername
: name of the AScountry
: ISO 3166-1 Country codenetworks
: List with the networks of the AS
-
class
apilityio.model.
GeoIPResponse
(status_code=200, error=None, geoip=None, json=None)¶ Response object with the result of a query to get the IP address geolocation data.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.geoip
: Dictionary containing all the geo location data as described in https://apility.io/apidocs/#geoip
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.geoip
: ObjectGeoIP()
containing all geolocation attributes.
-
class
apilityio.model.
IPGeodata
(ip_address, geodata)¶ Object to pair IP adress and geodata information. This object contains an IP address and its geodata information.
-
class
apilityio.model.
GeoBatchIPResponse
(status_code=200, error=None, geolocated_ip_list=[], json=None)¶ Response object with the result of a query to get the geolocation data of multiple IP addresses.
- Keyword Arguments:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.geolocated_ip_list
: List ofIPGeodata()
objects.
- Attributes:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.geolocated_ip_list
: List ofIPGeodata()
objects.
-
class
apilityio.model.
IP
¶ Object to cointain the information of the information of looking up the IP in the blacklists.
- Keyword Arguments:
ip_address
: Dictionary containing all the information of the IP in the blacklists as described in https://apility.io/apidocs/#ip-score
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ IP. Neutral or positive means it’s a ‘clean’ IP.blacklist
: List containing the blacklists where the IP was found.is_quarantined
: If the IP has been added by the user to the quarantine lists.address
: IPv4 or IPv6 resolved.
-
class
apilityio.model.
Domain
¶ Object to cointain the information of testing different subdomains of the main root domain: NS records, MX records and domain blacklists.
- Keyword Arguments:
domain
: Dictionary containing all the subdomains of the main root domain: NS records, MX records and domain as described in https://apility.io/apidocs/#domainname-score
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ domain. Neutral or positive means it’s a ‘clean’ domain.blacklist_ns
: List containing the blacklists where the NS domains were found.blacklist_mx
: List containing the blacklists where the MX domains were found.blacklist
: List containing the blacklists where the domain was found.mx
: List with the hosts found in the MX records.ns
: List with the hosts found in the NS records.
-
class
apilityio.model.
BadDomain
(domain_data)¶ Object to cointain all scoring and blacklist analysis for main Domain, MX and NS records and IP address.
- Keyword Arguments:
domain_data
: Dictionary containing all the domain analysis data as described in https://apility.io/apidocs/#domain
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ domain. Neutral or positivo means it’s a ‘clean’ domain.domain
: ObjectDomain()
containing the ‘domainname score’ information as result of the analysis of the domains.ip
: ObjectIP()
containing the ‘ip score’ information as result of the analysis of the IP of the domain.source_ip
: ObjectIP()
containing the ‘ip score’ information as result of the analysis of the IP origin of the request.
-
class
apilityio.model.
BadDomainResponse
(status_code=200, error=None, domain_data=None, json=None)¶ Response object with the result of a query to check if the Domain and its MX and NS records have been found in any blacklist.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or 404 (NOT_FOUND), the error returned by the server.json
: JSON object returned by the REST API without modifications.domain_data
: Dictionary containing all the domain analysis data as described in https://apility.io/apidocs/#domain
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or 404 (NOT_FOUND), the error returned by the server.json
: JSON object returned by the REST API without modifications.response
: ObjectBadDomain()
containing all scoring and blacklists of the Domain.
-
class
apilityio.model.
DomainScored
(domain, scored_domain)¶ Object to pair domain and the result of the scoring process
- Keyword Arguments:
domain
: the domain FQDN of the pairscored_domain
: an ObjectBadDomain()
with the scoring information
- Attributes:
domain
: the domain FQDN of the pairscoring
: an ObjectBadDomain()
with the scoring information
-
class
apilityio.model.
BadBatchDomainResponse
(status_code=200, error=None, domain_scoring_list=[], json=None)¶ Response object with the result of a query to get the analysis data of multiple domains.
- Keyword Arguments:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.domain_scoring_list
: List ofDomainScored()
objects.
- Attributes:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.domain_scoring_list
: List ofDomainScored()
objects.
-
class
apilityio.model.
EmailAddress
¶ Object to cointain the information of the format of the Email address.
- Keyword Arguments:
address_score
: Dictionary containing all the address format details described in https://apility.io/apidocs/#address-score
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ IP. Neutral or positive means it’s a ‘clean’ Email.is_role
: True if the email has the format of a role-based-address. It’s not common to allow registration with role-based-addresses.is_well_formed
: True if the email is compliant with the standard email formats.
-
class
apilityio.model.
SMTPInfo
¶ Object to cointain the information obtained after testing the remote inbox SMTP server where the email is hosted.
- Keyword Arguments:
smtp_score
: Dictionary containing all SMTP score test details in in https://apility.io/apidocs/#smtp-score
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ IP. Neutral or positive means it’s a ‘clean’ Email.exist_mx
: True if the SMTP service is reachable using the hosts in the MX records.exist_address
: True if the SMTP service recognizes the email address.exist_catchall
: True if the SMTP service implements a catch-all email feature.
-
class
apilityio.model.
FreeEmail
¶ Object to cointain the information checking the domain against a list of Free domain servers.
- Keyword Arguments:
freemail_score
: Dictionary containing all Freemail score test details in in https://apility.io/apidocs/#freemail-score
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ IP. Neutral or positive means it’s a ‘clean’ Email.is_freemail
: True if the domain has been found in any Free Email Service Provider list.
-
class
apilityio.model.
EmailScore
¶ Object to cointain the information checking the email against a list of Email addresses of abusers.
- Keyword Arguments:
email_score
: Dictionary containing all Email of abusers score test details in in https://apility.io/apidocs/#email-score
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ IP. Neutral or positive means it’s a ‘clean’ Email.blacklist
: List containing the blacklists where the email was found.
-
class
apilityio.model.
DisposableEmail
¶ Object to cointain the information checking the domain against a list of Disposable Email Addresses.
- Keyword Arguments:
disposable_score
: Dictionary containing all Disposable score test details in in https://apility.io/apidocs/#disposable-score
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ IP. Neutral or positive means it’s a ‘clean’ Email.is_disposable
: True if The domain has been found in any Disposable Email Address Providers list.
-
class
apilityio.model.
BadEmail
(email_data)¶ Object to cointain all scoring and blacklist analysis for Email about SMTP server, main Domain, MX and NS records and IP address.
- Keyword Arguments:
email_data
: Dictionary containing all the email analysis data as described in https://apility.io/apidocs/#email
- Attributes:
score
: Number describing the result of the algorithm. Negative means ‘suspicious’ or ‘bad’ domain. Neutral or positivo means it’s a ‘clean’ email.domain
: ObjectDomain()
containing the ‘domainname score’ information as result of the analysis of the domains.ip
: ObjectIP()
containing the ‘ip score’ information as result of the analysis of the IP of the domain.source_ip
: ObjectIP()
containing the ‘ip score’ information as result of the analysis of the IP origin of the request.address
: ObjectEmailAddress()
containing the ‘address score’ object as result of the analysis of the email.smtp
: ObjectSMTPInfo()
containing the ‘smtp score’ object as result of the analysis of the email service.freemail
: ObjectFreeEmail()
containing the ‘freemail score’ object as result of the analysis of the email provider.email
: ObjectEmailScore()
containing the ‘email-blacklist score’ object as result of the look up in the email blacklists.disposable
: ObjectDisposableEmail()
containing the ‘disposable score’ object as result of the analysis of the email provider.
-
class
apilityio.model.
BadEmailResponse
(status_code=200, error=None, email_data=None, json=None)¶ Response object with the result of a query to check if the Domain and its MX and NS records have been found in any blacklist.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or 404 (NOT_FOUND), the error returned by the server.json
: JSON object returned by the REST API without modifications.email_data
: Dictionary containing all the email analysis data as described in https://apility.io/apidocs/#email
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or 404 (NOT_FOUND), the error returned by the server.json
: JSON object returned by the REST API without modifications.response
: ObjectBadEmail()
containing all scoring and blacklists of the Email.
-
class
apilityio.model.
EmailScored
(email, scored_email)¶ Object to pair Email and the result of the scoring process
- Keyword Arguments:
email
: the email address of the pairscored_email
: an ObjectBadEmail()
with the scoring information
- Attributes:
email
: the email address of the pairscoring
: an ObjectBadEmail()
with the scoring information
-
class
apilityio.model.
BadBatchEmailResponse
(status_code=200, error=None, email_scoring_list=[], json=None)¶ Response object with the result of a query to get the analysis data of multiple emails.
- Keyword Arguments:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.email_scoring_list
: List ofEmailScored()
objects.
- Attributes:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.email_scoring_list
: List ofEmailScored()
objects.
-
class
apilityio.model.
ASResponse
(status_code=200, error=None, asystem=None, json=None)¶ Response object with the result of a query to get Autonomous System information.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.asystem
: Dictionary containing all the autonomous system information described in https://apility.io/apidocs/#as
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.asystem
: ObjectASystem()
containing all autonomous system attributes.
-
class
apilityio.model.
ASBatchIPResponse
(status_code=200, error=None, asystem_ip_list=[], json=None)¶ Response object with the result of a query to get the Autonomous System information of multiple IP addresses.
- Keyword Arguments:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.asystem_ip_list
: List ofIPASystem()
objects.
- Attributes:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.asystem_ip_list
: List ofIPASystem()
objects.
-
class
apilityio.model.
IPASystem
(ip_address, as_data)¶ Object to pair IP adress and Autonomous System information. This object contains an IP address and its AS information.
-
class
apilityio.model.
ASNASystem
(as_number, as_data)¶ Object to pair AS numbers and Autonomous System information. This object contains an AS number and its AS information.
-
class
apilityio.model.
ASBatchNumResponse
(status_code=200, error=None, asystem_num_list=[], json=None)¶ Response object with the result of a query to get the Autonomous System information of multiple AS numbers.
- Keyword Arguments:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.asystem_asn_list
: List ofASNASystem()
objects.
- Attributes:
status_code
: An integer with the HTTP response status codeerror
: If status code is not 200 (OK), the error returned by the server.json
: JSON object returned by the REST API without modifications.asystem_asn_list
: List ofASNASystem()
objects.
-
class
apilityio.model.
WhoisIPResponse
(status_code=200, error=None, whois=None, json=None)¶ Response object with the result of a query to get WHOIS information of an IP address.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.whois
: Dict structure with the WHOIS IP information described in https://apility.io/apidocs/#whois
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.whois
: ObjectWhoisIP()
containing all WHOIS objects and attributes.
-
class
apilityio.model.
WhoisIP
(whois)¶ Object to cointain all WHOIS data of the IP address.
- Keyword Arguments:
whois
: Dictionary containing all the WHOIS data as described in https://apility.io/apidocs/#whois
- Attributes:
query
: The IP addressasn
: Globally unique identifier used for routing information exchange with Autonomous Systems.asn_cidr
: Network routing block assigned to an ASN.asn_country_code
: ASN assigned country code in ISO 3166-1 format.asn_date
: ASN allocation date in ISO 8601 format.asn_registry
: ASN assigned regional internet registry.asn_description
: The ASN descriptionnetwork
: Object containing theWhoisNetwork()
data.entities
: list of object names referenced by an RIR network. Map these to the objects keys.objects
: List of objects containing theWhoisObject()
data.
-
class
apilityio.model.
WhoisObject
(whoisobject)¶ Object to cointain all WHOIS data (entity) in the objects list within the WHOIS.
- Keyword Arguments:
whoisobject
: Dictionary containing all the WHOIS OBJECT data as described in https://apility.io/apidocs/#whois-object
- Attributes:
contact
: Object containing theWhoisObjectContact()
data. Contact information registered with an RIR object.entities
: List of object names referenced by an RIR object. Map these to other objects keys.events
: List of objects containing theWhoisEvent()
data. List of event dictionaries.events_actor
: List of objects containing theWhoisEvent()
as events (no actor).handle
: Unique identifier for a registered object.links
: List of HTTP/HTTPS links provided for an RIR object.notices
: List of objects containing theWhoisNotice()
. List of notice dictionaries.remarks
:List of objects containing theWhoisNotice()
. List of remark (notice) dictionaries.roles
: List of roles assigned to a registered object.status
: List indicating the state of a registered object.
-
class
apilityio.model.
WhoisNetwork
(whoisnetwork)¶ Object to cointain all WHOIS data (entity) in the network within the WHOIS.
- Keyword Arguments:
whoisnetwork
: Dictionary containing all the WHOIS NETWORK data as described in https://apility.io/apidocs/#whois-network
- Attributes:
cidr
: Network routing block an IP address belongs to.country
: Country code registered with the RIR in ISO 3166-1 format.end_address
: The last IP address in a network block.events
: List of objects containing theWhoisEvent()
data. List of event dictionaries.handle
: Unique identifier for a registered object.ip_version
: IP protocol version (v4 or v6) of an IP address.links
: HTTP/HTTPS links provided for an RIR object.name
: The identifier assigned to the network registration for an IP address.notices
: List of objects containing theWhoisNotice()
. List of notice dictionaries.parent_handle
: Unique identifier for the parent network of a registered network.remarks
: List of objects containing theWhoisNotice()
. List of remark (notice) dictionaries.start_address
: The first IP address in a network block.status
: List indicating the state of a registered object.type
: The RIR classification of a registered network.
-
class
apilityio.model.
WhoisEvent
¶ Object to cointain all WHOIS data (entity) in the events within the WHOIS.
- Keyword Arguments:
event
: Dictionary containing all the WHOIS EVENT data as described in https://apility.io/apidocs/#whois-event
- Attributes:
action
: The reason for an event.timestamp
: The date an event occured in ISO 8601 format.actor
: The identifier for an event initiator (if any).
-
class
apilityio.model.
WhoisNotice
¶ Object to cointain all WHOIS data (entity) in the notices within the WHOIS.
- Keyword Arguments:
notice
: Dictionary containing all the WHOIS NOTICE data as described in https://apility.io/apidocs/#whois-notice
- Attributes:
title
: The title/header for a notice.description
: The description/body of a notice.links
: list of HTTP/HTTPS links provided for a notice.
-
class
apilityio.model.
WhoisRemark
¶ Object to cointain all WHOIS data (entity) in the remarks within the WHOIS.
- Keyword Arguments:
remark
: Dictionary containing all the WHOIS REMARK data as described in https://apility.io/apidocs/#whois-notice
- Attributes:
title
: The title/header for a notice.description
: The description/body of a notice.links
: list of HTTP/HTTPS links provided for a notice.
-
class
apilityio.model.
WhoisObjectContact
¶ Object to cointain all WHOIS data (entity) in the object contact within the WHOIS.
- Keyword Arguments:
object_contact
: Dictionary containing all the WHOIS OBJECT CONTACT data as described in https://apility.io/apidocs/#whois-object-contact
- Attributes:
address
: List of contact postal address dictionaries. Contains key type and value.email
: List of contact email address dictionaries. Contains key type and value.kind
: The contact information kind (individual, group, org).name
: The contact name.phone
: List of contact phone number dictionaries. Contains key type and value.role
: The contact’s role.title
: The contact’s position or job title.
-
class
apilityio.model.
HistoryIPResponse
(status_code=200, error=None, history=None, json=None)¶ Response object with the result of a query to get the historical information of an IP address.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.history
: Dict structure with the list of ip transactions described in https://apility.io/apidocs/#transaction-ip
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.history
: List of ObjectsHistoryIP()
containing all transaction historical data.
-
class
apilityio.model.
HistoryIP
¶ Object to cointain the detals of a transaction of IP address in our database.
- Keyword Arguments:
transaction_ip
: Dictionary containing all the transaction IP address details as described in https://apility.io/apidocs/#transaction-ip
- Attributes:
timestamp
: The UNIX time in seconds when the transaction was performed.command
: ‘add’ or ‘rem’. Type of transaction in the database: ADD to the blacklist or REMove of the blacklist.ip
: IP address of the transactionblacklist_change
: Blackist added or removed thanks to the transaction.blacklists
: List of blacklists after the execution of the command and the blacklist change.
-
class
apilityio.model.
HistoryDomainResponse
(status_code=200, error=None, history=None, json=None)¶ Response object with the result of a query to get the historical information of a domain.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.history
: Dict structure with the list of domains transactions described in https://apility.io/apidocs/#transaction-domain
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.history
: List of ObjectsHistoryDomain()
containing all transaction historical data.
-
class
apilityio.model.
HistoryDomain
¶ Object to cointain the detals of a transaction of domain in our database.
- Keyword Arguments:
transaction_domain
: Dictionary containing all the transaction domain details as described in https://apility.io/apidocs/#transaction-domain
- Attributes:
timestamp
: The UNIX time in seconds when the transaction was performed.command
: ‘add’ or ‘rem’. Type of transaction in the database: ADD to the blacklist or REMove of the blacklist.domain
: Domain of the transactionblacklist_change
: Blackist added or removed thanks to the transaction.blacklists
: List of blacklists after the execution of the command and the blacklist change.
-
class
apilityio.model.
HistoryEmailResponse
(status_code=200, error=None, history=None, json=None)¶ Response object with the result of a query to get the historical information of an email.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.history
: Dict structure with the list of email transactions described in https://apility.io/apidocs/#transaction-email
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.history
: List of ObjectsHistoryEmail()
containing all transaction historical data.
-
class
apilityio.model.
HistoryEmail
¶ Object to cointain the detals of a transaction of email in our database.
- Keyword Arguments:
transaction_email
: Dictionary containing all the transaction email details as described in https://apility.io/apidocs/#transaction-email
- Attributes:
timestamp
: The UNIX time in seconds when the transaction was performed.command
: ‘add’ or ‘rem’. Type of transaction in the database: ADD to the blacklist or REMove of the blacklist.email
: Email of the transactionblacklist_change
: Blackist added or removed thanks to the transaction.blacklists
: List of blacklists after the execution of the command and the blacklist change.
-
class
apilityio.model.
QuarantineIPResponse
(status_code=200, error=None, quarantine=None, json=None)¶ Response object with the result of a query to get the IP addresses in the quarantine of the user.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.quarantine
: Dict structure with the list of pairs of IP addresses and TTL to stay in the quarantine
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.quarantine
: List of ObjectsQuarantineIP()
containing the pair IP address and TTL.
-
class
apilityio.model.
QuarantineIP
¶ Object to cointain the IP address and the Time to Live of the IP address in the quarantine list.
- Keyword Arguments:
quarantine_ip
: Dictionary containing the IP address and the TTL.
- Attributes:
ip
: IP address to add to QUARANTINE-IP blacklist.ttl
: Time to Live in seconds of the IP in the blacklist.
-
class
apilityio.model.
QuarantineCountryResponse
(status_code=200, error=None, quarantine=None, json=None)¶ Response object with the result of a query to get the countries in the quarantine of the user.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.quarantine
: Dict structure with the list of pairs of countries and TTL to stay in the quarantine
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.quarantine
: List of ObjectsQuarantineCountry()
containing the pair Country and TTL.
-
class
apilityio.model.
QuarantineCountry
¶ Object to cointain the Country and the Time to Live of the country in the quarantine list.
- Keyword Arguments:
quarantine_country
: Dictionary containing the Country and the TTL.
- Attributes:
country
: Country to add to QUARANTINE-COUNTRY blacklist.ttl
: Time to Live in seconds of the country in the blacklist.
-
class
apilityio.model.
QuarantineContinentResponse
(status_code=200, error=None, quarantine=None, json=None)¶ Response object with the result of a query to get the continents in the quarantine of the user.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.quarantine
: Dict structure with the list of pairs of continents and TTL to stay in the quarantine
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.quarantine
: List of ObjectsQuarantineContinent()
containing the pair Continent and TTL.
-
class
apilityio.model.
QuarantineContinent
¶ Object to cointain the Continent and the Time to Live of the continent in the quarantine list.
- Keyword Arguments:
quarantine_continent
: Dictionary containing the Continent and the TTL.
- Attributes:
continent
: Country to add to QUARANTINE-CONTINENT blacklist.ttl
: Time to Live in seconds of the continent in the blacklist.
-
class
apilityio.model.
QuarantineASResponse
(status_code=200, error=None, quarantine=None, json=None)¶ Response object with the result of a query to get the Autonomous System in the quarantine of the user.
- Keyword Arguments:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.quarantine
: Dict structure with the list of pairs of AS and TTL to stay in the quarantine
- Attributes:
status_code
: An integer with the HTTP response status code. See https://apility.io/apidocs/#errorserror
: If status code is not 200 (OK) or the error returned by the server.json
: JSON object returned by the REST API without modifications.quarantine
: List of ObjectsQuarantineAS()
containing the pair AS and TTL.
-
class
apilityio.model.
QuarantineAS
¶ Object to cointain the AS and the Time to Live of the continent in the quarantine list.
- Keyword Arguments:
quarantine_as
: Dictionary containing the AS and the TTL.
- Attributes:
asn
: Country to add to QUARANTINE-AS blacklist.ttl
: Time to Live in seconds of the continent in the blacklist.