APIVoid APIs
18 min
the apivoid connector provides actionable security insights by analyzing domain, ip, and url reputations through various checks and intelligence feeds apivoid provides a suite of essential cybersecurity services, including domain, ip, and url reputation checks this connector enables swimlane turbine users to integrate apivoid's capabilities directly into their security workflows, allowing for automated analysis of indicators of compromise (iocs) by leveraging apivoid's detailed reports on blacklist status, geolocation, and proxy detection, security teams can enhance their threat intelligence and incident response strategies the integration streamlines the process of assessing potential threats, saving time and improving the accuracy of security operations prerequisites to effectively utilize the apivoid connector within swimlane turbine, ensure you have the following prerequisites api key authentication with the required parameters url the endpoint url for the apivoid service api key your unique api key provided by apivoid to access their services capabilities this apivoid apis connector has following capabilities domain reputation ip reputation url reputation notes https //docs apivoid com/ configurations apivoid apis api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required key api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions domain reputation check a domain's blacklist status, ip address, and geolocation details using apivoid endpoint url domainbl/v1/pay as you go/ method get input argument name type required description parameters ip string required host to submit, i e google com parameters exclude engines string optional list of comma separated engines to exclude, i e blockedserversrbl,nordspam parameters spamhaus key string optional your spamhaus zen dqs key " https //www spamhaus com/product/data query service/ ", this will enable spamhaus engine input example {"parameters" {"host" "google com","exclude engines" "malc0de,spam404","spamhaus key" "dfaesadsad"}} output parameter type description status code number http status code of the response reason string response reason phrase data object response data data report object response data data report host string response data data report blacklists object response data data report blacklists engines object response data data report blacklists engines 5 object response data data report blacklists engines 6 object response data data report blacklists engines 7 object response data data report blacklists engines 8 object response data data report blacklists detections number response data data report blacklists engines count number response data data report blacklists detection rate string response data data report blacklists scantime string response data data report server object response data data report server ip string response data data report server reverse dns string response data data report server continent code string response data data report server continent name string response data data report server country code string response data data report server country name string response data data report server region name string response data data report server city name string response data data report server latitude number response data output example {"data" {"report" {"host" "string","blacklists" {},"server" {},"category" {},"security checks" {},"risk score" {}}},"credits remained" 123,"estimated queries" "string","elapsed time" "string","success"\ true} ip reputation evaluates the reputation, geolocation, and detects proxies, web proxies, tor, and vpns for a given ipv4/ipv6 address using apivoid endpoint url iprep/v1/pay as you go/ method get input argument name type required description parameters ip string required ipv4 or ipv6 address to submit parameters exclude engines string optional list of comma separated engines to exclude, i e blockedserversrbl,nordspam parameters spamhaus key string optional your spamhaus zen dqs key " https //www spamhaus com/product/data query service/ ", this will enable spamhaus engine input example {"parameters" {"ip" "64 190 63 222","exclude engines" "blockedserversrbl,nordspam","spamhaus key" "dfaesadsad"}} output parameter type description status code number http status code of the response reason string response reason phrase data object response data data report object response data data report ip string response data data report version string response data data report blacklists object response data data report blacklists engines object response data data report blacklists engines 0 object response data data report blacklists engines 12 object response data data report blacklists detections number response data data report blacklists engines count number response data data report blacklists detection rate string response data data report blacklists scantime string response data data report information object response data data report information reverse dns string response data data report information continent code string response data data report information continent name string response data data report information country code string response data data report information country name string response data data report information country currency string response data data report information country calling code string response data data report information region name string response data data report information city name string response data data report information latitude number response data output example {"data" {"report" {"ip" "string","version" "string","blacklists" {},"information" {},"anonymity" {},"risk score" {}}},"credits remained" 123,"estimated queries" "string","elapsed time" "string","success"\ true} url reputation analyzes a url with 50+ security checks to assess risk score and identify potential phishing threats endpoint url urlrep/v1/pay as you go/ method get input argument name type required description parameters url string required url to submit parameters user agent string optional lets you change the browser user agent string, must be encoded parameters referer string optional lets you change the referer url parameters accept language string optional lets you change the accept language http header, format is like en or en us input example {"parameters" {"url" "https //example com/api/resource","user agent" "string","referer" "string","accept language" "en us"}} output parameter type description status code number http status code of the response reason string response reason phrase data object response data data report object response data data report dns records object response data data report dns records ns object response data data report dns records ns records array response data data report dns records mx object response data data report dns records mx records array response data data report dns records cname object response data data report dns records cname record string response data data report domain blacklist object response data data report domain blacklist engines array response data data report domain blacklist engines name string response data data report domain blacklist engines reference string response data data report domain blacklist engines detected number response data data report domain blacklist detections number response data data report file type object response data data report file type signature string response data data report file type extension string response data data report file type headers string response data data report geo location object response data data report geo location countries array response data data report html forms object response data data report html forms number of total forms number response data output example {"data" {"report" {"dns records" {},"domain blacklist" {},"file type" {},"geo location" {},"html forms" {},"redirection" {},"risk score" {},"security checks" {},"server details" {},"site category" {},"url parts" {},"web page" {}}},"credits remained" 123,"estimated queries" "string","elapsed time" "string","success"\ true} response headers header description example access control allow origin http response header access control allow origin alt svc http response header alt svc h3=" 443 "; ma=2592000,h3 29=" 443 "; ma=2592000 content type the media type of the resource application/json; charset=utf 8 date the date and time at which the message was originated thu, 25 jul 2024 06 32 23 gmt server information about the software used by the origin server nginx transfer encoding http response header transfer encoding chunked via http response header via 1 1 google x content type options http response header x content type options nosniff x frame options http response header x frame options sameorigin x robots tag http response header x robots tag noindex,nofollow,noimageindex,noarchive,nosnippet x xss protection http response header x xss protection 1; mode=block