Scans

Use the Bucketscan API to upload files, trigger scans, and retrieve scan results.

Uploads a file to initiate the virus scan

post

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

Responses

200

A reference to the file being scanned

application/json

scanIdstringOptional

statusnumberOptional

statusTextstringOptional

401

Unauthorized

404

Not Found

500

Server Error

post

/scans/initiate

HTTPcURLJavaScriptPython

POST /api/v1/scans/initiate HTTP/1.1
Host: bucketscan.com
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "scanId": "text",
  "status": 1,
  "statusText": "text"
}

Check the status of a scan

get

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

Path parameters

scanIdstringRequired

Responses

200

The status of the file scan

application/json

scanIdstringOptional

statusstring · enumOptionalPossible values:

401

Unauthorized

404

Not Found

500

Server Error

get

/scans/{scanId}

HTTPcURLJavaScriptPython

GET /api/v1/scans/{scanId} HTTP/1.1
Host: bucketscan.com
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "scanId": "text",
  "status": "pending"
}