Server
[http|https]://<your My OPSWAT server URL>
My OPSWAT Cloud: https://product.my.opswat.com
Server Variables

A token can be generated from a secret key that is managed on My OPSWAT console. This can be used as an API Key for API calls that require authentication. This token has expiration time, your application needs to re-generate a new token when it's expired.

Auth

BearerToken

Obtain an access token for API authentication

Obtain an access token for API authentication. This is required for accessing all APIs. Please note that an old access token will become invalid when a new access token is issued for a secret key.

Auth
Request Body
objectobject
keystring

a secret key that can be obtained from the My OPSWAT console

POST /api/console/get-token
Copy
Responses
200

OK

objectobject
accessTokenstring

an access token for API authentication

expiredIninteger

the duration until the access token expires in seconds

400

Bad Request

Response
Copy

Retrieve account inventory or a specific product inventory

Retrieve account inventory or a specific product inventory based on filter criteria.

Product Type Product Name
MK5 MetaDefender Kiosk L-Series
VAULT MetaDefender Managed File Transfer
MDICAP MetaDefender ICAP Server
MDCORE MetaDefender Core
UF3 MetaDefender Media Firewall
MDD MetaDefender Drive
FSCAN MetaDefender Sandbox
NEURALYZER MetaDefender OT Security
OTFUSE MetaDefender Industrial Firewall & IPS
MDSS MetaDefender Storage Security
MDEMAIL MetaDefender Email Gateway Security
NWUSGBLUE MetaDefender Unidirectional Security Gateway Blue
NWUSGRED MetaDefender Unidirectional Security Gateway Red
NWBSGBLUE MetaDefender Bilateral Security Gateway Blue
NWBSGRED MetaDefender Bilateral Security Gateway Red
NWTPBLUE MetaDefender Transfer Guard Blue
NWTPRED MetaDefender Transfer Guard Red
NWODBLUE MetaDefender Optical Diode Blue
NWODRED MetaDefender Optical Diode Red
MDSSC MetaDefender Software Supply Chain
KIOSK MetaDefender Kiosk K-Series

Auth
Headers
Content-Typestring

application/json

Request Body
objectobject
filtersobject

Filter data

productTypesarray[string]
POST /api/console/public/v1/account/inventory
Copy
Responses
200

OK

arrayarray[object]
productNamestring
productTypestring

Enum: MDCORE

totalInstancesinteger

total instances

connectivityobject
noLicenseinteger
disconnectedinteger
pendinginteger
connectedinteger
healthobject
operationalinteger
minorIssuesinteger
criticalIssuesinteger
unknowninteger
significantIssuesinteger
versionarray[object]
valuestring
totalinteger
statusstring
licenseobject
expiredIn30Daysinteger
expiredIn90Daysinteger
expiredIn90PlusDaysinteger
expiredinteger
noLicenseinteger
storageCapacityobject
401

Unauthorized

403

Forbdden

429

Rate limit

Response
Copy

Retrieve processing overview from MetaDefender Core instances

Retrieve processing overview from MetaDefender Core instances based on filter criteria over a specified time period. To optimize query time, calculate result is cached by day. Recommendation: run queries for the full day (00:00–24:00 UTC) to take advantage of the caching mechanism.

Auth
Headers
Content-Typestring

application/json

Request Body
objectobject
filtersobject

Filter criteria

instanceIdsarray[string]
groupIdsarray[string]
startTimeinteger
endTimeinteger
groupBystring

Enum: groups,instances

POST /api/console/public/v1/mdcore/processing-overview
Copy
Responses
200

OK

objectobject
totalProcessedFilesinteger
totalProcessedObjectsinteger
totalBlockedFilesinteger
totalBlockedObjectsinteger
totalObjectsWithThreatsinteger
totalFilesWithThreatsinteger
totalUsersSubmittedScansinteger
totalUniqueUsersSubmittedScansinteger
avgScanTimePerObjectinteger
avgScanTimePerFileinteger
groupsarray[object]
groupNamestring
groupIdstring
totalProcessedFilesinteger
totalProcessedObjectsinteger
totalBlockedFilesinteger
totalBlockedObjectsinteger
totalObjectsWithThreatsinteger
totalFilesWithThreatsinteger
totalUsersSubmittedScansinteger
totalUniqueUsersSubmittedScansinteger
avgScanTimePerObjectinteger
avgScanTimePerFileinteger
400

Bad Request

401

Unauthorized

403

Forbdden

429

Rate limit

Response
Copy

Processing Overview from MetaDefender Kiosk instances

Retrieve processing overview from MetaDefender Kiosk K-Series and L-Series instances based on filter criteria over a specified time period

Auth
Headers
Content-Typestring

application/json

Request Body
objectobject
filtersobject

Filter criteria

instanceIdsarray[string]
groupIdsarray[string]
startTimeinteger

timestamp in miliseconds

endTimeinteger

timestamp in miliseconds

groupBystring

Enum: groups,instances

POST /api/console/public/v1/kiosks/processing-overview
Copy
Responses
200

OK

objectobject
numberOfSessionsinteger

total number of scan sessions during the selected time period and based on the applied filters

numberOfFilesProcessedinteger
numberOfSessionsWithThreatsDetectedinteger
numberOfThreatsFoundinteger
numberOfFilesSanitizedinteger
numberOfFilesMovedToMFTinteger
avgTimeOfASessionInMinutesinteger
groupsarray[object]

this array will be returned when groupBy is set to 'groups'

idstring
namestring
numberOfSessionsinteger
numberOfFilesProcessedinteger
numberOfSessionsWithThreatsDetectedinteger
numberOfThreatsFoundinteger
numberOfFilesSanitizedinteger
numberOfFilesMovedToMFTinteger
avgTimeOfASessionInMinutesinteger
400

Bad Request

401

Unauthorized

403

Forbdden

429

Rate limit

Response
Copy

Change module update settings for MetaDefender Core instances

Allow users to change module update settings for MetaDefender Core instances

Auth
Headers
Content-Typestring

application/json

Request Body
objectobject
deploymentIdstring
sourcestring

Enum: internet,folder,manually

PUT /api/console/public/v1/mdcore/updateModuleSource
Copy
Responses
200

OK

No response body
400

Bad Request

401

Unauthorized

403

Forbdden

429

Rate limit

Response
Copy

Retrieve details of blocked files

Retrieve details of blocked files from MetaDefencer Core instances based on filter criteria over a specified time period

Auth
Headers
Content-Typestring

application/json

Request Body
objectobject
filtersobject

Filter criteria

instanceIdsarray[string]
groupIdsarray[string]
startTimeinteger

timestamp in miliseconds

endTimeinteger

timestamp in miliseconds

pageinteger
limitinteger
POST /api/console/public/v1/mdcore/blocked-files
Copy
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbdden

429

Rate limit

Response
Copy

Retrieve MetaDefender Kiosk scan sessions

Auth
Headers
Content-Typestring

application/json

Request Body
objectobject
filtersobject

Filter criteria

instanceIdsarray[string]
groupIdsarray[string]
startTimeinteger

timestamp in miliseconds

endTimeinteger

timestamp in miliseconds

pageinteger
limitinteger
POST /api/console/public/v1/kiosks/scan-reports/search
Copy
Responses
200

OK

arrayarray[object]
instanceIdstring
instanceNamestring
deploymentIdstring
groupIdstring
groupNamestring
sessionStartinteger
sessionEndinteger
reportTimeinteger
productTypestring
userInfoobject
profileIDstring
userNamestring
vault_idobject
*string
user_question_answerarray[object]
*string
400

Bad Request

401

Unauthorized

403

Forbidden

429

Rate limit

Retrieve processing history of MetaDefender Core instances

Retrieve details of blocked files from MetaDefencer Core instances based on filter criteria over a specified time period

Auth
Headers
Content-Typestring

application/json

Request Body
objectobject
filtersobject

Filter criteria

instanceIdsarray[string]
groupIdsarray[string]
statusarray[string]

Enum: Blocked,Allowed,Processing

startTimeinteger

timestamp in miliseconds

endTimeinteger

timestamp in miliseconds

pageinteger
limitinteger
POST /api/console/public/v1/mdcore/process-history-files/search
Copy
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbdden

429

Rate limit

Response
Copy

Retrieve processing history of MetaDefender Core instances

Retrieve details of processing history from MetaDefender Core instances based on filter criteria over a specified time period

Auth
Headers
Content-Typestring

application/json

Request Body
objectobject
filtersobject

Default: {}

instanceIdsarray[string]

Default: []

groupIdsarray[string]

Default: []

requestTypesarray[string]

rest - all files which are not batch, extracted - all objects in a file, batch - all scan sessions, batched - all files in a batch, non-batch can be filtered by [ rest, extracted, batched]

Enum: rest,extracted,batch,batched

Default: []

statusesarray[string]

Enum: Allowed,Blocked

Default: []

startTimeint64
endTimeint64
limitinteger

maximum: 100

minimum: 1

nextTokenstring
POST /api/console/public/v2/mdcore/process-history-files/search
Copy
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

429

Rate limit