Scanning APIs

Cloud Storage Security Scanning API

v1 OAS3

css_scanning_api_openapi_doc.json

HealthCheck

Checks if the server is alive

GET/health

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Scan

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.

GET/api/Scan/JobStatus

Query parameters

Response

200400401404500

Success

Body

text/plainapplication/jsontext/json

resultResult (enum)

CleanInfectedInfectedAllowedErrorUnscannableUnknownPending

detectedInfectionsnullable array of DetectedInfection (object)

errorMessagenullable string

dateScannedstring (date-time)

trueFileTypenullable string

referenceIdnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/Scan/JobStatus', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404

{
  "result": "Clean",
  "detectedInfections": [
    {
      "file": "text",
      "infection": "text"
    }
  ],
  "errorMessage": "text",
  "dateScanned": "2024-11-20T10:17:28.971Z",
  "trueFileType": "text",
  "referenceId": "text"
}

Scan a file that already exists in cloud storage

POST/api/Scan/Existing

Body

application/jsontext/jsonapplication/*+json

container*string

objectPath*string

versionIdnullable string

uploadedBynullable string

fileSizeinteger (int64)

lastModifiedstring (date-time)

Response

200400401500

Success

Body

text/plainapplication/jsontext/json

resultResult (enum)

CleanInfectedInfectedAllowedErrorUnscannableUnknownPending

detectedInfectionsnullable array of DetectedInfection (object)

errorMessagenullable string

dateScannedstring (date-time)

trueFileTypenullable string

referenceIdnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/Scan/Existing', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "container": "text",
      "objectPath": "text"
    }),
});
const data = await response.json();

Response

200400401

{
  "result": "Clean",
  "detectedInfections": [
    {
      "file": "text",
      "infection": "text"
    }
  ],
  "errorMessage": "text",
  "dateScanned": "2024-11-20T10:17:28.971Z",
  "trueFileType": "text",
  "referenceId": "text"
}

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

Header parameters

Body

multipart/form-data*/*

fileNamestring (binary)

uploadTostring

Response

200400401500

Success

Body

text/plainapplication/jsontext/json

resultResult (enum)

CleanInfectedInfectedAllowedErrorUnscannableUnknownPending

detectedInfectionsnullable array of DetectedInfection (object)

errorMessagenullable string

dateScannedstring (date-time)

trueFileTypenullable string

referenceIdnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/Scan', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401

{
  "result": "Clean",
  "detectedInfections": [
    {
      "file": "text",
      "infection": "text"
    }
  ],
  "errorMessage": "text",
  "dateScanned": "2024-11-20T10:17:28.971Z",
  "trueFileType": "text",
  "referenceId": "text"
}

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.

POST/api/Scan/url

Body

multipart/form-data

urlstring

Response

200400401500

Success

Body

text/plainapplication/jsontext/json

resultResult (enum)

CleanInfectedInfectedAllowedErrorUnscannableUnknownPending

detectedInfectionsnullable array of DetectedInfection (object)

errorMessagenullable string

dateScannedstring (date-time)

trueFileTypenullable string

referenceIdnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/Scan/url', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401

{
  "result": "Clean",
  "detectedInfections": [
    {
      "file": "text",
      "infection": "text"
    }
  ],
  "errorMessage": "text",
  "dateScanned": "2024-11-20T10:17:28.971Z",
  "trueFileType": "text",
  "referenceId": "text"
}

Token

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

POST/api/Token

Body

application/jsontext/jsonapplication/*+json

username*string

password*string

mfaCodenullable string

Response

200401

Success

Body

text/plainapplication/jsontext/json

accessToken*string

tokenType*string

expiresIn*integer (int32)

Request

JavaScriptCurlPython

const response = await fetch('/api/Token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "password": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

200401

{
  "accessToken": "text",
  "tokenType": "text"
}