Antivirus

The Antivirus API scans a file for trojans, viruses, malware & other malicious threats.

A file to be scanned can be uploaded in the API call or referenced by URL. This API is billed based on the amount of data scanned. You may want to lookup the md5 prior to running a scan to optimize costs.

Perform an antivirus scan on the file located at the url provided.

GET https://api.sitebot.com/api/v1/av/scan-url

Query Parameters

NameTypeDescription

url*

URL

The URL of a file to scan.

callback

URL

Send the scan result to this URL.

Headers

NameTypeDescription

x-key*

String

Your API Key.

{
   size: 11,
   md5: "5eb63bbbe01eeed093cb22bb8f5acdc3"
}

Perform an antivirus scan on the file uploaded.

POST https://api-upload.sitebot.com/api/v1/av/scan-upload

Note: There is a unique hostname for this API endpoint.

Headers

NameTypeDescription

x-callback

URL

Send the scan result to this URL.

x-key*

String

Your API Key.

{
   size: 11,
   md5: "5eb63bbbe01eeed093cb22bb8f5acdc3"
}

Lookup the antivirus summary of a md5 checksum.

GET https://api.sitebot.com/api/v1/av/lookup

A successful lookup will have one of the following status values: "working", "pass", "fail", "error".

Query Parameters

NameTypeDescription

md5*

String

The md5 checksum of a file.

Headers

NameTypeDescription

x-key*

String

Your API Key.

{
        "md5":"5eb63bbbe01eeed093cb22bb8f5acdc3",
        "size":11,
        "status":3,
        "status_display":"Fail",
        "fail":1,
        "pass":0
}

Callback URL

An optional callback URL can be provided in the scan-url and scan-upload methods. When the scan completes the json body of the lookup method will be posted to the callback URL.

Example URL

curl --header "x-key: [YOUR-API-KEY]" \
"https://api.sitebot.com/api/v1/av/scan-url.json?url=[URL-TO-SCAN]&callback=[CALLBACK-URL]"

Example Upload

curl --header "x-key: [YOUR-API-KEY]" \
--header "content-type: application/octet-stream" \
--header "x-callback: https://www.mywebsite/rpc/sitebot-callback" \
--data-binary "@/path/to/file" \
"https://api-upload.sitebot.com/api/v1/av/scan-upload"

Last updated