Get Malware Scan results

GET 
/documents/:documentId/malwareScan

Gets a Malware Scan results; available as an Add-On Module

Request

Path Parameters

documentId stringrequired

Document Identifier

Query Parameters

siteId string

Site Identifier

artifactId string

Artifact Document Identifier

next string

Next page of results token

limit string
Limit Results
Default value: 10

Responses

200

200 CREATED

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

malwareScanResults

object[]

List of Malware Scan Results

Array [

scanStatus MalwareScanStatus (string)

Document Malware scan result

Possible values: [MALICIOUS, ERROR, CLEAN]

scanEngine MalwareEngine (string)

Type of Malware Engine used

Possible values: [CLAM_AV]

s3version string

Document storage version

scanMessage string

Document Malware scan message

scannedDate string

Scanned Timestamp

]

Example (from schema)

{
  "next": "string",
  "malwareScanResults": [
    {
      "scanStatus": "MALICIOUS",
      "scanEngine": "CLAM_AV",
      "s3version": "string",
      "scanMessage": "string",
      "scannedDate": "string"
    }
  ]
}

400

400 BAD REQUEST

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...