NAME
VT::API - Perl implementation of VirusTotal Public API
VERSION
This documentation refers to VT::API version 0.10
SYNOPSYS
use VT::API;
# OO-interface.
my $api = VT::API->new(key => 'YOUR_PUBLIC_KEY');
# Retrieve a file scan report.
# If query successfull hash reference returned.
my $res1 = $api->get_file_report('md5/sha1/sha256 or permalink identifier');
# Send and scan a file.
my $res2 = $api->scan_file('/file/path');
# Retrieve a URL scan report
my $res3 = $api->get_url_report('http://www.example.com/');
# Submit and scan a URL.
my $res4 = $api->scan_url('http://www.example.com/');
# Make comments on files and URLs.
my $res5 = $api->make_comment('file path or URL', 'Your comment', 'tag1,tag2');
...DESCRIPTION
VT::API provides unofficial OO interface to VirusTotal Public API. Please see the terms of use for more information.
OPTIONS
The options bellow are passed through the constructor of interface.
key => Your Key
Your API key. You will find your personal API key in the inbox of your account.
agent => string
Defines a User-Agent. Default is Perl/VT-API.
timeout => value
Timeout value in seconds. The default value is 180.
METHODS
VT::API methods.
my $api = VT::API->new(key => 'Public Key')
$api->get_file_report( $resource )
$api->scan_file( $file )
$api->get_url_report( $resource )
$api->scan_url( $url )
$api->make_comment( $file_or_url, $comment, $tags )
errstr()
BUGS AND LIMITATIONS
None known at this time.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc VT::APIINFORMATION
You can also look for information at:
VirusTotal official website
VirusTotal terms of use
AUTHOR
Written by Alexander Nusov.
COPYRIGHTS AND LICENSE
Copyright (C) 2010, Alexander Nusov <cpan at sancode.net>
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.