Bucketscan Docs
Bucketscan Docs
  • Welcome
  • Getting Started
    • Quickstart
      • Using the API
  • API
    • Scans
Powered by GitBook
On this page
  1. API

Scans

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

PreviousUsing the API

Last updated 6 months ago

Uploads a file to initiate the virus scan

post
Authorizations
Responses
200
A reference to the file being scanned
application/json
401
Unauthorized
404
Not Found
500
Server Error
post
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
Path parameters
scanIdstringRequired
Responses
200
The status of the file scan
application/json
401
Unauthorized
404
Not Found
500
Server Error
get
GET /api/v1/scans/{scanId} HTTP/1.1
Host: bucketscan.com
X-Api-Key: YOUR_API_KEY
Accept: */*
{
  "scanId": "text",
  "status": "pending"
}
  • POSTUploads a file to initiate the virus scan
  • GETCheck the status of a scan