Scanning APIs

Cloud Storage Security Scanning API

v1 OAS3

css_scanning_api_openapi_doc.json

HealthCheck

Scan

Token

PreviousDemo Videos NextSSO Integrations

Last updated 10 months ago

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

referenceIdstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Scan/JobStatus'

200

400

401

404

500

text/plain

application/json

text/json

{
  "result": "Clean",
  "errorMessage": "text",
  "dateScanned": "2025-02-21T18:23:24.601Z",
  "trueFileType": "text",
  "referenceId": "text",
  "detectedInfections": [
    {
      "file": "text",
      "infection": "text"
    }
  ]
}

Success

Scan a file that already exists in cloud storage

post

/api/Scan/Existing

Body

containerstringrequired

objectPathstringrequired

versionIdstring | nullable

uploadedBystring | nullable

fileSizeinteger · int64

lastModifiedstring · date-time

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Scan/Existing' \
  --header 'Content-Type: application/json' \
  --data '{"container":"text","objectPath":"text"}'

200

400

401

500

text/plain

application/json

text/json

{
  "result": "Clean",
  "errorMessage": "text",
  "dateScanned": "2025-02-21T18:23:24.601Z",
  "trueFileType": "text",
  "referenceId": "text",
  "detectedInfections": [
    {
      "file": "text",
      "infection": "text"
    }
  ]
}

Success

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

File-Namestring

Optional - for use when performing scan and upload only

Upload-Tostring

Optional - for use when performing scan and upload only

Body

string · binary

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Scan' \
  --header 'Content-Type: */*'

200

400

401

500

text/plain

application/json

text/json

{
  "result": "Clean",
  "errorMessage": "text",
  "dateScanned": "2025-02-21T18:23:24.601Z",
  "trueFileType": "text",
  "referenceId": "text",
  "detectedInfections": [
    {
      "file": "text",
      "infection": "text"
    }
  ]
}

Success

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

urlstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Scan/url' \
  --header 'Content-Type: multipart/form-data'

200

400

401

500

text/plain

application/json

text/json

{
  "result": "Clean",
  "errorMessage": "text",
  "dateScanned": "2025-02-21T18:23:24.601Z",
  "trueFileType": "text",
  "referenceId": "text",
  "detectedInfections": [
    {
      "file": "text",
      "infection": "text"
    }
  ]
}

Success

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

post

/api/Token

Body

usernamestringrequired

passwordstringrequired

mfaCodestring | nullable

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Token' \
  --header 'Content-Type: application/json' \
  --data '{"username":"text","password":"text"}'

200

401

text/plain

application/json

text/json

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

Success

Cloud Storage Security Scanning API

HealthCheck

Scan

Token

Cloud Storage Security Scanning API

HealthCheck

Scan

Token

Checks if the server is alive

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.

Scan a file that already exists in cloud storage

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.

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