MetaDefender for Secure Storage API v1

/api/audit/{startIndex}/{count}

Fetch audit logs

Auth

Path Params

startIndex	string
count	string

Query String

logType	string
categoryType	string
logLevel	string
searchText	string

GET /api/audit/{startIndex}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/audit/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}' \ --data logType={logType} \ --data categoryType={categoryType} \ --data logLevel={logLevel} \ --data searchText={searchText}
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
logLevel	int32	0 = Debug, 1 = Info, 2 = Warn, 3 = Error Enum: `0`,`1`,`2`,`3`
details	string
logType	int32	Enum: `0`,`1`,`2`,`100`,`101`,`102`,`103`,`200`,`201`,`202`,`203`,`204`,`205`,`206`,`207`,`208`,`300`,`301`,`302`,`350`,`351`,`400`,`410`,`411`,`412`,`413`,`414`,`415`,`416`,`417`,`418`,`600`,`601`,`602`,`603`,`604`,`605`,`606`,`700`,`701`,`702`,`703`,`750`,`751`,`752`,`753`,`800`,`801`,`802`,`900`,`901`,`950`,`975`,`1000`,`1001`,`1002`,`1100`,`1200`,`1201`,`1202`,`1300`,`1400`,`1401`,`1402`,`1403`,`1404`,`1500`,`1501`,`1502`
userId	string
category	int32	Enum: `0`,`1`,`2`,`3`,`4`,`6`,`7`,`8`
timeStamp	date-time
userName	string
filterCount	int64
totalCount	int64

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [  {   "id": "{string}",   "logLevel": "{int32}",   "details": "{string}",   "logType": "{int32}",   "userId": "{string}",   "category": "{int32}",   "timeStamp": "{date-time}",   "userName": "{string}"  } ], "filterCount": "{int64}", "totalCount": "{int64}"}
Copy

Configuration

Import or export configuration file

/api/configuration/export

/api/configuration/import

/api/configuration/enabledModules

Export configuration file

Auth

Query String

exportLicense	boolean
exportSmtp	boolean
exportEmailNotifications	boolean

GET /api/configuration/export

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/configuration/export' \ --header 'Authorization: Bearer {token}' \ --data exportLicense={exportLicense} \ --data exportSmtp={exportSmtp} \ --data exportEmailNotifications={exportEmailNotifications}
Copy

Responses

200

Success

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
Copy

Import configuration file

Auth

Request Body

object	object
ConfigurationFile	file

POST /api/configuration/import

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/configuration/import' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

enabledModules

Auth

GET /api/configuration/enabledModules

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/configuration/enabledModules' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
enabledModules	array[integer]

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "enabledModules": [  "{array[integer]...}" ]}
Copy

Deep Cdr

Manage sanitized files

/api/DeepCdr/revert/{fileId}

Revert encrypted file

Auth

Path Params

fileId string

POST /api/DeepCdr/revert/{fileId}

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/DeepCdr/revert/%7BfileId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

External Logger

Manage external loggers

/api/ExternalLogger

/api/ExternalLogger/status

/api/ExternalLogger/udpSyslog

/api/ExternalLogger/udpSyslog

/api/ExternalLogger/{id}

Retrieve external loggers

Auth

GET /api/ExternalLogger

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ExternalLogger' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
result	int32	Enum: `0`,`1`,`2`
entries	array[object]
id	string
isEnabled	boolean
loggerType	int32	0 = UdpSyslog Enum: `0`
connectionSettings	object

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "result": "{int32}", "entries": [  {   "id": "{string}",   "isEnabled": "{boolean}",   "loggerType": "{int32}",   "connectionSettings": {}  } ]}
Copy

Update external logger state

Auth

Request Body

object	object
id	string
isEnabled	boolean

PUT /api/ExternalLogger/status

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/ExternalLogger/status' \ --header 'Authorization: Bearer {token}' \ --data '{  "id": "{string}",  "isEnabled": "{boolean}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update a Syslog server configuration

Auth

Request Body

object	object
isEnabled	boolean
serverAddress	string	minLength: 1 pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]))$\|^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$\|^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z]\|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$
port	int32	pattern: `^()([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])$`
loggerType	int32	0 = UdpSyslog Enum: `0`
facility	int32	0 = KernelMessages, 1 = UserLevelMessages, 2 = MailSystem, 3 = SystemDaemons, 4 = SecurityOrAuthorizationMessages1, 5 = InternalMessages, 6 = LinePrinterSubsystem, 7 = NetworkNewsSubsystem, 8 = UUCPSubsystem, 9 = ClockDaemon1, 10 = SecurityOrAuthorizationMessages2, 11 = FTPDaemon, 12 = NTPSubsystem, 13 = LogAudit, 14 = LogAlert, 15 = ClockDaemon2, 16 = LocalUse0, 17 = LocalUse1, 18 = LocalUse2, 19 = LocalUse3, 20 = LocalUse4, 21 = LocalUse5, 22 = LocalUse6, 23 = LocalUse7 Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`21`,`22`,`23`
format	int32	0 = RFC5424 Enum: `0`
id	string	minLength: 1

Expand

PUT /api/ExternalLogger/udpSyslog

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/ExternalLogger/udpSyslog' \ --header 'Authorization: Bearer {token}' \ --data '{  "isEnabled": "{boolean}",  "serverAddress": "{string}",  "port": "{int32}",  "loggerType": "{int32}",  "facility": "{int32}",  "format": "{int32}",  "id": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Add a new Syslog server configuration

Auth

Request Body

object	object
isEnabled	boolean
serverAddress	string	minLength: 1 pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]))$\|^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$\|^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z]\|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$
port	int32	pattern: `^()([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])$`
loggerType	int32	0 = UdpSyslog Enum: `0`
facility	int32	0 = KernelMessages, 1 = UserLevelMessages, 2 = MailSystem, 3 = SystemDaemons, 4 = SecurityOrAuthorizationMessages1, 5 = InternalMessages, 6 = LinePrinterSubsystem, 7 = NetworkNewsSubsystem, 8 = UUCPSubsystem, 9 = ClockDaemon1, 10 = SecurityOrAuthorizationMessages2, 11 = FTPDaemon, 12 = NTPSubsystem, 13 = LogAudit, 14 = LogAlert, 15 = ClockDaemon2, 16 = LocalUse0, 17 = LocalUse1, 18 = LocalUse2, 19 = LocalUse3, 20 = LocalUse4, 21 = LocalUse5, 22 = LocalUse6, 23 = LocalUse7 Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`21`,`22`,`23`
format	int32	0 = RFC5424 Enum: `0`

Expand

POST /api/ExternalLogger/udpSyslog

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/ExternalLogger/udpSyslog' \ --header 'Authorization: Bearer {token}' \ --data '{  "isEnabled": "{boolean}",  "serverAddress": "{string}",  "port": "{int32}",  "loggerType": "{int32}",  "facility": "{int32}",  "format": "{int32}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete external logger

Auth

Path Params

id string

DELETE /api/ExternalLogger/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/ExternalLogger/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

File

Retrieve processed files information

/api/file/{fileId}

/api/file/{scanId}/{startIndex}/{count}

Fetch processing results for a file

File processing is done asynchronously and each analysis request is tracked by a file ID. Because processing a file is a potentially time-consuming operation, scheduling a file for processing and retrieving the results needs to be done using two separate API calls.

This request needs to be made multiple times until the analysis is complete. Analysis completion can be tracked using the processingState and the progress values from the response..

Auth

Path Params

fileId string

GET /api/file/{fileId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/file/%7BfileId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
scanId	string
name	string
path	string
hash	string
fileOwner	object
userId	string
fullName	string
userName	string
emailAddress	string
size	int64
storageType	object
name	string
categoryType	int32	0 = Local, 1 = Cloud, 2 = Object Enum: `0`,`1`,`2`
protocolType	int32	0 = Smb, 1 = GraphSdk, 2 = BoxSdk, 3 = AwsSdk, 4 = AzureBlobSdk, 5 = AlibabaCloudSdk, 6 = GoogleCloudSdk, 7 = AzureFilesSdk, 8 = Sftp Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
vendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
storageName	string
storageLocation	string
scanName	string
progress	object
upload	int32
scan	int32
scanResult	object
extractedFiles	object
dataId	string
scanResultI	int32
detectedBy	int32
filesInArchive	array[object]
displayName	string
dataId	string
fileType	string
fileTypeDescription	string
scanResultI	int32
scanAllResultI	int32
detectedBy	int32
scannedWith	int32
progressPercentage	int32
fileSize	int64
processInfo	object
postProcessing	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	int32	0 = Allowed, 1 = Blocked, 2 = Processing Enum: `0`,`1`,`2`
filesExtractedCount	int32
scanResults	object
scanDetails	array[object]
engineName	string
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
engId	string
waitTime	number
dataId	string
scanAllResultI	int32
scanAllResultA	string
startTime	string
totalTime	number
totalAvs	int32
progressPercentage	int32
fileInfo	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo	object
postProcessing	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	int32	0 = Allowed, 1 = Blocked, 2 = Processing Enum: `0`,`1`,`2`
dataId	string
dlpInfo	object
verdict	int64
vulnerabilityInfo	object
vulnerabilityInfoResult	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct	object
hasVulnerability	boolean
isCurrent	boolean
product	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor	object
id	int64
name	string
version	string
versionData	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details	object
cpe	string
cve	string
cvss	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3	object
attackComplexity	string
attackVector	string
availabilityImpact	string
baseScore	string
baseSeverity	string
confidentialityImpact	string
exploitabilityScore	string
impactScore	string
integrityImpact	string
privilegesRequired	string
scope	string
userInteraction	string
vectorString	string
cwe	string
lastModifiedEpoch	string
publishedEpoch	string
references	array[string]
severity	string
severityIndex	int32
staticId	int64
sessionCookie	string
processingState	int32	0 = InProgress, 1 = Failed, 2 = Canceled, 3 = Available Enum: `0`,`1`,`2`,`3`
exception	object
exceptionDetails	string
exceptionMessage	string
created	date-time
lastModified	date-time
discoveryStarted	date-time
fileProcessingDetails	object
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
coreEngines	array[object]
engineId	string
engineName	string
engineVersion	string
dbVersion	string
definitionTime	string
remediation	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
deepCdr	object
isSanitized	boolean
isEncrypted	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
decryptStatus	int32	0 = NotStarted, 1 = InProgress, 2 = Completed Enum: `0`,`1`,`2`
deepCdrOriginalObjectHandlingType	int32	0 = Keep, 1 = Encrypt, 2 = Delete Enum: `0`,`1`,`2`
sanitizationDetails	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	int32	0 = Tagging, 1 = DeepCdrSanitization, 2 = DeepCdrDelete, 3 = DeepCdrEncrypt, 4 = DeepCdrKeep, 5 = AllowedMoved, 6 = BlockedMoved, 7 = BlockedDelete, 8 = SanitizedMoved Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
exception	object
exceptionDetails	string
exceptionMessage	string
metaDefenderCoreUrl	string
discoveryStartedDaySec	int64

Expand

Response

xxxxxxxxxx
 
{
 "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "id": "{string}", "scanId": "{string}", "name": "{string}", "path": "{string}", "hash": "{string}", "fileOwner": {...},
 "size": "{int64}", "storageType": {...},
 "storageName": "{string}", "storageLocation": "{string}", "scanName": "{string}", "progress": {...},
 "scanResult": {...},
 "processingState": "{int32}", "exception": {...},
 "created": "{date-time}", "lastModified": "{date-time}", "discoveryStarted": "{date-time}", "fileProcessingDetails": {...},
 "coreEngines": [...],
 "remediation": {...},
 "metaDefenderCoreUrl": "{string}", "discoveryStartedDaySec": "{int64}"}
Copy

Enumerate processed files

Auth

Path Params

scanId	string
startIndex	string
count	string

Query String

sorting_order	string
search	string
result	integer	Enum: `0`,`1`,`2`,`3`
startDate	string
endDate	string
scanWorkflowSnapshotId	string

GET /api/file/{scanId}/{startIndex}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/file/%7BscanId%7D/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}' \ --data sorting_order={sorting_order} \ --data search={search} \ --data result={result} \ --data startDate={startDate} \ --data endDate={endDate} \ --data scanWorkflowSnapshotId={scanWorkflowSnapshotId}
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
scanId	string
name	string
path	string
hash	string
fileOwner	object
userId	string
fullName	string
userName	string
emailAddress	string
size	int64
storageType	object
name	string
categoryType	int32	0 = Local, 1 = Cloud, 2 = Object Enum: `0`,`1`,`2`
protocolType	int32	0 = Smb, 1 = GraphSdk, 2 = BoxSdk, 3 = AwsSdk, 4 = AzureBlobSdk, 5 = AlibabaCloudSdk, 6 = GoogleCloudSdk, 7 = AzureFilesSdk, 8 = Sftp Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
vendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
storageName	string
storageLocation	string
scanName	string
progress	object
upload	int32
scan	int32
scanResult	object
extractedFiles	object
dataId	string
scanResultI	int32
detectedBy	int32
filesInArchive	array[object]
displayName	string
dataId	string
fileType	string
fileTypeDescription	string
scanResultI	int32
scanAllResultI	int32
detectedBy	int32
scannedWith	int32
progressPercentage	int32
fileSize	int64
processInfo	object
postProcessing	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	int32	0 = Allowed, 1 = Blocked, 2 = Processing Enum: `0`,`1`,`2`
filesExtractedCount	int32
scanResults	object
scanDetails	array[object]
engineName	string
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
engId	string
waitTime	number
dataId	string
scanAllResultI	int32
scanAllResultA	string
startTime	string
totalTime	number
totalAvs	int32
progressPercentage	int32
fileInfo	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo	object
postProcessing	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	int32	0 = Allowed, 1 = Blocked, 2 = Processing Enum: `0`,`1`,`2`
dataId	string
dlpInfo	object
verdict	int64
vulnerabilityInfo	object
vulnerabilityInfoResult	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct	object
hasVulnerability	boolean
isCurrent	boolean
product	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor	object
id	int64
name	string
version	string
versionData	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details	object
cpe	string
cve	string
cvss	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3	object
attackComplexity	string
attackVector	string
availabilityImpact	string
baseScore	string
baseSeverity	string
confidentialityImpact	string
exploitabilityScore	string
impactScore	string
integrityImpact	string
privilegesRequired	string
scope	string
userInteraction	string
vectorString	string
cwe	string
lastModifiedEpoch	string
publishedEpoch	string
references	array[string]
severity	string
severityIndex	int32
staticId	int64
sessionCookie	string
processingState	int32	0 = InProgress, 1 = Failed, 2 = Canceled, 3 = Available Enum: `0`,`1`,`2`,`3`
exception	object
exceptionDetails	string
exceptionMessage	string
created	date-time
lastModified	date-time
discoveryStarted	date-time
fileProcessingDetails	object
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
coreEngines	array[object]
engineId	string
engineName	string
engineVersion	string
dbVersion	string
definitionTime	string
remediation	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
deepCdr	object
isSanitized	boolean
isEncrypted	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
decryptStatus	int32	0 = NotStarted, 1 = InProgress, 2 = Completed Enum: `0`,`1`,`2`
deepCdrOriginalObjectHandlingType	int32	0 = Keep, 1 = Encrypt, 2 = Delete Enum: `0`,`1`,`2`
sanitizationDetails	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	int32	0 = Tagging, 1 = DeepCdrSanitization, 2 = DeepCdrDelete, 3 = DeepCdrEncrypt, 4 = DeepCdrKeep, 5 = AllowedMoved, 6 = BlockedMoved, 7 = BlockedDelete, 8 = SanitizedMoved Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
exception	object
exceptionDetails	string
exceptionMessage	string
metaDefenderCoreUrl	string
discoveryStartedDaySec	int64
filterCount	int64
totalCount	int64

Expand

Response

xxxxxxxxxx
 
{
 "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [...],
 "filterCount": "{int64}", "totalCount": "{int64}"}
Copy

Ocm

Manage OPSWAT Central Management integration

ocm

Auth

GET /api/ocm

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ocm' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
ocmInformation	object
id	string
serverApi	string
registrationCode	string
connectionStatus	int32	0 = Disconnected, 1 = Connected Enum: `0`,`1`
enrollStatus	int32	0 = NotEnrolled, 1 = Enrolled Enum: `0`,`1`
lastServerConnection	int64
lastConfigurationSync	int64
apiKey	string
cmVersion	string
deploymentId	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "ocmInformation": {  "id": "{string}",  "serverApi": "{string}",  "registrationCode": "{string}",  "connectionStatus": "{int32}",  "enrollStatus": "{int32}",  "lastServerConnection": "{int64}",  "lastConfigurationSync": "{int64}",  "apiKey": "{string}",  "cmVersion": "{string}",  "deploymentId": "{string}" }}
Copy

ocm

Auth

Request Body

object	object
serverApi	string	minLength: 1
regCode	string	minLength: 1

PUT /api/ocm

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/ocm' \ --header 'Authorization: Bearer {token}' \ --data '{  "serverApi": "{string}",  "regCode": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

ocm

Auth

POST /api/ocm

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/ocm' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
version	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "version": "{string}"}
Copy

Onboarding

Manage onboarding

Fetch onboarding configuration

Auth

GET /api/onboarding

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/onboarding' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
hasUserConfigured	boolean
hasStorageConfigured	boolean
hasScanInstanceConfigured	boolean
isOnboardingDone	boolean

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "hasUserConfigured": "{boolean}", "hasStorageConfigured": "{boolean}", "hasScanInstanceConfigured": "{boolean}", "isOnboardingDone": "{boolean}"}
Copy

Finish onboarding

Auth

POST /api/onboarding

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/onboarding' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Report

Generate reports

/api/report

Get scans report

Auth

Query String

storageId	string
name	string
scanTypesFilter	array	Enum: `0`,`1`,`2`
scanStatesFilter	array	Enum: `0`,`1`,`2`,`3`,`4`
startDate	string
endDate	string
sortDirectionFilter	integer	Enum: `0`,`1`
startIndex	integer
count	integer

GET /api/report

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/report' \ --header 'Authorization: Bearer {token}' \ --data storageId={storageId} \ --data name={name} \ --data scanTypesFilter={scanTypesFilter} \ --data scanStatesFilter={scanStatesFilter} \ --data startDate={startDate} \ --data endDate={endDate} \ --data sortDirectionFilter={sortDirectionFilter} \ --data startIndex={startIndex} \ --data count={count}
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	int32	0 = NotStarted, 1 = Running, 2 = Cancelled, 3 = Failed, 4 = Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
pciDssComplianceViolationsCount	int64
hipaaComplianceViolationsCount	int64
gdprComplianceViolationsCount	int64
malwareSecurityAlertsCount	int64
vulnerabilitiesSecurityAlertsCount	int64
piiSecurityAlertsCount	int64
pciDssComplianceViolationsPercentageIncrease	int64
hipaaComplianceViolationsPercentageIncrease	int64
gdprComplianceViolationsPercentageIncrease	int64
malwareSecurityAlertsPercentageIncrease	int64
vulnerabilitiesSecurityAlertsPercentageIncrease	int64
piiSecurityAlertsPercentageIncrease	int64
highRiskAccounts	array[object]
id	string
displayName	string
blockedFilesCount	int64
scanSequenceDto	object
previousScanId	string
nextScanId	string
scanConfigurationId	string
totalCount	int64

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [  {   "responseKey": "{string}",   "responseMessage": "{string}",   "responseMessageParams": {},   "id": "{string}",   "name": "{string}",   "startTime": "{date-time}",   "stopTime": "{date-time}",   "scanType": "{string}",   "scanningState": "{int32}",   "scanStatusDto": {    "pendingFilesCount": "{int64}",    "allowedFilesCount": "{int64}",    "blockedFilesCount": "{int64}",    "totalFilesCount": "{int64}",    "processingFailedCount": "{int64}",    "processedFilesCount": "{int64}"   },   "scanStatsDto": {    "pciDssComplianceViolationsCount": "{int64}",    "hipaaComplianceViolationsCount": "{int64}",    "gdprComplianceViolationsCount": "{int64}",    "malwareSecurityAlertsCount": "{int64}",    "vulnerabilitiesSecurityAlertsCount": "{int64}",    "piiSecurityAlertsCount": "{int64}",    "pciDssComplianceViolationsPercentageIncrease": "{int64}",    "hipaaComplianceViolationsPercentageIncrease": "{int64}",    "gdprComplianceViolationsPercentageIncrease": "{int64}",    "malwareSecurityAlertsPercentageIncrease": "{int64}",    "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}",    "piiSecurityAlertsPercentageIncrease": "{int64}",    "highRiskAccounts": [     {      "id": "{string}",      "displayName": "{string}",      "blockedFilesCount": "{int64}"     }    ]   },   "scanSequenceDto": {    "previousScanId": "{string}",    "nextScanId": "{string}"   },   "scanConfigurationId": "{string}"  } ], "totalCount": "{int64}"}
Copy

Expand

Scan Configuration

List, add, update and delete Scan Configurations

/api/ScanConfiguration

/api/ScanConfiguration

/api/ScanConfiguration

/api/ScanConfiguration/{id}

/api/ScanConfiguration/{id}

/api/ScanConfiguration/setDefault/{id}

Get Scan Configurations

Auth

GET /api/ScanConfiguration

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ScanConfiguration' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
scanPoolId	string
rules	array[string]
type	int32	Enum: `0`,`1`
name	string
scanPool	object
id	string
name	string
scanInstances	array[object]
id	string
scanPoolId	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [  {   "id": "{string}",   "scanPoolId": "{string}",   "rules": [    "{array[string]...}"   ],   "type": "{int32}",   "name": "{string}",   "scanPool": {    "id": "{string}",    "name": "{string}",    "scanInstances": [     {      "id": "{string}",      "scanPoolId": "{string}",      "url": "{string}",      "ip": "{string}",      "apiKey": "{string}",      "timeout": {       "ticks": "{int64}",       "days": "{int32}",       "hours": "{int32}",       "milliseconds": "{int32}",       "microseconds": "{int32}",       "nanoseconds": "{int32}",       "minutes": "{int32}",       "seconds": "{int32}",       "totalDays": "{number}",       "totalHours": "{number}",       "totalMilliseconds": "{number}",       "totalMicroseconds": "{number}",       "totalNanoseconds": "{number}",       "totalMinutes": "{number}",       "totalSeconds": "{number}"      }     }    ]   }  } ]}
Copy

Add a new Scan Configuration

Auth

Request Body

object	object
scanPoolId	string
rules	array[string]
name	string	maxLength: 30 minLength: 3

POST /api/ScanConfiguration

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/ScanConfiguration' \ --header 'Authorization: Bearer {token}' \ --data '{  "scanPoolId": "{string}",  "rules": [    "{array[string]...}"  ],  "name": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Update an existing Scan Configuration

Auth

Request Body

object	object
id	string
scanPoolId	string
rules	array[string]
name	string	maxLength: 30 minLength: 3

PATCH /api/ScanConfiguration

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/ScanConfiguration' \ --header 'Authorization: Bearer {token}' \ --data '{  "id": "{string}",  "scanPoolId": "{string}",  "rules": [    "{array[string]...}"  ],  "name": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get Scan Configuration by ID

Auth

Path Params

id string

GET /api/ScanConfiguration/{id}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ScanConfiguration/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entry	object
id	string
scanPoolId	string
rules	array[string]
type	int32	Enum: `0`,`1`
name	string
scanPool	object
id	string
name	string
scanInstances	array[object]
id	string
scanPoolId	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entry": {  "id": "{string}",  "scanPoolId": "{string}",  "rules": [   "{array[string]...}"  ],  "type": "{int32}",  "name": "{string}",  "scanPool": {   "id": "{string}",   "name": "{string}",   "scanInstances": [    {     "id": "{string}",     "scanPoolId": "{string}",     "url": "{string}",     "ip": "{string}",     "apiKey": "{string}",     "timeout": {      "ticks": "{int64}",      "days": "{int32}",      "hours": "{int32}",      "milliseconds": "{int32}",      "microseconds": "{int32}",      "nanoseconds": "{int32}",      "minutes": "{int32}",      "seconds": "{int32}",      "totalDays": "{number}",      "totalHours": "{number}",      "totalMilliseconds": "{number}",      "totalMicroseconds": "{number}",      "totalNanoseconds": "{number}",      "totalMinutes": "{number}",      "totalSeconds": "{number}"     }    }   ]  } }}
Copy

Delete a Scan Configuration

Auth

Path Params

id string

DELETE /api/ScanConfiguration/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/ScanConfiguration/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Set a Scan Configuration as default

Auth

Path Params

id string

POST /api/ScanConfiguration/setDefault/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/ScanConfiguration/setDefault/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Scan

Manage your scans

/api/scan/{scanId}

/api/scan/sequence/{scanId}

/api/scan/start

/api/scan/stop/{scanId}

/api/scan/scheduled/{storageId}

/api/scan/{storageId}

Get scan by ID

Auth

Path Params

scanId string

GET /api/scan/{scanId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/scan/%7BscanId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scan	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	int32	0 = NotStarted, 1 = Running, 2 = Cancelled, 3 = Failed, 4 = Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
pciDssComplianceViolationsCount	int64
hipaaComplianceViolationsCount	int64
gdprComplianceViolationsCount	int64
malwareSecurityAlertsCount	int64
vulnerabilitiesSecurityAlertsCount	int64
piiSecurityAlertsCount	int64
pciDssComplianceViolationsPercentageIncrease	int64
hipaaComplianceViolationsPercentageIncrease	int64
gdprComplianceViolationsPercentageIncrease	int64
malwareSecurityAlertsPercentageIncrease	int64
vulnerabilitiesSecurityAlertsPercentageIncrease	int64
piiSecurityAlertsPercentageIncrease	int64
highRiskAccounts	array[object]
id	string
displayName	string
blockedFilesCount	int64
scanSequenceDto	object
previousScanId	string
nextScanId	string
scanConfigurationId	string

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "scan": {  "responseKey": "{string}",  "responseMessage": "{string}",  "responseMessageParams": {},  "id": "{string}",  "name": "{string}",  "startTime": "{date-time}",  "stopTime": "{date-time}",  "scanType": "{string}",  "scanningState": "{int32}",  "scanStatusDto": {   "pendingFilesCount": "{int64}",   "allowedFilesCount": "{int64}",   "blockedFilesCount": "{int64}",   "totalFilesCount": "{int64}",   "processingFailedCount": "{int64}",   "processedFilesCount": "{int64}"  },  "scanStatsDto": {   "pciDssComplianceViolationsCount": "{int64}",   "hipaaComplianceViolationsCount": "{int64}",   "gdprComplianceViolationsCount": "{int64}",   "malwareSecurityAlertsCount": "{int64}",   "vulnerabilitiesSecurityAlertsCount": "{int64}",   "piiSecurityAlertsCount": "{int64}",   "pciDssComplianceViolationsPercentageIncrease": "{int64}",   "hipaaComplianceViolationsPercentageIncrease": "{int64}",   "gdprComplianceViolationsPercentageIncrease": "{int64}",   "malwareSecurityAlertsPercentageIncrease": "{int64}",   "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}",   "piiSecurityAlertsPercentageIncrease": "{int64}",   "highRiskAccounts": [    {     "id": "{string}",     "displayName": "{string}",     "blockedFilesCount": "{int64}"    }   ]  },  "scanSequenceDto": {   "previousScanId": "{string}",   "nextScanId": "{string}"  },  "scanConfigurationId": "{string}" }}
Copy

Expand

Get scan by ID with information regarding the previous and next scan

Auth

Path Params

scanId string

Query String

scanTypesFilter	array	Enum: `0`,`1`,`2`
scanStatesFilter	array	Enum: `0`,`1`,`2`,`3`,`4`

GET /api/scan/sequence/{scanId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/scan/sequence/%7BscanId%7D' \ --header 'Authorization: Bearer {token}' \ --data scanTypesFilter={scanTypesFilter} \ --data scanStatesFilter={scanStatesFilter}
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scan	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	int32	0 = NotStarted, 1 = Running, 2 = Cancelled, 3 = Failed, 4 = Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
pciDssComplianceViolationsCount	int64
hipaaComplianceViolationsCount	int64
gdprComplianceViolationsCount	int64
malwareSecurityAlertsCount	int64
vulnerabilitiesSecurityAlertsCount	int64
piiSecurityAlertsCount	int64
pciDssComplianceViolationsPercentageIncrease	int64
hipaaComplianceViolationsPercentageIncrease	int64
gdprComplianceViolationsPercentageIncrease	int64
malwareSecurityAlertsPercentageIncrease	int64
vulnerabilitiesSecurityAlertsPercentageIncrease	int64
piiSecurityAlertsPercentageIncrease	int64
highRiskAccounts	array[object]
id	string
displayName	string
blockedFilesCount	int64
scanSequenceDto	object
previousScanId	string
nextScanId	string
scanConfigurationId	string

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "scan": {  "responseKey": "{string}",  "responseMessage": "{string}",  "responseMessageParams": {},  "id": "{string}",  "name": "{string}",  "startTime": "{date-time}",  "stopTime": "{date-time}",  "scanType": "{string}",  "scanningState": "{int32}",  "scanStatusDto": {   "pendingFilesCount": "{int64}",   "allowedFilesCount": "{int64}",   "blockedFilesCount": "{int64}",   "totalFilesCount": "{int64}",   "processingFailedCount": "{int64}",   "processedFilesCount": "{int64}"  },  "scanStatsDto": {   "pciDssComplianceViolationsCount": "{int64}",   "hipaaComplianceViolationsCount": "{int64}",   "gdprComplianceViolationsCount": "{int64}",   "malwareSecurityAlertsCount": "{int64}",   "vulnerabilitiesSecurityAlertsCount": "{int64}",   "piiSecurityAlertsCount": "{int64}",   "pciDssComplianceViolationsPercentageIncrease": "{int64}",   "hipaaComplianceViolationsPercentageIncrease": "{int64}",   "gdprComplianceViolationsPercentageIncrease": "{int64}",   "malwareSecurityAlertsPercentageIncrease": "{int64}",   "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}",   "piiSecurityAlertsPercentageIncrease": "{int64}",   "highRiskAccounts": [    {     "id": "{string}",     "displayName": "{string}",     "blockedFilesCount": "{int64}"    }   ]  },  "scanSequenceDto": {   "previousScanId": "{string}",   "nextScanId": "{string}"  },  "scanConfigurationId": "{string}" }}
Copy

Expand

Start a scan

Auth

Request Body

object	object
storageId	string
name	string
scanConfigurationId	string

POST /api/scan/start

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/scan/start' \ --header 'Authorization: Bearer {token}' \ --data '{  "storageId": "{string}",  "name": "{string}",  "scanConfigurationId": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scanId	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "scanId": "{string}"}
Copy

Stop a scan

Auth

Path Params

scanId string

POST /api/scan/stop/{scanId}

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/scan/stop/%7BscanId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Get next scheduled scan

Auth

Path Params

storageId string

GET /api/scan/scheduled/{storageId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/scan/scheduled/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
nextScheduledScan	object
id	string
name	string
scanConfigurationId	string
type	string
createdAt	date-time
lastScanTime	date-time
nextScanTime	date-time
recurrencePatternDto	object
hourlyRecurrenceDto	object
everyNumberOfHours	int32
dailyRecurrenceDto	object
everyNumberOfDays	int32
weeklyRecurrenceDto	object
dayOfWeek	int32	0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
monthlyRecurrenceDto	object
everyNumberOfMonths	int32
dayOfMonth	int32
createdBy	string
scheduledScansCount	int32

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "nextScheduledScan": {  "id": "{string}",  "name": "{string}",  "scanConfigurationId": "{string}",  "type": "{string}",  "createdAt": "{date-time}",  "lastScanTime": "{date-time}",  "nextScanTime": "{date-time}",  "recurrencePatternDto": {   "hourlyRecurrenceDto": {    "everyNumberOfHours": "{int32}"   },   "dailyRecurrenceDto": {    "everyNumberOfDays": "{int32}"   },   "weeklyRecurrenceDto": {    "dayOfWeek": "{int32}"   },   "monthlyRecurrenceDto": {    "everyNumberOfMonths": "{int32}",    "dayOfMonth": "{int32}"   }  },  "createdBy": "{string}" }, "scheduledScansCount": "{int32}"}
Copy

Delete scans

Auth

Path Params

storageId string

Request Body

array array[string]

DELETE /api/scan/{storageId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/scan/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Scan Instance

List, add, update and delete Scan Instances

/api/ScanInstance/{id}

/api/ScanInstance/{id}

Get Scan Instances

Auth

Query String

scanPoolId string

GET /api/ScanInstance

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ScanInstance' \ --header 'Authorization: Bearer {token}' \ --data scanPoolId={scanPoolId}
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
scanPoolId	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [  {   "id": "{string}",   "scanPoolId": "{string}",   "url": "{string}",   "ip": "{string}",   "apiKey": "{string}",   "timeout": {    "ticks": "{int64}",    "days": "{int32}",    "hours": "{int32}",    "milliseconds": "{int32}",    "microseconds": "{int32}",    "nanoseconds": "{int32}",    "minutes": "{int32}",    "seconds": "{int32}",    "totalDays": "{number}",    "totalHours": "{number}",    "totalMilliseconds": "{number}",    "totalMicroseconds": "{number}",    "totalNanoseconds": "{number}",    "totalMinutes": "{number}",    "totalSeconds": "{number}"   }  } ]}
Copy

Update an existing Scan Instance

Auth

Request Body

object	object
id	string
url	string	pattern: `^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])?)?$)\|(^((https?):\/\/)?\[(?:0\:)?:?01\](:([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])?)?$)).)$`
apiKey	string
timeout	object
ticks	int64

PUT /api/ScanInstance

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/ScanInstance' \ --header 'Authorization: Bearer {token}' \ --data '{  "id": "{string}",  "url": "{string}",  "apiKey": "{string}",  "timeout": {    "ticks": "{int64}"  }}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Add a new Scan Instance

Auth

Request Body

object	object
scanPoolId	string
url	string	pattern: `^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])?)?$)\|(^((https?):\/\/)?\[(?:0\:)?:?01\](:([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])?)?$)).)$`
apiKey	string
timeout	object
ticks	int64
scanInstanceType	int32	Enum: `0`,`1`

POST /api/ScanInstance

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/ScanInstance' \ --header 'Authorization: Bearer {token}' \ --data '{  "scanPoolId": "{string}",  "url": "{string}",  "apiKey": "{string}",  "timeout": {    "ticks": "{int64}"  },  "scanInstanceType": "{int32}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get Scan Instance by ID

Auth

Path Params

id string

GET /api/ScanInstance/{id}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ScanInstance/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entry	object
id	string
scanPoolId	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entry": {  "id": "{string}",  "scanPoolId": "{string}",  "url": "{string}",  "ip": "{string}",  "apiKey": "{string}",  "timeout": {   "ticks": "{int64}",   "days": "{int32}",   "hours": "{int32}",   "milliseconds": "{int32}",   "microseconds": "{int32}",   "nanoseconds": "{int32}",   "minutes": "{int32}",   "seconds": "{int32}",   "totalDays": "{number}",   "totalHours": "{number}",   "totalMilliseconds": "{number}",   "totalMicroseconds": "{number}",   "totalNanoseconds": "{number}",   "totalMinutes": "{number}",   "totalSeconds": "{number}"  } }}
Copy

Delete a Scan Instance

Auth

Path Params

id string

DELETE /api/ScanInstance/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/ScanInstance/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Scan Pool

List, add, update and delete Scan Pools

Get Scan Pools

Auth

GET /api/ScanPool

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ScanPool' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
name	string
scanInstances	array[object]
id	string
scanPoolId	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [  {   "id": "{string}",   "name": "{string}",   "scanInstances": [    {     "id": "{string}",     "scanPoolId": "{string}",     "url": "{string}",     "ip": "{string}",     "apiKey": "{string}",     "timeout": {      "ticks": "{int64}",      "days": "{int32}",      "hours": "{int32}",      "milliseconds": "{int32}",      "microseconds": "{int32}",      "nanoseconds": "{int32}",      "minutes": "{int32}",      "seconds": "{int32}",      "totalDays": "{number}",      "totalHours": "{number}",      "totalMilliseconds": "{number}",      "totalMicroseconds": "{number}",      "totalNanoseconds": "{number}",      "totalMinutes": "{number}",      "totalSeconds": "{number}"     }    }   ]  } ]}
Copy

Update an existing Scan Pool

Auth

Request Body

object object

id string

name

string

maxLength: 30

minLength: 3

PUT /api/ScanPool

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/ScanPool' \ --header 'Authorization: Bearer {token}' \ --data '{  "id": "{string}",  "name": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Add a new Scan Pool

Auth

Request Body

object object

name

string

maxLength: 30

minLength: 3

scanPoolType

int32

Enum: 0,1

POST /api/ScanPool

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/ScanPool' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "scanPoolType": "{int32}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get Scan Pool by ID

Auth

Path Params

id string

GET /api/ScanPool/{id}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ScanPool/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entry	object
id	string
name	string
scanInstances	array[object]
id	string
scanPoolId	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entry": {  "id": "{string}",  "name": "{string}",  "scanInstances": [   {    "id": "{string}",    "scanPoolId": "{string}",    "url": "{string}",    "ip": "{string}",    "apiKey": "{string}",    "timeout": {     "ticks": "{int64}",     "days": "{int32}",     "hours": "{int32}",     "milliseconds": "{int32}",     "microseconds": "{int32}",     "nanoseconds": "{int32}",     "minutes": "{int32}",     "seconds": "{int32}",     "totalDays": "{number}",     "totalHours": "{number}",     "totalMilliseconds": "{number}",     "totalMicroseconds": "{number}",     "totalNanoseconds": "{number}",     "totalMinutes": "{number}",     "totalSeconds": "{number}"    }   }  ] }}
Copy

Delete a Scan Pool

Auth

Path Params

id string

DELETE /api/ScanPool/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/ScanPool/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Scan Workflow Snapshot

List scan workflow snapshots

/api/ScanWorkflowSnapshot/getAllFromScan/{scanId}

Get all scan workflow snapshots by scan ID

Auth

Path Params

scanId string

GET /api/ScanWorkflowSnapshot/getAllFromScan/{scanId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/ScanWorkflowSnapshot/getAllFromScan/%7BscanId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Security Checklist

Manage security checklist

/api/security-checklist/{storageId}

/api/security-checklist/{storageId}/info

/api/security-checklist/{storageId}/item

/api/security-checklist/{storageId}/verify

/api/security-checklist

/api/security-checklist/{storageId}/enable-all

Fetch storage security checklist

Auth

Path Params

storageId string

GET /api/security-checklist/{storageId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
items	array[object]
id	string
title	int32	0 = Https, 1 = AuthenticatedAccessToBuckets, 2 = LeastPrivilege, 3 = BucketVersion, 4 = ServerSideEncryption, 5 = BucketAccessLogging, 6 = DataReplication, 7 = ObjectLocking Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`
status	int32	0 = NotSet, 1 = Passed, 2 = Failed Enum: `0`,`1`,`2`
priority	int32	0 = Critical, 1 = Major, 2 = Minor Enum: `0`,`1`,`2`
isEnabled	boolean
howToFixLink	string
failureReason	string
lastUpdateTime	date-time
score	number
isEnabled	boolean

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "items": [  {   "id": "{string}",   "title": "{int32}",   "status": "{int32}",   "priority": "{int32}",   "isEnabled": "{boolean}",   "howToFixLink": "{string}",   "failureReason": "{string}"  } ], "lastUpdateTime": "{date-time}", "score": "{number}", "isEnabled": "{boolean}"}
Copy

Fetch security checklist details

Auth

Path Params

storageId string

GET /api/security-checklist/{storageId}/info

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D/info' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
score	number
resolvedItemsCount	int32
enabledItemsCount	int32
isEnabled	boolean

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "score": "{number}", "resolvedItemsCount": "{int32}", "enabledItemsCount": "{int32}", "isEnabled": "{boolean}"}
Copy

Update security checklist item

Auth

Path Params

storageId string

Request Body

object	object
id	string
isEnabled	boolean

PUT /api/security-checklist/{storageId}/item

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D/item' \ --header 'Authorization: Bearer {token}' \ --data '{  "id": "{string}",  "isEnabled": "{boolean}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
item	object
id	string
title	int32	0 = Https, 1 = AuthenticatedAccessToBuckets, 2 = LeastPrivilege, 3 = BucketVersion, 4 = ServerSideEncryption, 5 = BucketAccessLogging, 6 = DataReplication, 7 = ObjectLocking Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`
status	int32	0 = NotSet, 1 = Passed, 2 = Failed Enum: `0`,`1`,`2`
priority	int32	0 = Critical, 1 = Major, 2 = Minor Enum: `0`,`1`,`2`
isEnabled	boolean
howToFixLink	string
failureReason	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "item": {  "id": "{string}",  "title": "{int32}",  "status": "{int32}",  "priority": "{int32}",  "isEnabled": "{boolean}",  "howToFixLink": "{string}",  "failureReason": "{string}" }}
Copy

Verify the security checklist for storage

Auth

Path Params

storageId string

PUT /api/security-checklist/{storageId}/verify

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D/verify' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Enable/Disable the security checklist

Auth

Request Body

object	object
storageId	string
isEnabled	boolean

PATCH /api/security-checklist

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/security-checklist' \ --header 'Authorization: Bearer {token}' \ --data '{  "storageId": "{string}",  "isEnabled": "{boolean}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Enable all security checklist items

Auth

Path Params

storageId string

PUT /api/security-checklist/{storageId}/enable-all

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D/enable-all' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Settings

List or update your settings

/api/settings/notifications

/api/settings/notifications

/api/settings/admin/license/activate/online

/api/settings/admin/license/activate/offline

/api/settings/admin/license

/api/settings/admin/license/deactivate

/api/settings/retention

/api/settings/retention

Get email notifications configuration

Auth

GET /api/settings/notifications

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/settings/notifications' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
generatedReportNotificationsConfig	object
isEnabled	boolean
recipientsType	int32	0 = OwnerOnly, 1 = AllRegisteredUsers Enum: `0`,`1`
userRequestNotificationsConfig	object
isEnabled	boolean
blockedFileNotificationsConfig	object
isEnabled	boolean
recipientsType	int32	0 = AllRegisteredUsers, 1 = FileOwner, 2 = FileOwnerAndAllRegisteredUsers Enum: `0`,`1`,`2`

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "generatedReportNotificationsConfig": {  "isEnabled": "{boolean}",  "recipientsType": "{int32}" }, "userRequestNotificationsConfig": {  "isEnabled": "{boolean}" }, "blockedFileNotificationsConfig": {  "isEnabled": "{boolean}",  "recipientsType": "{int32}" }}
Copy

Update email notifications configuration

Auth

Request Body

object	object
generatedReportNotificationsConfig	object
isEnabled	boolean
recipientsType	int32	0 = OwnerOnly, 1 = AllRegisteredUsers Enum: `0`,`1`
userRequestNotificationsConfig	object
isEnabled	boolean
blockedFileNotificationsConfig	object
isEnabled	boolean
recipientsType	int32	0 = AllRegisteredUsers, 1 = FileOwner, 2 = FileOwnerAndAllRegisteredUsers Enum: `0`,`1`,`2`

PUT /api/settings/notifications

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/settings/notifications' \ --header 'Authorization: Bearer {token}' \ --data '{  "generatedReportNotificationsConfig": {    "isEnabled": "{boolean}",    "recipientsType": "{int32}"  },  "userRequestNotificationsConfig": {    "isEnabled": "{boolean}"  },  "blockedFileNotificationsConfig": {    "isEnabled": "{boolean}",    "recipientsType": "{int32}"  }}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Fetch SMTP configuration

Auth

GET /api/settings/smtp

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/settings/smtp' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
host	string
port	int32
baseUrl	string
senderAddress	string
senderName	string	maxLength: 320
domain	string
username	string
password	string
secureSocketOption	int32	0 = None, 1 = Auto, 2 = SslOnConnect, 3 = StartTls, 4 = StartTlsWhenAvailable Enum: `0`,`1`,`2`,`3`,`4`
ignoreCertWarnings	boolean
isSmtpEnabled	boolean

Response

xxxxxxxxxx
 
{ "host": "{string}", "port": "{int32}", "baseUrl": "{string}", "senderAddress": "{string}", "senderName": "{string}", "domain": "{string}", "username": "{string}", "password": "{string}", "secureSocketOption": "{int32}", "ignoreCertWarnings": "{boolean}", "isSmtpEnabled": "{boolean}"}
Copy

Update SMTP configuration

Auth

Request Body

object	object
host	string
port	int32
baseUrl	string
senderAddress	string
senderName	string	maxLength: 320
domain	string
username	string
password	string
secureSocketOption	int32	0 = None, 1 = Auto, 2 = SslOnConnect, 3 = StartTls, 4 = StartTlsWhenAvailable Enum: `0`,`1`,`2`,`3`,`4`
ignoreCertWarnings	boolean
isSmtpEnabled	boolean

PATCH /api/settings/smtp

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/settings/smtp' \ --header 'Authorization: Bearer {token}' \ --data '{  "host": "{string}",  "port": "{int32}",  "baseUrl": "{string}",  "senderAddress": "{string}",  "senderName": "{string}",  "domain": "{string}",  "username": "{string}",  "password": "{string}",  "secureSocketOption": "{int32}",  "ignoreCertWarnings": "{boolean}",  "isSmtpEnabled": "{boolean}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Online license activation

Auth

Request Body

object	object
key	string	minLength: 1

POST /api/settings/admin/license/activate/online

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/settings/admin/license/activate/online' \ --header 'Authorization: Bearer {token}' \ --data '{  "key": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Offline license activation

Auth

Request Body

object	object
LicenseContent	file

POST /api/settings/admin/license/activate/offline

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/settings/admin/license/activate/offline' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Get license details

Auth

GET /api/settings/admin/license

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/settings/admin/license' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Deactivate license

Auth

POST /api/settings/admin/license/deactivate

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/settings/admin/license/deactivate' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Fetch retention configuration

Auth

GET /api/settings/retention

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/settings/retention' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
retentionAuditDays	int32
reportRetentionConfiguration	object
isEnabled	boolean
retentionDays	int32

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "retentionAuditDays": "{int32}", "reportRetentionConfiguration": {  "isEnabled": "{boolean}",  "retentionDays": "{int32}" }}
Copy

Update retention configuration

Auth

Request Body

object	object
retentionAuditDays	int32	maximum: 50000 minimum: 10
reportRetention	object
isEnabled	boolean
retentionDays	int32	maximum: 50000 minimum: 10

PUT /api/settings/retention

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/settings/retention' \ --header 'Authorization: Bearer {token}' \ --data '{  "retentionAuditDays": "{int32}",  "reportRetention": {    "isEnabled": "{boolean}",    "retentionDays": "{int32}"  }}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Sso

Sso Authentication and Sso configuration update

Get Sso Configuration

Auth

GET /api/sso/config

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/sso/config' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
clientId	string
authority	string
baseUrl	string
isEnabled	boolean
ssoType	int32	0 = OpenIdConnect Enum: `0`
ssoProvider	int32	0 = Azure, 1 = Okta, 2 = Auth0 Enum: `0`,`1`,`2`

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "clientId": "{string}", "authority": "{string}", "baseUrl": "{string}", "isEnabled": "{boolean}", "ssoType": "{int32}", "ssoProvider": "{int32}"}
Copy

Update Sso Configuration

Auth

Request Body

object	object
clientId	string	maxLength: 255
clientSecret	string	maxLength: 255
authority	string	maxLength: 255
baseUrl	string	maxLength: 255
isEnabled	boolean
ssoType	int32
ssoProvider	int32

PATCH /api/sso

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/sso' \ --header 'Authorization: Bearer {token}' \ --data '{  "clientId": "{string}",  "clientSecret": "{string}",  "authority": "{string}",  "baseUrl": "{string}",  "isEnabled": "{boolean}",  "ssoType": "{int32}",  "ssoProvider": "{int32}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
clientId	string
authority	string
baseUrl	string
isEnabled	boolean
ssoType	int32	0 = OpenIdConnect Enum: `0`
ssoProvider	int32	0 = Azure, 1 = Okta, 2 = Auth0 Enum: `0`,`1`,`2`

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "clientId": "{string}", "authority": "{string}", "baseUrl": "{string}", "isEnabled": "{boolean}", "ssoType": "{int32}", "ssoProvider": "{int32}"}
Copy

Storage

Manage your storages

/api/storage/all

/api/storage/{storageId}

/api/storage/{storageId}

/api/storage/{storageId}

/api/storage/{storageId}/users

/api/storage

/api/storage/{storageId}/scan_config

/api/storage/{storageId}/scan_schedule

/api/storage/scan_schedule/update/{storageId}

/api/storage/scan_schedules/{storageId}/{sortDirection}/{startIndex}/{count}

/api/storage/scan_schedule/{storageId}

/api/storage/{storageId}/{userId}

Fetch all storages

Auth

GET /api/storage/all

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/storage/all' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
name	string
storageClientId	string
storageType	object
name	string
categoryType	int32	0 = Local, 1 = Cloud, 2 = Object Enum: `0`,`1`,`2`
protocolType	int32	0 = Smb, 1 = GraphSdk, 2 = BoxSdk, 3 = AwsSdk, 4 = AzureBlobSdk, 5 = AlibabaCloudSdk, 6 = GoogleCloudSdk, 7 = AzureFilesSdk, 8 = Sftp Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
vendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
realTimeScanConfig	object
isEnabled	boolean
handlingType	int32	0 = Polling, 1 = EventBased Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig	object
fileTaggingConfig	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	int32	0 = MetaDefenderResult, 1 = MetaDefenderFileId, 2 = MetaDefenderAnalysisTimestamp Enum: `0`,`1`,`2`
deepCdrConfig	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType	int32	0 = Keep, 1 = Encrypt, 2 = Delete Enum: `0`,`1`,`2`
moveDeleteRemediationConfig	object
blockedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType	int32	0 = Delete, 1 = Move Enum: `0`,`1`
blockedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy	int32	0 = Strict, 1 = Configurable Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [  {   "id": "{string}",   "name": "{string}",   "storageClientId": "{string}",   "storageType": {    "name": "{string}",    "categoryType": "{int32}",    "protocolType": "{int32}",    "vendorType": "{int32}"   },   "realTimeScanConfig": {    "isEnabled": "{boolean}",    "handlingType": "{int32}",    "scanConfigurationId": "{string}"   },   "postActionsScanConfig": {    "fileTaggingConfig": {     "isTaggingPostActionEnabled": "{boolean}",     "fileTags": [      {       "fileTagKey": {        "defaultName": "{string}",        "customName": "{string}"       },       "customValues": [        {         "defaultName": "{string}",         "customName": "{string}"        }       ],       "isEnabled": "{boolean}",       "fileTagType": "{int32}"      }     ]    },    "deepCdrConfig": {     "isDeepCdrPostActionEnabled": "{boolean}",     "deepCdrOriginalFileHandlingType": "{int32}"    },    "moveDeleteRemediationConfig": {     "blockedFileRemediationConfigurationStatus": "{int32}",     "sanitizedFileRemediationConfigurationStatus": "{int32}",     "allowedFileRemediationConfigurationStatus": "{int32}",     "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",     "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",     "blockedFileHandlingType": "{int32}",     "blockedFileStorageConfig": {      "storageId": "{string}",      "userId": "{string}",      "keepFolderStructure": "{boolean}"     },     "sanitizedFileStorageConfig": {      "storageId": "{string}",      "userId": "{string}",      "keepFolderStructure": "{boolean}"     },     "allowedFileStorageConfig": {      "storageId": "{string}",      "userId": "{string}",      "keepFolderStructure": "{boolean}"     },     "blockingStrategy": "{int32}"    }   }  } ]}
Copy

Expand

Fetch storage by ID

Auth

Path Params

storageId string

GET /api/storage/{storageId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
storage	object
id	string
name	string
storageClientId	string
storageType	object
name	string
categoryType	int32	0 = Local, 1 = Cloud, 2 = Object Enum: `0`,`1`,`2`
protocolType	int32	0 = Smb, 1 = GraphSdk, 2 = BoxSdk, 3 = AwsSdk, 4 = AzureBlobSdk, 5 = AlibabaCloudSdk, 6 = GoogleCloudSdk, 7 = AzureFilesSdk, 8 = Sftp Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
vendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
realTimeScanConfig	object
isEnabled	boolean
handlingType	int32	0 = Polling, 1 = EventBased Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig	object
fileTaggingConfig	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	int32	0 = MetaDefenderResult, 1 = MetaDefenderFileId, 2 = MetaDefenderAnalysisTimestamp Enum: `0`,`1`,`2`
deepCdrConfig	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType	int32	0 = Keep, 1 = Encrypt, 2 = Delete Enum: `0`,`1`,`2`
moveDeleteRemediationConfig	object
blockedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType	int32	0 = Delete, 1 = Move Enum: `0`,`1`
blockedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy	int32	0 = Strict, 1 = Configurable Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "storage": {  "id": "{string}",  "name": "{string}",  "storageClientId": "{string}",  "storageType": {   "name": "{string}",   "categoryType": "{int32}",   "protocolType": "{int32}",   "vendorType": "{int32}"  },  "realTimeScanConfig": {   "isEnabled": "{boolean}",   "handlingType": "{int32}",   "scanConfigurationId": "{string}"  },  "postActionsScanConfig": {   "fileTaggingConfig": {    "isTaggingPostActionEnabled": "{boolean}",    "fileTags": [     {      "fileTagKey": {       "defaultName": "{string}",       "customName": "{string}"      },      "customValues": [       {        "defaultName": "{string}",        "customName": "{string}"       }      ],      "isEnabled": "{boolean}",      "fileTagType": "{int32}"     }    ]   },   "deepCdrConfig": {    "isDeepCdrPostActionEnabled": "{boolean}",    "deepCdrOriginalFileHandlingType": "{int32}"   },   "moveDeleteRemediationConfig": {    "blockedFileRemediationConfigurationStatus": "{int32}",    "sanitizedFileRemediationConfigurationStatus": "{int32}",    "allowedFileRemediationConfigurationStatus": "{int32}",    "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",    "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",    "blockedFileHandlingType": "{int32}",    "blockedFileStorageConfig": {     "storageId": "{string}",     "userId": "{string}",     "keepFolderStructure": "{boolean}"    },    "sanitizedFileStorageConfig": {     "storageId": "{string}",     "userId": "{string}",     "keepFolderStructure": "{boolean}"    },    "allowedFileStorageConfig": {     "storageId": "{string}",     "userId": "{string}",     "keepFolderStructure": "{boolean}"    },    "blockingStrategy": "{int32}"   }  } }}
Copy

Expand

Delete a storage

Auth

Path Params

storageId string

DELETE /api/storage/{storageId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update a storage

Note! The following are templates for what is expected in the Credentials, CredentialsFile and Source fields. Please provide the correct values for your storage integration instead of null/false

Alibaba Cloud storage units:
Credentials: "{"Endpoint":null,"AccessKeyId":null,"AccessKeySecret":null,"UseRamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"

Amazon S3 / S3 Compatible storage units:
Credentials: "{"ServiceUrl":null,"AccessKeyId":null,"SecretAccessKey":null,"RegionEndpoint":null,"AssumeRoleArn":null,"UseIamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"

Azure Blob storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null,"StorageAccount":null}"
Source: "{"Container":null}"

Azure Files storage units:
Credentials: "{"AccountName":null,"AccountKey":null,"ShareName":null}"
Source: "{"FolderLocation":null}"

Box storage units:
CredentialsFile: upload the credentials file
Source: "{"FolderLocation":null}"

Dell Isilon / SMB Compatible storage units:
Credentials: "{"User":null,"Password":null,"Server":null}"
Source: "{"SharePath":null}"

Google Cloud storage units:
CredentialsFile: upload the credentials file
Credentials: "{"UseAdc":false}"
Source: "{"BucketName":null,"FolderLocation":null}"

OneDrive storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null}"
Source: "{"Group":null}"

Auth

Path Params

storageId string

Request Body

object	object
Name	string	maxLength: 30
StorageVendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
StorageProtocolType	int32	0 = Smb, 1 = GraphSdk, 2 = BoxSdk, 3 = AwsSdk, 4 = AzureBlobSdk, 5 = AlibabaCloudSdk, 6 = GoogleCloudSdk, 7 = AzureFilesSdk, 8 = Sftp Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
CredentialsFile	file
Credentials	string
Source	string

PATCH /api/storage/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Fetch storage users

Auth

Path Params

storageId string

Query String

filter string

GET /api/storage/{storageId}/users

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/users' \ --header 'Authorization: Bearer {token}' \ --data filter={filter}
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
fullName	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [  {   "id": "{string}",   "fullName": "{string}"  } ]}
Copy

Add a storage

Auth

Request Body

object	object
Name	string	maxLength: 30
StorageVendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
StorageProtocolType	int32	0 = Smb, 1 = GraphSdk, 2 = BoxSdk, 3 = AwsSdk, 4 = AzureBlobSdk, 5 = AlibabaCloudSdk, 6 = GoogleCloudSdk, 7 = AzureFilesSdk, 8 = Sftp Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
CredentialsFile	file
Credentials	string
Source	string

POST /api/storage

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Update scan configuration

Auth

Path Params

storageId string

Request Body

object	object
realTimeScanConfig	object
isEnabled	boolean
handlingType	int32	0 = Polling, 1 = EventBased Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig	object
fileTaggingConfig	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	int32	0 = MetaDefenderResult, 1 = MetaDefenderFileId, 2 = MetaDefenderAnalysisTimestamp Enum: `0`,`1`,`2`
deepCdrConfig	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType	int32	0 = Keep, 1 = Encrypt, 2 = Delete Enum: `0`,`1`,`2`
moveDeleteRemediationConfig	object
blockedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	int32	0 = None, 1 = Disabled, 2 = Enabled Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType	int32	0 = Delete, 1 = Move Enum: `0`,`1`
blockedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy	int32	0 = Strict, 1 = Configurable Enum: `0`,`1`

Expand

PATCH /api/storage/{storageId}/scan_config

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/scan_config' \ --header 'Authorization: Bearer {token}' \ --data '{  "realTimeScanConfig": {    "isEnabled": "{boolean}",    "handlingType": "{int32}",    "scanConfigurationId": "{string}"  },  "postActionsScanConfig": {    "fileTaggingConfig": {      "isTaggingPostActionEnabled": "{boolean}",      "fileTags": [        {          "fileTagKey": {            "defaultName": "{string}",            "customName": "{string}"          },          "customValues": [            {              "defaultName": "{string}",              "customName": "{string}"            }          ],          "isEnabled": "{boolean}",          "fileTagType": "{int32}"        }      ]    },    "deepCdrConfig": {      "isDeepCdrPostActionEnabled": "{boolean}",      "deepCdrOriginalFileHandlingType": "{int32}"    },    "moveDeleteRemediationConfig": {      "blockedFileRemediationConfigurationStatus": "{int32}",      "sanitizedFileRemediationConfigurationStatus": "{int32}",      "allowedFileRemediationConfigurationStatus": "{int32}",      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",      "blockedFileHandlingType": "{int32}",      "blockedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"      },      "sanitizedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"      },      "allowedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"      },      "blockingStrategy": "{int32}"    }  }}'
Copy

Expand

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Add a scan schedule

Auth

Path Params

storageId string

Request Body

object	object
name	string
scanConfigurationId	string
recurrencePattern	object
type	string
hourlyRecurrence	object
everyNumberOfHours	int32	maximum: 24 minimum: 1
dailyRecurrence	object
everyNumberOfDays	int32	maximum: 365 minimum: 1
weeklyRecurrence	object
dayOfWeek	int32	0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
monthlyRecurrence	object
everyNumberOfMonths	int32	maximum: 12 minimum: 1
dayOfMonth	int32

PUT /api/storage/{storageId}/scan_schedule

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/scan_schedule' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "scanConfigurationId": "{string}",  "recurrencePattern": {    "type": "{string}",    "hourlyRecurrence": {      "everyNumberOfHours": "{int32}"    },    "dailyRecurrence": {      "everyNumberOfDays": "{int32}"    },    "weeklyRecurrence": {      "dayOfWeek": "{int32}"    },    "monthlyRecurrence": {      "everyNumberOfMonths": "{int32}",      "dayOfMonth": "{int32}"    }  }}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update a scan schedule

Auth

Path Params

storageId string

Request Body

object	object
name	string
scanConfigurationId	string
recurrencePattern	object
type	string
hourlyRecurrence	object
everyNumberOfHours	int32	maximum: 24 minimum: 1
dailyRecurrence	object
everyNumberOfDays	int32	maximum: 365 minimum: 1
weeklyRecurrence	object
dayOfWeek	int32	0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
monthlyRecurrence	object
everyNumberOfMonths	int32	maximum: 12 minimum: 1
dayOfMonth	int32
id	string

PUT /api/storage/scan_schedule/update/{storageId}

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/storage/scan_schedule/update/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "scanConfigurationId": "{string}",  "recurrencePattern": {    "type": "{string}",    "hourlyRecurrence": {      "everyNumberOfHours": "{int32}"    },    "dailyRecurrence": {      "everyNumberOfDays": "{int32}"    },    "weeklyRecurrence": {      "dayOfWeek": "{int32}"    },    "monthlyRecurrence": {      "everyNumberOfMonths": "{int32}",      "dayOfMonth": "{int32}"    }  },  "id": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Fetch scan schedules

Auth

Path Params

storageId	string
sortDirection	integer	Enum: `0`,`1`
startIndex	integer
count	integer

Query String

name	string
user	string
type	string

GET /api/storage/scan_schedules/{storageId}/{sortDirection}/{startIndex}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/storage/scan_schedules/%7BstorageId%7D/%7BsortDirection%7D/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}' \ --data name={name} \ --data user={user} \ --data type={type}
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
name	string
scanConfigurationId	string
type	string
createdAt	date-time
lastScanTime	date-time
nextScanTime	date-time
recurrencePatternDto	object
hourlyRecurrenceDto	object
everyNumberOfHours	int32
dailyRecurrenceDto	object
everyNumberOfDays	int32
weeklyRecurrenceDto	object
dayOfWeek	int32	0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
monthlyRecurrenceDto	object
everyNumberOfMonths	int32
dayOfMonth	int32
createdBy	string
totalCount	int64
createdByUsers	array[string]

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [  {   "id": "{string}",   "name": "{string}",   "scanConfigurationId": "{string}",   "type": "{string}",   "createdAt": "{date-time}",   "lastScanTime": "{date-time}",   "nextScanTime": "{date-time}",   "recurrencePatternDto": {    "hourlyRecurrenceDto": {     "everyNumberOfHours": "{int32}"    },    "dailyRecurrenceDto": {     "everyNumberOfDays": "{int32}"    },    "weeklyRecurrenceDto": {     "dayOfWeek": "{int32}"    },    "monthlyRecurrenceDto": {     "everyNumberOfMonths": "{int32}",     "dayOfMonth": "{int32}"    }   },   "createdBy": "{string}"  } ], "totalCount": "{int64}", "createdByUsers": [  "{array[string]...}" ]}
Copy

Delete scan schedules

Auth

Path Params

storageId string

Request Body

array array[string]

DELETE /api/storage/scan_schedule/{storageId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/storage/scan_schedule/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Retrieve storage user name

Auth

Path Params

storageId	string
userId	string

GET /api/storage/{storageId}/{userId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/%7BuserId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
userName	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "userName": "{string}"}
Copy

User

Create, list and update user accounts

/api/user/active/{startIndex}/{count}

/api/user/authenticate

/api/user/refreshToken

/api/user/password/reset

/api/CorePool/{corePoolId}

/api/user/password

Fetch active users

Auth

Path Params

startIndex	string
count	string

GET /api/user/active/{startIndex}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/user/active/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
entries	array[object]
id	string
userName	string
fullName	string
email	string
role	int32	0 = None, 1 = ReadOnlyAdministrator, 2 = Administrator, 3 = ServiceRole, 4 = SsoAdministrator, 5 = SsoReadOnlyAdministrator Enum: `0`,`1`,`2`,`3`,`4`,`5`
totalCount	int64

Response

xxxxxxxxxx
 
{ "entries": [  {   "id": "{string}",   "userName": "{string}",   "fullName": "{string}",   "email": "{string}",   "role": "{int32}"  } ], "totalCount": "{int64}"}
Copy

Register a user

Auth

Request Body

object	object
fullName	string	minLength: 1 pattern: `^[\p{L}\p{M} ',.-]{3,70}$`
userName	string	minLength: 1 pattern: `^[.a-zA-Z0-9]{3,16}$`
password	string	minLength: 12
email	string	minLength: 1 pattern: `^[a-zA-Z0-9.!#$%&'+\/=?^_`{\|}~-]+@a-zA-Z0-9?(?:.a-zA-Z0-9?)$`

POST /api/user/register

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/user/register' \ --header 'Authorization: Bearer {token}' \ --data '{  "fullName": "{string}",  "userName": "{string}",  "password": "{string}",  "email": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Create a user

Auth

Request Body

object	object
fullName	string	minLength: 1 pattern: `^[\p{L}\p{M} ',.-]{3,70}$`
userName	string	minLength: 1 pattern: `^[.a-zA-Z0-9]{3,16}$`
password	string	minLength: 12
email	string	minLength: 1 pattern: `^[a-zA-Z0-9.!#$%&'+\/=?^_`{\|}~-]+@a-zA-Z0-9?(?:.a-zA-Z0-9?)$`
role	string	minLength: 1

POST /api/user/create

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/user/create' \ --header 'Authorization: Bearer {token}' \ --data '{  "fullName": "{string}",  "userName": "{string}",  "password": "{string}",  "email": "{string}",  "role": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Authenticate with a username and password

Authenticate with a username and password to obtain a JWT token,Most of the APIs require authentication in the form of providing a JWT token. Call this API in order to receive a token but please note that it's only valid for an hour so it should be periodically refreshed.

Auth

Request Body

object	object
userName	string	minLength: 1
password	string	minLength: 1

POST /api/user/authenticate

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/user/authenticate' \ --header 'Authorization: Bearer {token}' \ --data '{  "userName": "{string}",  "password": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
accessToken	string
accessTokenExpiryTime	date-time
refreshToken	string
refreshTokenExpiryTime	date-time
fullName	string
email	string
userName	string
role	int32	0 = None, 1 = ReadOnlyAdministrator, 2 = Administrator, 3 = ServiceRole, 4 = SsoAdministrator, 5 = SsoReadOnlyAdministrator Enum: `0`,`1`,`2`,`3`,`4`,`5`

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}", "fullName": "{string}", "email": "{string}", "userName": "{string}", "role": "{int32}"}
Copy

Refresh user token

Auth

Request Body

object	object
accessToken	string
refreshToken	string

POST /api/user/refreshToken

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/user/refreshToken' \ --header 'Authorization: Bearer {token}' \ --data '{  "accessToken": "{string}",  "refreshToken": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Logout

Auth

POST /api/user/logout

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/user/logout' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update user role

Auth

Request Body

object	object
userId	string	minLength: 1
role	string	minLength: 1

PUT /api/user/role

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/user/role' \ --header 'Authorization: Bearer {token}' \ --data '{  "userId": "{string}",  "role": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Fetch users

Auth

GET /api/user/requests

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/user/requests' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
entries	array[object]
id	string
userName	string
fullName	string
email	string
role	int32	0 = None, 1 = ReadOnlyAdministrator, 2 = Administrator, 3 = ServiceRole, 4 = SsoAdministrator, 5 = SsoReadOnlyAdministrator Enum: `0`,`1`,`2`,`3`,`4`,`5`
totalCount	int64

Response

xxxxxxxxxx
 
{ "entries": [  {   "id": "{string}",   "userName": "{string}",   "fullName": "{string}",   "email": "{string}",   "role": "{int32}"  } ], "totalCount": "{int64}"}
Copy

Delete a user

Auth

Path Params

userId string

DELETE /api/user/{userId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/user/%7BuserId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Update a user

Auth

Request Body

object	object
userName	string	minLength: 1 pattern: `^[.a-zA-Z0-9]{3,16}$`
fullName	string	pattern: `^[\p{L}\p{M} ',.-]{3,70}$`
currentPassword	string	minLength: 12
newPassword	string	minLength: 12
email	string	pattern: `^[a-zA-Z0-9.!#$%&'+\/=?^_`{\|}~-]+@a-zA-Z0-9?(?:.a-zA-Z0-9?)$`

PUT /api/user

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/user' \ --header 'Authorization: Bearer {token}' \ --data '{  "userName": "{string}",  "fullName": "{string}",  "currentPassword": "{string}",  "newPassword": "{string}",  "email": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
accessToken	string
accessTokenExpiryTime	date-time
refreshToken	string
refreshTokenExpiryTime	date-time

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}"}
Copy

Request password reset

Auth

Request Body

object	object
userInput	string	minLength: 1
isSmtpConfigConfigured	boolean
user	object
id	string
fullName	string
userName	string
passwordHash	string
passwordSalt	string
email	string
role	int32	0 = None, 1 = ReadOnlyAdministrator, 2 = Administrator, 3 = ServiceRole, 4 = SsoAdministrator, 5 = SsoReadOnlyAdministrator Enum: `0`,`1`,`2`,`3`,`4`,`5`
accountSecurity	object
incrementalDelay	object
ticks	int64
failedLoginDate	date-time

POST /api/user/password/reset

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/user/password/reset' \ --header 'Authorization: Bearer {token}' \ --data '{  "userInput": "{string}",  "isSmtpConfigConfigured": "{boolean}",  "user": {    "id": "{string}",    "fullName": "{string}",    "userName": "{string}",    "passwordHash": "{string}",    "passwordSalt": "{string}",    "email": "{string}",    "role": "{int32}",    "accountSecurity": {      "incrementalDelay": {        "ticks": "{int64}"      },      "failedLoginDate": "{date-time}"    }  }}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Reset user password

Auth

Request Body

object	object
newPassword	string	minLength: 12
newPasswordConfirmation	string	minLength: 12
secureToken	string

POST /api/user/password

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/user/password' \ --header 'Authorization: Bearer {token}' \ --data '{  "newPassword": "{string}",  "newPasswordConfirmation": "{string}",  "secureToken": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Deprecated Soon To Be Removed

/api/CorePool/{id}

/api/MetaDefenderCore

/api/MetaDefenderCore

/api/MetaDefenderCore

/api/MetaDefenderCore/{metaDefenderId}

/api/MetaDefenderCore/{metaDefenderId}

/api/scan/active/{scanId}/{activeFileId}

/api/scan/realtime/{storageId}

/api/scan/last_completed/{storageId}

/api/storage/amazons3

/api/storage/amazons3/{storageId}

/api/storage/onedrive

/api/storage/onedrive/{storageId}

/api/storage/box

/api/storage/box/{storageId}

/api/storage/smb

/api/storage/smb/{storageId}

/api/storage/azureblob

/api/storage/azureblob/{storageId}

/api/storage/alibabacloud

/api/storage/alibabacloud/{storageId}

/api/storage/googlecloud

/api/storage/googlecloud/{storageId}

/api/storage/azurefiles

/api/storage/azurefiles/{storageId}

CorePoolDeprecated

Fetch MetaDefender Core Pools

Auth

GET /api/CorePool

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/CorePool' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
entries	array[object]
id	string
name	string
mdCores	array[object]
id	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number
userAgent	string
workflowRule	string
displayName	string
usedBy	array[object]
name	string
storageType	object
name	string
categoryType	int32	0 = Local, 1 = Cloud, 2 = Object Enum: `0`,`1`,`2`
protocolType	int32	0 = Smb, 1 = GraphSdk, 2 = BoxSdk, 3 = AwsSdk, 4 = AzureBlobSdk, 5 = AlibabaCloudSdk, 6 = GoogleCloudSdk, 7 = AzureFilesSdk, 8 = Sftp Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
vendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`

Expand

Response

xxxxxxxxxx
 
{ "entries": [  {   "id": "{string}",   "name": "{string}",   "mdCores": [    {     "id": "{string}",     "url": "{string}",     "ip": "{string}",     "apiKey": "{string}",     "timeout": {      "ticks": "{int64}",      "days": "{int32}",      "hours": "{int32}",      "milliseconds": "{int32}",      "microseconds": "{int32}",      "nanoseconds": "{int32}",      "minutes": "{int32}",      "seconds": "{int32}",      "totalDays": "{number}",      "totalHours": "{number}",      "totalMilliseconds": "{number}",      "totalMicroseconds": "{number}",      "totalNanoseconds": "{number}",      "totalMinutes": "{number}",      "totalSeconds": "{number}"     },     "userAgent": "{string}",     "workflowRule": "{string}",     "displayName": "{string}"    }   ],   "usedBy": [    {     "name": "{string}",     "storageType": {      "name": "{string}",      "categoryType": "{int32}",      "protocolType": "{int32}",      "vendorType": "{int32}"     }    }   ]  } ]}
Copy

CorePoolDeprecated

Update an existing MetaDefender Core Pool

Auth

Request Body

object object

string

minLength: 1

name

string

maxLength: 30

minLength: 3

PUT /api/CorePool

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/CorePool' \ --header 'Authorization: Bearer {token}' \ --data '{  "id": "{string}",  "name": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

CorePoolDeprecated

Add a new MetaDefender Core Pool

Auth

Request Body

object object

name

string

maxLength: 30

minLength: 3

POST /api/CorePool

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/CorePool' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

{corePoolId}Deprecated

Get MetaDefender Core Pool by ID

Auth

Path Params

corePoolId string

GET /api/CorePool/{corePoolId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/CorePool/%7BcorePoolId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
corePool	object
id	string
name	string
mdCores	array[object]
id	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number
userAgent	string
workflowRule	string
displayName	string
usedBy	array[object]
name	string
storageType	object
name	string
categoryType	int32	0 = Local, 1 = Cloud, 2 = Object Enum: `0`,`1`,`2`
protocolType	int32	0 = Smb, 1 = GraphSdk, 2 = BoxSdk, 3 = AwsSdk, 4 = AzureBlobSdk, 5 = AlibabaCloudSdk, 6 = GoogleCloudSdk, 7 = AzureFilesSdk, 8 = Sftp Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
vendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "corePool": {  "id": "{string}",  "name": "{string}",  "mdCores": [   {    "id": "{string}",    "url": "{string}",    "ip": "{string}",    "apiKey": "{string}",    "timeout": {     "ticks": "{int64}",     "days": "{int32}",     "hours": "{int32}",     "milliseconds": "{int32}",     "microseconds": "{int32}",     "nanoseconds": "{int32}",     "minutes": "{int32}",     "seconds": "{int32}",     "totalDays": "{number}",     "totalHours": "{number}",     "totalMilliseconds": "{number}",     "totalMicroseconds": "{number}",     "totalNanoseconds": "{number}",     "totalMinutes": "{number}",     "totalSeconds": "{number}"    },    "userAgent": "{string}",    "workflowRule": "{string}",    "displayName": "{string}"   }  ],  "usedBy": [   {    "name": "{string}",    "storageType": {     "name": "{string}",     "categoryType": "{int32}",     "protocolType": "{int32}",     "vendorType": "{int32}"    }   }  ] }}
Copy

{id}Deprecated

Delete MetaDefender Core Pool

Auth

Path Params

id string

DELETE /api/CorePool/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/CorePool/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

MetaDefenderCoreDeprecated

Fetch MetaDefender Core servers

Auth

Query String

corePoolId string

GET /api/MetaDefenderCore

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/MetaDefenderCore' \ --header 'Authorization: Bearer {token}' \ --data corePoolId={corePoolId}
Copy

Responses

200

Success

object	object
entries	array[object]
id	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number
userAgent	string
workflowRule	string
displayName	string

Response

xxxxxxxxxx
 
{ "entries": [  {   "id": "{string}",   "url": "{string}",   "ip": "{string}",   "apiKey": "{string}",   "timeout": {    "ticks": "{int64}",    "days": "{int32}",    "hours": "{int32}",    "milliseconds": "{int32}",    "microseconds": "{int32}",    "nanoseconds": "{int32}",    "minutes": "{int32}",    "seconds": "{int32}",    "totalDays": "{number}",    "totalHours": "{number}",    "totalMilliseconds": "{number}",    "totalMicroseconds": "{number}",    "totalNanoseconds": "{number}",    "totalMinutes": "{number}",    "totalSeconds": "{number}"   },   "userAgent": "{string}",   "workflowRule": "{string}",   "displayName": "{string}"  } ]}
Copy

MetaDefenderCoreDeprecated

Update MetaDefender Core server

Auth

Request Body

object	object
id	string
url	string	minLength: 1 pattern: `^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])?)?$)\|(^((https?):\/\/)?\[(?:0\:)?:?01\](:([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])?)?$)).)$`
apiKey	string
timeout	object
ticks	int64
userAgent	string
workflowRule	string
corePoolId	string

PUT /api/MetaDefenderCore

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/MetaDefenderCore' \ --header 'Authorization: Bearer {token}' \ --data '{  "id": "{string}",  "url": "{string}",  "apiKey": "{string}",  "timeout": {    "ticks": "{int64}"  },  "userAgent": "{string}",  "workflowRule": "{string}",  "corePoolId": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

MetaDefenderCoreDeprecated

Add a new MetaDefender Core Server

Auth

Request Body

object	object
id	string
url	string	minLength: 1 pattern: `^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])?)?$)\|(^((https?):\/\/)?\[(?:0\:)?:?01\](:([0-9]{1,4}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])?)?$)).)$`
apiKey	string
timeout	object
ticks	int64
userAgent	string
workflowRule	string
corePoolId	string

POST /api/MetaDefenderCore

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/MetaDefenderCore' \ --header 'Authorization: Bearer {token}' \ --data '{  "id": "{string}",  "url": "{string}",  "apiKey": "{string}",  "timeout": {    "ticks": "{int64}"  },  "userAgent": "{string}",  "workflowRule": "{string}",  "corePoolId": "{string}"}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

{metaDefenderId}Deprecated

Get MetaDefender Core server by ID

Auth

Path Params

metaDefenderId string

GET /api/MetaDefenderCore/{metaDefenderId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/MetaDefenderCore/%7BmetaDefenderId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
id	string
url	string
ip	string
apiKey	string
timeout	object
ticks	int64
days	int32
hours	int32
milliseconds	int32
microseconds	int32
nanoseconds	int32
minutes	int32
seconds	int32
totalDays	number
totalHours	number
totalMilliseconds	number
totalMicroseconds	number
totalNanoseconds	number
totalMinutes	number
totalSeconds	number
userAgent	string
workflowRule	string
displayName	string

Response

xxxxxxxxxx
 
{ "id": "{string}", "url": "{string}", "ip": "{string}", "apiKey": "{string}", "timeout": {  "ticks": "{int64}",  "days": "{int32}",  "hours": "{int32}",  "milliseconds": "{int32}",  "microseconds": "{int32}",  "nanoseconds": "{int32}",  "minutes": "{int32}",  "seconds": "{int32}",  "totalDays": "{number}",  "totalHours": "{number}",  "totalMilliseconds": "{number}",  "totalMicroseconds": "{number}",  "totalNanoseconds": "{number}",  "totalMinutes": "{number}",  "totalSeconds": "{number}" }, "userAgent": "{string}", "workflowRule": "{string}", "displayName": "{string}"}
Copy

{metaDefenderId}Deprecated

Delete MetaDefender Core server

Auth

Path Params

metaDefenderId string

DELETE /api/MetaDefenderCore/{metaDefenderId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://<MDSS_HOST>/api/MetaDefenderCore/%7BmetaDefenderId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
No response
Copy

{activeFileId}Deprecated

(Deprecated) Get an active scan by scan ID and file ID

Auth

Path Params

scanId	string
activeFileId	string

GET /api/scan/active/{scanId}/{activeFileId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/scan/active/%7BscanId%7D/%7BactiveFileId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	int32	0 = NotStarted, 1 = Running, 2 = Cancelled, 3 = Failed, 4 = Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
pciDssComplianceViolationsCount	int64
hipaaComplianceViolationsCount	int64
gdprComplianceViolationsCount	int64
malwareSecurityAlertsCount	int64
vulnerabilitiesSecurityAlertsCount	int64
piiSecurityAlertsCount	int64
pciDssComplianceViolationsPercentageIncrease	int64
hipaaComplianceViolationsPercentageIncrease	int64
gdprComplianceViolationsPercentageIncrease	int64
malwareSecurityAlertsPercentageIncrease	int64
vulnerabilitiesSecurityAlertsPercentageIncrease	int64
piiSecurityAlertsPercentageIncrease	int64
highRiskAccounts	array[object]
id	string
displayName	string
blockedFilesCount	int64
scanSequenceDto	object
previousScanId	string
nextScanId	string
scanConfigurationId	string

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "id": "{string}", "name": "{string}", "startTime": "{date-time}", "stopTime": "{date-time}", "scanType": "{string}", "scanningState": "{int32}", "scanStatusDto": {  "pendingFilesCount": "{int64}",  "allowedFilesCount": "{int64}",  "blockedFilesCount": "{int64}",  "totalFilesCount": "{int64}",  "processingFailedCount": "{int64}",  "processedFilesCount": "{int64}" }, "scanStatsDto": {  "pciDssComplianceViolationsCount": "{int64}",  "hipaaComplianceViolationsCount": "{int64}",  "gdprComplianceViolationsCount": "{int64}",  "malwareSecurityAlertsCount": "{int64}",  "vulnerabilitiesSecurityAlertsCount": "{int64}",  "piiSecurityAlertsCount": "{int64}",  "pciDssComplianceViolationsPercentageIncrease": "{int64}",  "hipaaComplianceViolationsPercentageIncrease": "{int64}",  "gdprComplianceViolationsPercentageIncrease": "{int64}",  "malwareSecurityAlertsPercentageIncrease": "{int64}",  "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}",  "piiSecurityAlertsPercentageIncrease": "{int64}",  "highRiskAccounts": [   {    "id": "{string}",    "displayName": "{string}",    "blockedFilesCount": "{int64}"   }  ] }, "scanSequenceDto": {  "previousScanId": "{string}",  "nextScanId": "{string}" }, "scanConfigurationId": "{string}"}
Copy

{storageId}Deprecated

(Deprecated) Get Real-Time scan

Auth

Path Params

storageId string

GET /api/scan/realtime/{storageId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/scan/realtime/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	int32	0 = NotStarted, 1 = Running, 2 = Cancelled, 3 = Failed, 4 = Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
pciDssComplianceViolationsCount	int64
hipaaComplianceViolationsCount	int64
gdprComplianceViolationsCount	int64
malwareSecurityAlertsCount	int64
vulnerabilitiesSecurityAlertsCount	int64
piiSecurityAlertsCount	int64
pciDssComplianceViolationsPercentageIncrease	int64
hipaaComplianceViolationsPercentageIncrease	int64
gdprComplianceViolationsPercentageIncrease	int64
malwareSecurityAlertsPercentageIncrease	int64
vulnerabilitiesSecurityAlertsPercentageIncrease	int64
piiSecurityAlertsPercentageIncrease	int64
highRiskAccounts	array[object]
id	string
displayName	string
blockedFilesCount	int64
scanSequenceDto	object
previousScanId	string
nextScanId	string
scanConfigurationId	string
isRealTimeEnabled	boolean
handlingType	int32	0 = Polling, 1 = EventBased Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "id": "{string}", "name": "{string}", "startTime": "{date-time}", "stopTime": "{date-time}", "scanType": "{string}", "scanningState": "{int32}", "scanStatusDto": {  "pendingFilesCount": "{int64}",  "allowedFilesCount": "{int64}",  "blockedFilesCount": "{int64}",  "totalFilesCount": "{int64}",  "processingFailedCount": "{int64}",  "processedFilesCount": "{int64}" }, "scanStatsDto": {  "pciDssComplianceViolationsCount": "{int64}",  "hipaaComplianceViolationsCount": "{int64}",  "gdprComplianceViolationsCount": "{int64}",  "malwareSecurityAlertsCount": "{int64}",  "vulnerabilitiesSecurityAlertsCount": "{int64}",  "piiSecurityAlertsCount": "{int64}",  "pciDssComplianceViolationsPercentageIncrease": "{int64}",  "hipaaComplianceViolationsPercentageIncrease": "{int64}",  "gdprComplianceViolationsPercentageIncrease": "{int64}",  "malwareSecurityAlertsPercentageIncrease": "{int64}",  "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}",  "piiSecurityAlertsPercentageIncrease": "{int64}",  "highRiskAccounts": [   {    "id": "{string}",    "displayName": "{string}",    "blockedFilesCount": "{int64}"   }  ] }, "scanSequenceDto": {  "previousScanId": "{string}",  "nextScanId": "{string}" }, "scanConfigurationId": "{string}", "isRealTimeEnabled": "{boolean}", "handlingType": "{int32}"}
Copy

{storageId}Deprecated

(Deprecated) Fetch last completed scan

Auth

Path Params

storageId string

GET /api/scan/last_completed/{storageId}

xxxxxxxxxx
 
curl --get \ --url 'http://<MDSS_HOST>/api/scan/last_completed/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	int32	0 = NotStarted, 1 = Running, 2 = Cancelled, 3 = Failed, 4 = Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
pciDssComplianceViolationsCount	int64
hipaaComplianceViolationsCount	int64
gdprComplianceViolationsCount	int64
malwareSecurityAlertsCount	int64
vulnerabilitiesSecurityAlertsCount	int64
piiSecurityAlertsCount	int64
pciDssComplianceViolationsPercentageIncrease	int64
hipaaComplianceViolationsPercentageIncrease	int64
gdprComplianceViolationsPercentageIncrease	int64
malwareSecurityAlertsPercentageIncrease	int64
vulnerabilitiesSecurityAlertsPercentageIncrease	int64
piiSecurityAlertsPercentageIncrease	int64
highRiskAccounts	array[object]
id	string
displayName	string
blockedFilesCount	int64
scanSequenceDto	object
previousScanId	string
nextScanId	string
scanConfigurationId	string

Expand

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "id": "{string}", "name": "{string}", "startTime": "{date-time}", "stopTime": "{date-time}", "scanType": "{string}", "scanningState": "{int32}", "scanStatusDto": {  "pendingFilesCount": "{int64}",  "allowedFilesCount": "{int64}",  "blockedFilesCount": "{int64}",  "totalFilesCount": "{int64}",  "processingFailedCount": "{int64}",  "processedFilesCount": "{int64}" }, "scanStatsDto": {  "pciDssComplianceViolationsCount": "{int64}",  "hipaaComplianceViolationsCount": "{int64}",  "gdprComplianceViolationsCount": "{int64}",  "malwareSecurityAlertsCount": "{int64}",  "vulnerabilitiesSecurityAlertsCount": "{int64}",  "piiSecurityAlertsCount": "{int64}",  "pciDssComplianceViolationsPercentageIncrease": "{int64}",  "hipaaComplianceViolationsPercentageIncrease": "{int64}",  "gdprComplianceViolationsPercentageIncrease": "{int64}",  "malwareSecurityAlertsPercentageIncrease": "{int64}",  "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}",  "piiSecurityAlertsPercentageIncrease": "{int64}",  "highRiskAccounts": [   {    "id": "{string}",    "displayName": "{string}",    "blockedFilesCount": "{int64}"   }  ] }, "scanSequenceDto": {  "previousScanId": "{string}",  "nextScanId": "{string}" }, "scanConfigurationId": "{string}"}
Copy

amazons3Deprecated

(Deprecated - use /storage) Add an Amazon S3 storage

Auth

Request Body

object	object
name	string	maxLength: 30 minLength: 1
serviceUrl	string
accessKeyId	string
secretAccessKey	string
regionEndpoint	string
bucketName	string	minLength: 1
folderLocation	string
useIamRole	boolean
assumeRoleArn	string	pattern: `^arn:aws:iam::\d+:role/[a-zA-Z0-9_+=,.@-]+$`
storageVendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`

POST /api/storage/amazons3

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage/amazons3' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "serviceUrl": "{string}",  "accessKeyId": "{string}",  "secretAccessKey": "{string}",  "regionEndpoint": "{string}",  "bucketName": "{string}",  "folderLocation": "{string}",  "useIamRole": "{boolean}",  "assumeRoleArn": "{string}",  "storageVendorType": "{int32}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

{storageId}Deprecated

(Deprecated - use /storage/{storageId}) Update an Amazon S3 storage

Auth

Path Params

storageId string

Request Body

object	object
name	string	maxLength: 30 minLength: 1
serviceUrl	string
accessKeyId	string
secretAccessKey	string
regionEndpoint	string
bucketName	string	minLength: 1
folderLocation	string
useIamRole	boolean
assumeRoleArn	string	pattern: `^arn:aws:iam::\d+:role/[a-zA-Z0-9_+=,.@-]+$`
storageVendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`

PATCH /api/storage/amazons3/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/amazons3/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "serviceUrl": "{string}",  "accessKeyId": "{string}",  "secretAccessKey": "{string}",  "regionEndpoint": "{string}",  "bucketName": "{string}",  "folderLocation": "{string}",  "useIamRole": "{boolean}",  "assumeRoleArn": "{string}",  "storageVendorType": "{int32}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

onedriveDeprecated

(Deprecated - use /storage) Add an One Drive storage

Auth

Request Body

object	object
name	string	maxLength: 30 minLength: 1
tenantId	string	maxLength: 36 minLength: 36
clientId	string	maxLength: 36 minLength: 36
clientSecret	string	maxLength: 50 minLength: 1
group	string

POST /api/storage/onedrive

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage/onedrive' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "tenantId": "{string}",  "clientId": "{string}",  "clientSecret": "{string}",  "group": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

{storageId}Deprecated

(Deprecated - use /storage/{storageId}) Update an One Drive storage

Auth

Path Params

storageId string

Request Body

object	object
name	string	maxLength: 30 minLength: 1
tenantId	string	maxLength: 36 minLength: 36
clientId	string	maxLength: 36 minLength: 36
clientSecret	string	maxLength: 50 minLength: 1
group	string

PATCH /api/storage/onedrive/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/onedrive/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "tenantId": "{string}",  "clientId": "{string}",  "clientSecret": "{string}",  "group": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

boxDeprecated

(Deprecated - use /storage) Add a Box storage

Auth

Request Body

object	object
Credentials	file
UserName	string
FolderPath	string
GroupName	string
Name	string	maxLength: 30

POST /api/storage/box

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage/box' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

{storageId}Deprecated

(Deprecated - use /storage/{storageId}) Update a Box storage

Auth

Path Params

storageId string

Request Body

object	object
Credentials	file
UserName	string
FolderPath	string
GroupName	string
Name	string	maxLength: 30

PATCH /api/storage/box/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/box/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

smbDeprecated

(Deprecated - use /storage) Add Dell Isilon/SMB Compatibile

Auth

Request Body

object	object
name	string	maxLength: 30 minLength: 1
storageVendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
user	string	minLength: 1
password	string	minLength: 1
sharePath	string	minLength: 1

POST /api/storage/smb

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage/smb' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "storageVendorType": "{int32}",  "user": "{string}",  "password": "{string}",  "sharePath": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

{storageId}Deprecated

(Deprecated - use /storage/{storageId}) Update a Dell Isilon/SMB Compatibile

Auth

Path Params

storageId string

Request Body

object	object
name	string	maxLength: 30 minLength: 1
storageVendorType	int32	0 = AmazonS3, 1 = OneDrive, 2 = Box, 3 = DellIsilon, 4 = AzureFiles, 5 = SmbCompatible, 6 = S3Compatible, 7 = AzureBlob, 8 = AlibabaCloud, 9 = GoogleCloud, 10 = Sftp, 11 = SharePoint Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
user	string	minLength: 1
password	string	minLength: 1
sharePath	string	minLength: 1

PATCH /api/storage/smb/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/smb/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "storageVendorType": "{int32}",  "user": "{string}",  "password": "{string}",  "sharePath": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

azureblobDeprecated

(Deprecated - use /storage) Add an Azure Blob storage

Auth

Request Body

object	object
name	string	maxLength: 30 minLength: 1
tenantId	string	maxLength: 36 minLength: 36
storageAccount	string	maxLength: 24 minLength: 3
clientId	string	maxLength: 36 minLength: 36
clientSecret	string	maxLength: 50 minLength: 1
container	string	maxLength: 63 minLength: 0
cloudType	string	maxLength: 63 minLength: 0

POST /api/storage/azureblob

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage/azureblob' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "tenantId": "{string}",  "storageAccount": "{string}",  "clientId": "{string}",  "clientSecret": "{string}",  "container": "{string}",  "cloudType": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

{storageId}Deprecated

(Deprecated - use /storage/{storageId}) Update an Azure Blob storage

Auth

Path Params

storageId string

Request Body

object	object
name	string	maxLength: 30 minLength: 1
tenantId	string	maxLength: 36 minLength: 36
storageAccount	string	maxLength: 24 minLength: 3
clientId	string	maxLength: 36 minLength: 36
clientSecret	string	maxLength: 50 minLength: 1
container	string	maxLength: 63 minLength: 0
cloudType	string	maxLength: 63 minLength: 0

PATCH /api/storage/azureblob/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/azureblob/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "tenantId": "{string}",  "storageAccount": "{string}",  "clientId": "{string}",  "clientSecret": "{string}",  "container": "{string}",  "cloudType": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

alibabacloudDeprecated

(Deprecated - use /storage) Add an Alibaba Cloud storage

Auth

Request Body

object	object
name	string	maxLength: 30 minLength: 1
endpoint	string	minLength: 1
accessKeyId	string
accessKeySecret	string
bucketName	string	minLength: 1
folderLocation	string
useRamRole	boolean

POST /api/storage/alibabacloud

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage/alibabacloud' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "endpoint": "{string}",  "accessKeyId": "{string}",  "accessKeySecret": "{string}",  "bucketName": "{string}",  "folderLocation": "{string}",  "useRamRole": "{boolean}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

{storageId}Deprecated

(Deprecated - use /storage/{storageId}) Update an Alibaba Cloud storage

Auth

Path Params

storageId string

Request Body

object	object
name	string	maxLength: 30 minLength: 1
endpoint	string	minLength: 1
accessKeyId	string
accessKeySecret	string
bucketName	string	minLength: 1
folderLocation	string
useRamRole	boolean

PATCH /api/storage/alibabacloud/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/alibabacloud/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "endpoint": "{string}",  "accessKeyId": "{string}",  "accessKeySecret": "{string}",  "bucketName": "{string}",  "folderLocation": "{string}",  "useRamRole": "{boolean}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

googlecloudDeprecated

(Deprecated - use /storage) Add a Google Cloud storage

Auth

Request Body

object	object
Credentials	file
BucketName	string
FolderLocation	string
UseAdc	boolean
Name	string	maxLength: 30

POST /api/storage/googlecloud

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage/googlecloud' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

{storageId}Deprecated

(Deprecated - use /storage/{storageId}) Update a Google Cloud storage

Auth

Path Params

storageId string

Request Body

object	object
Credentials	file
BucketName	string
FolderLocation	string
UseAdc	boolean
Name	string	maxLength: 30

PATCH /api/storage/googlecloud/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/googlecloud/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

azurefilesDeprecated

(Deprecated - use /storage) Add an Azure Files storage

Auth

Request Body

object	object
name	string	maxLength: 30 minLength: 1
accountName	string	minLength: 1
accountKey	string	minLength: 1
shareName	string	minLength: 1
folderLocation	string

POST /api/storage/azurefiles

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/storage/azurefiles' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "accountName": "{string}",  "accountKey": "{string}",  "shareName": "{string}",  "folderLocation": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

{storageId}Deprecated

(Deprecated - use /storage/{storageId}) Update an Azure Files storage

Auth

Path Params

storageId string

Request Body

object	object
name	string	maxLength: 30 minLength: 1
accountName	string	minLength: 1
accountKey	string	minLength: 1
shareName	string	minLength: 1
folderLocation	string

PATCH /api/storage/azurefiles/{storageId}

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/azurefiles/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "accountName": "{string}",  "accountKey": "{string}",  "shareName": "{string}",  "folderLocation": "{string}"}'
Copy

Responses

200

Success

object	object
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Webhook