APIVoid APIs
APIVoid offers a set of APIs for domain, IP, and URL reputation analysis to enhance cybersecurity.
APIVoid offers a comprehensive suite of APIs for threat intelligence, focusing on domain, IP, and URL analysis. This connector enables Swimlane Turbine users to automate the retrieval of domain reputation, IP reputation, and URL risk assessments, enhancing their security operations. By integrating APIVoid with Swimlane Turbine, users can streamline threat detection and response processes, leveraging real-time data to make informed security decisions and mitigate risks effectively.
Prerequisites
Before you can use the APIVoid connector for Turbine, you'll need access to the APIVoid API. This requires the following:
- an API key authentication using the following parameters:
- URL: The endpoint URL for accessing APIVoid services.
- API Key: A unique key provided by APIVoid to authenticate requests.
Capabilities
This APIVoid APIs Connector has following capabilities:
- Domain Reputation
- Get Domain Information
- IP Reputation
- URL Reputation
Notes
Additional Documentation
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. Requires the 'ip' parameter for execution.
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 "more info", 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}
Get Domain Information
Retrieve Whois-like domain information from APIVoid, including registrar details, abuse email, owner organization and country, domain age, DNSSEC status, and nameservers. Requires the 'host' parameter for execution.
Endpoint
- URL: domaininfo/v1/pay-as-you-go/
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.host | string | Required | Domain (host) to submit, i.e google.com. |
Input Example
{"parameters":{"host":"google.com"}}
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.domain_age_found | boolean | Response data |
data.report.domain_registered | string | Response data |
data.report.domain_creation_date | string | Response data |
data.report.domain_age_in_days | number | Response data |
data.report.domain_age_in_months | number | Response data |
data.report.domain_age_in_years | number | Response data |
data.report.registrar | string | Response data |
data.report.registrar_url | string | Response data |
data.report.registrar_abuse_email | string | Response data |
data.report.registrar_abuse_form | string | Response data |
data.report.registrar_twitter | string | Response data |
data.report.owner_organization | string | Response data |
data.report.owner_country | string | Response data |
data.report.owner_state_province | string | Response data |
data.report.owner_email_hash | string | Response data |
data.report.owner_email_domain | string | Response data |
data.report.owner_free_email | boolean | Response data |
data.report.owner_private_person | boolean | Response data |
data.report.whois_data_hidden | boolean | Response data |
data.report.dnssec | string | Response data |
Output Example
{"data":{"report":{"host":"string","domain_age_found":true,"domain_registered":"string","domain_creation_date":"string","domain_age_in_days":123,"domain_age_in_months":123,"domain_age_in_years":123,"registrar":"string","registrar_url":"string","registrar_abuse_email":"string","registrar_abuse_form":"string","registrar_twitter":"string","owner_organization":"string","owner_country":"string","owner_state_province":"string"}},"credits_remained":123,"estimated_queries":"string","elapsed_time":"strin...
IP Reputation
Evaluate the reputation, geolocation, and detect proxies, web proxies, Tor, and VPNs for a given IPv4/IPv6 address using APIVoid. Requires IP parameter.
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 "more info", 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
Analyze a URL using 50+ security checks to assess risk score and identify potential phishing threats. Requires the 'url' parameter.
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 |
date | The date and time at which the message was originated | Thu, 25 Jul 2024 06:47:37 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 |