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 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 ip string required host to submit, i e google com exclude engines string optional list of comma separated engines to exclude, i e blockedserversrbl,nordspam spamhaus key string optional your spamhaus zen dqs key " more info https //www spamhaus com/product/data query service/ ", this will enable spamhaus engine output parameter type description status code number http status code of the response reason string response reason phrase data object response data report object output field report host string output field host blacklists object output field blacklists engines object output field engines 5 object output field 5 6 object output field 6 7 object output field 7 8 object output field 8 detections number output field detections engines count number count value detection rate string output field detection rate scantime string time value server object output field server ip string output field ip reverse dns string output field reverse dns continent code string output field continent code continent name string name of the resource country code string output field country code country name string name of the resource region name string name of the resource city name string name of the resource latitude number output field latitude example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "data" {}, "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 ip string required ipv4 or ipv6 address to submit exclude engines string optional list of comma separated engines to exclude, i e blockedserversrbl,nordspam spamhaus key string optional your spamhaus zen dqs key " more info https //www spamhaus com/product/data query service/ ", this will enable spamhaus engine output parameter type description status code number http status code of the response reason string response reason phrase data object response data report object output field report ip string output field ip version string output field version blacklists object output field blacklists engines object output field engines 0 object output field 0 12 object output field 12 detections number output field detections engines count number count value detection rate string output field detection rate scantime string time value information object output field information reverse dns string output field reverse dns continent code string output field continent code continent name string name of the resource country code string output field country code country name string name of the resource country currency string output field country currency country calling code string output field country calling code region name string name of the resource city name string name of the resource latitude number output field latitude example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "data" {}, "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 url string required url to submit user agent string optional lets you change the browser user agent string, must be encoded referer string optional lets you change the referer url accept language string optional lets you change the accept language http header, format is like en or en us output parameter type description status code number http status code of the response reason string response reason phrase data object response data report object output field report dns records object output field dns records ns object output field ns records array output field records mx object output field mx records array output field records cname object name of the resource record string output field record domain blacklist object output field domain blacklist engines array output field engines name string name of the resource reference string output field reference detected number output field detected detections number output field detections file type object type of the resource signature string output field signature extension string output field extension headers string http headers for the request geo location object output field geo location countries array output field countries html forms object output field html forms number of total forms number output field number of total forms example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "data" {}, "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 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 notes api documentation https //docs apivoid com/