Links

Scanning APIs

Cloud Storage Security Scanning API

v1 OAS3

HealthCheck

get
/health
Checks if the server is alive

Scan

get
/api/Scan/JobStatus
Check the status of an extra large file scan job. This could be used when a file larger than what can fit on the API's disk was submitted to be scanned via the scan existing API. The initial scan existing API request would have a reference ID returned back that would be included in this request.
post
/api/Scan/Existing
Scan a file that already exists in cloud storage
post
/api/Scan
Send a file to the API to be scanned. This can either be done via a multi-part file upload or a binary file transfer. If done as a binary file transfer, headers may be added to specify the file name and an upload destination (if desired). The upload destination is specified as an uploadTo form field when using multi-part form uploads.
post
/api/Scan/url
Scan a file that exists at an arbitrary url. For example, this may be a file on a generic public http(s) endpoint, or an object with a pre-signed url.

Token

post
/api/Token
Performs authentication for a user, returning the bearer token to be used for future API requests