NAME

WebService::AbuseIPDB::CheckResponse - Specific class for responses to check method

SYNOPSIS

The check method of WebService::AbuseIPDB will return an object of this class. It is a subclass of the generic WebService::AbuseIPDB::Response class.

    use WebService::AbuseIPDB;

    my $ipdb = WebService::AbuseIPDB->new (key => 'abc123...');
    my $res = $ipdb->check (ip => '127.0.0.2');
    unless ($res->successful) {
        for my $err (@{$res->errors}) {
            warn "Error $err->{status}: $err->{detail}\n";
        }
        die "Cannot continue.\n";
    }
    printf "%s has a score of %i, last reported at %s\n",
        $res->ip, $res->score, $res->last_report_time;

METHODS

The new, successful and errors methods are inherited from WebService::AbuseIPDB::Response. All other methods are accessors as listed here.

cc

Returns the 2-letter country code of this IP address.

score

Returns the abuse score as an integer between 0 and 100 inclusive.

report_count

Returns the total number of reports of this address in the requested date range as a whole number.

isp

Returns the ISP of this IP address, according to AbuseIPDB records.

last_report_time

Returns the time of the last report of this address as "YYYY-MM-DDTHH:MM:SS+HH:MM".

usage_type

Returns the usage type of this IP address, according to AbuseIPDB records.

whitelisted

Returns true if AbuseIPDB has whitelisted this address for some reason.

ip

Returns the IP address itself as a string.

ipv

Returns the version of the IP address as an integer (ie. 6 or 4).

public

Returns true if the IP address is a public address, otherwise false.

reporter_count

Returns the number of distinct users who have reported this IP address in the requested date range.

domain

Returns the domain of this IP address, according to AbuseIPDB records.

STABILITY

This is currently alpha software. Be aware that both the internals and the interface are liable to change.

AUTHOR

Pete Houston, <cpan at openstrike.co.uk>

SEE ALSO

WebService::AbuseIPDB for general use of the client, WebService::AbuseIPDB::Response for the parent class and Version 2 of the AbuseIPDB API for API details/restrictions.

LICENCE AND COPYRIGHT

Copyright © 2020 Pete Houston

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 dated June, 1991 or at your option any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

A copy of the GNU General Public License is available in the source tree; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA