Check IP Address
Retrieve detailed information about the reputation of a specific IP address.
For more information on the API for checking an IP address, see CHECK Endpoint (opens in a new tab).
SDK Import:
from admyral.actions import abuseipdb_analyze_ip
Arguments:
Argument Name | Description | Required |
---|---|---|
IP Address ip_address | The IP address to check. | Yes |
Verbose verbose | Include reports and the country name. Possible values: yes , no . Default: no . | - |
Max Age in Days max_age_in_days | The maximum age in days of reports to consider. Values must be >=1 and <=365 . Default: 30 . | - |
Returns
A JSON object.
Required Secrets
Secret Placeholder | Description |
---|---|
ABUSEIPDB_SECRET | AbuseIPDB secret. See AbuseIPDB setup |
SDK Example
result = abuseipdb_analyze_ip(
ip_address="118.25.6.39",
verbose="yes",
max_age_in_days=90
secrets={
"ABUSEIPDB_SECRET": "my_stored_abuseipdb_secret"
}
)
Example Output:
Typical successful response:
{
"ipAddress": "118.25.6.39",
"isPublic": true,
"ipVersion": 4,
"isWhitelisted": false,
"abuseConfidenceScore": 100,
"countryCode": "CN",
"countryName": "China",
"usageType": "Data Center/Web Hosting/Transit",
"isp": "Tencent Cloud Computing (Beijing) Co. Ltd",
"domain": "tencent.com",
"hostnames": [],
"isTor": false,
"totalReports": 1,
"numDistinctUsers": 1,
"lastReportedAt": "2018-12-20T20:55:14+00:00",
"reports": [
{
"reportedAt": "2018-12-20T20:55:14+00:00",
"comment": "Dec 20 20:55:14 srv206 sshd[13937]: Invalid user oracle from 118.25.6.39",
"categories": [18, 22],
"reporterId": 1,
"reporterCountryCode": "US",
"reporterCountryName": "United States"
}
]
}