MetaDefender Storage Security API v1

/api/account/{accountId}

/api/account/count

Fetch all accounts

Auth

GET /api/account

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
accounts	array[object]
id	string
name	string
description	string
storages	array[object]
id	string
groupId	string
name	string
storageClientId	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`
realTimeScanConfig
object	object
isEnabled	boolean
handlingType
integer	integer	Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
allowedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
sanitizedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
blockedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy
integer	integer	Enum: `0`,`1`
$type	string

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accounts": [  {   "id": "{string}",   "name": "{string}",   "description": "{string}",   "storages": [    {     "id": "{string}",     "groupId": "{string}",     "name": "{string}",     "storageClientId": "{string}",     "storageType": {      "name": "{string}",      "categoryType": "{integer}",      "protocolType": "{integer}",      "vendorType": "{integer}"     },     "realTimeScanConfig": {      "isEnabled": "{boolean}",      "handlingType": "{integer}",      "scanConfigurationId": "{string}"     },     "postActionsScanConfig": {      "fileTaggingConfig": {       "isTaggingPostActionEnabled": "{boolean}",       "fileTags": [        {         "fileTagKey": {          "defaultName": "{string}",          "customName": "{string}"         },         "customValues": [          {           "defaultName": "{string}",           "customName": "{string}"          }         ],         "isEnabled": "{boolean}",         "fileTagType": "{integer}"        }       ]      },      "deepCdrConfig": {       "isDeepCdrPostActionEnabled": "{boolean}",       "deepCdrOriginalFileHandlingType": "{integer}"      },      "moveDeleteRemediationConfig": {       "blockedFileRemediationConfigurationStatus": "{integer}",       "sanitizedFileRemediationConfigurationStatus": "{integer}",       "allowedFileRemediationConfigurationStatus": "{integer}",       "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",       "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",       "blockedFileHandlingType": "{integer}",       "allowedFileHandlingType": "{integer}",       "sanitizedFileHandlingType": "{integer}",       "blockedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"       },       "sanitizedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"       },       "allowedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"       },       "blockingStrategy": "{integer}"      }     },     "$type": "{string}"    }   ]  } ]}
Copy

Expand

Add an account

Auth

Request Body

object	object
name	string
description	string
storageIds	array[string]
userInfo
object	object
userId	string
userName	string

POST /api/account

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/account' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "description": "{string}",  "storageIds": [    "{array[string]...}"  ],  "userInfo": {    "userId": "{string}",    "userName": "{string}"  }}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
account
object	object
id	string
name	string
description	string
storageIds	array[string]

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "account": {  "id": "{string}",  "name": "{string}",  "description": "{string}",  "storageIds": [   "{array[string]...}"  ] }}
Copy

Update an account

Auth

Request Body

object	object
name	string
description	string
accountId	string
storageId	string
userInfo
object	object
userId	string
userName	string

PATCH /api/account

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/account' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "description": "{string}",  "accountId": "{string}",  "storageId": "{string}",  "userInfo": {    "userId": "{string}",    "userName": "{string}"  }}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
updatedAccount
object	object
name	string
description	string
storageIds	array[string]

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedAccount": {  "name": "{string}",  "description": "{string}",  "storageIds": [   "{array[string]...}"  ] }}
Copy

Fetch account by ID

Auth

Path Params

accountId string

GET /api/account/{accountId}

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
account
object	object
id	string
name	string
description	string
storages	array[object]
id	string
groupId	string
name	string
storageClientId	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`
realTimeScanConfig
object	object
isEnabled	boolean
handlingType
integer	integer	Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
allowedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
sanitizedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
blockedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy
integer	integer	Enum: `0`,`1`
$type	string

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "account": {  "id": "{string}",  "name": "{string}",  "description": "{string}",  "storages": [   {    "id": "{string}",    "groupId": "{string}",    "name": "{string}",    "storageClientId": "{string}",    "storageType": {     "name": "{string}",     "categoryType": "{integer}",     "protocolType": "{integer}",     "vendorType": "{integer}"    },    "realTimeScanConfig": {     "isEnabled": "{boolean}",     "handlingType": "{integer}",     "scanConfigurationId": "{string}"    },    "postActionsScanConfig": {     "fileTaggingConfig": {      "isTaggingPostActionEnabled": "{boolean}",      "fileTags": [       {        "fileTagKey": {         "defaultName": "{string}",         "customName": "{string}"        },        "customValues": [         {          "defaultName": "{string}",          "customName": "{string}"         }        ],        "isEnabled": "{boolean}",        "fileTagType": "{integer}"       }      ]     },     "deepCdrConfig": {      "isDeepCdrPostActionEnabled": "{boolean}",      "deepCdrOriginalFileHandlingType": "{integer}"     },     "moveDeleteRemediationConfig": {      "blockedFileRemediationConfigurationStatus": "{integer}",      "sanitizedFileRemediationConfigurationStatus": "{integer}",      "allowedFileRemediationConfigurationStatus": "{integer}",      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",      "blockedFileHandlingType": "{integer}",      "allowedFileHandlingType": "{integer}",      "sanitizedFileHandlingType": "{integer}",      "blockedFileStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "sanitizedFileStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "allowedFileStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "blockingStrategy": "{integer}"     }    },    "$type": "{string}"   }  ] }}
Copy

Expand

Delete an account

Auth

Path Params

accountId string

DELETE /api/account/{accountId}

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
accountId	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accountId": "{string}"}
Copy

Fetch the number of accounts

Auth

GET /api/account/count

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
accountCount
object	object
count	int64

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accountCount": {  "count": "{int64}" }}
Copy

Audit

List audit information

/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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array[object]
id	string
logLevel	integer	Enum: `0`,`1`,`2`,`3`
details	string
logType	integer	Enum: `0`,`1`,`2`,`100`,`101`,`102`,`103`,`200`,`201`,`202`,`203`,`204`,`205`,`206`,`207`,`208`,`209`,`210`,`211`,`300`,`301`,`302`,`320`,`321`,`322`,`330`,`331`,`332`,`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`,`1600`
userId	string
category	integer	Enum: `0`,`1`,`2`,`3`,`4`,`6`,`7`,`8`,`9`,`10`
timeStamp	date-time
userName	string
filterCount	int64
totalCount	int64

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "id": "{string}",   "logLevel": "{integer}",   "details": "{string}",   "logType": "{integer}",   "userId": "{string}",   "category": "{integer}",   "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
exportRetention	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} \ --data exportRetention={exportRetention}
Copy

Responses

200

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`,`3`,`4`,`5`,`6`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
areSmtpSettingsImported	boolean
isLicenseImported	boolean
isRetentionImported	boolean
activationDto
object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "areSmtpSettingsImported": "{boolean}", "isLicenseImported": "{boolean}", "isRetentionImported": "{boolean}", "activationDto": {  "result": "{integer}",  "responseKey": "{string}",  "responseMessage": "{string}",  "responseMessageParams": {},  "success": "{RestResponse}",  "error": "{RestResponse}" }}
Copy

Get enabled modules

Auth

GET /api/configuration/EnabledModules

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
enabledModules	array[integer]

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "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

file file

Response

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

External Logger

Manage external loggers

/api/externallogger

/api/externallogger/status

/api/externallogger/udpSyslog

/api/externallogger/udpSyslog

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

/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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array[object]
id	string
isEnabled	boolean
loggerType	integer	Enum: `0`
connectionSettings
object	object
$type	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "id": "{string}",   "isEnabled": "{boolean}",   "loggerType": "{integer}",   "connectionSettings": {    "$type": "{string}"   }  } ]}
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

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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	integer	Enum: `0`
facility	integer	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	integer	Enum: `0`
$type	string
id	string	minLength: 1

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": "{integer}",  "facility": "{integer}",  "format": "{integer}",  "$type": "{string}",  "id": "{string}"}'
Copy

Responses

200

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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	integer	Enum: `0`
facility	integer	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	integer	Enum: `0`
$type	string

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": "{integer}",  "facility": "{integer}",  "format": "{integer}",  "$type": "{string}"}'
Copy

Responses

200

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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

file file

Response

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

File

Retrieve processed files information

Scan a file on demand

This request is used to update a scanned file with passwords, in case it is an encrypted archive andit could not be scanned because the passwords to decrypt it were not provided. It can also be used withoutproviding any passwords to simply rescan a specific file from a finished scan.

Auth

Request Body

object	object
fileId	string
scanId	string
storageProtocolType	int32
passwords	array[string]

PUT /api/file

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/file' \ --header 'Authorization: Bearer {token}' \ --data '{  "fileId": "{string}",  "scanId": "{string}",  "storageProtocolType": "{int32}",  "passwords": [    "{array[string]...}"  ]}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
Copy

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`,`3`,`4`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
id	string
scanId	string
name	string
path	string
hash	string
fileOwner
object	object
userId	string
fullName	string
userName	string
emailAddress	string
size	int64
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`
storageName	string
storageLocation	string
scanName	string
progress
object	object
upload	int32
scan	int32
scanResult
object	object
extractedFiles
object	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	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	Enum: `0`,`1`,`2`
filesExtractedCount	int32
scanResults
object	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	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo
object	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	Enum: `0`,`1`,`2`
dataId	string
dlpInfo
object	object
verdict	int64
sbomInfo
object	object
finalVerdict
object	object
blocked	boolean
severity	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`
totalPackageCount	int32
verdict	string
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
overviewReport
object	object
isPartialReport	boolean
osInfo
object	object
osName	string
osVersion	string
scanMode	string
steps	array[object]
command	string
packages	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
vulnerabilities	array[object]
id	string
severity	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
arch	string
osName	string
osVersion	string
step	int32
vulnerabilityCount	int32
sha256	string
severity	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
packages	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
target	string
vulnerabilities	array[object]
id	string
severity	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
resultTemplateHash	string
vulnerabilityInfo
object	object
vulnerabilityInfoResult
object	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct
object	object
hasVulnerability	boolean
isCurrent	boolean
product
object	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor
object	object
id	int64
name	string
version	string
versionData
object	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details
object	object
cpe	string
cve	string
cvss
object	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3
object	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	integer	Enum: `0`,`1`,`2`,`3`
exception
object	object
exceptionDetails	string
exceptionMessage	string
created	date-time
lastModified	date-time
discoveryStarted	date-time
fileProcessingDetails
object	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	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
isCopied	boolean
deepCdr
object	object
isSanitized	boolean
isEncrypted	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
hasSanitizedFileBeenCopied	boolean
decryptStatus	integer	Enum: `0`,`1`,`2`
deepCdrOriginalObjectHandlingType	integer	Enum: `0`,`1`,`2`
sanitizationDetails
object	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
exception
object	object
exceptionDetails	string
exceptionMessage	string
metaDefenderCoreUrl	string
discoveryStartedDaySec	int64

Expand

Response

xxxxxxxxxx
 
{
 "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "id": "{string}", "scanId": "{string}", "name": "{string}", "path": "{string}", "hash": "{string}", "fileOwner": {...},
 "size": "{int64}", "storageType": {...},
 "storageName": "{string}", "storageLocation": "{string}", "scanName": "{string}", "progress": {...},
 "scanResult": {...},
 "processingState": "{integer}", "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`,`4`
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`,`3`,`4`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
id	string
scanId	string
name	string
path	string
hash	string
fileOwner
object	object
userId	string
fullName	string
userName	string
emailAddress	string
size	int64
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`
storageName	string
storageLocation	string
scanName	string
progress
object	object
upload	int32
scan	int32
scanResult
object	object
extractedFiles
object	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	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	Enum: `0`,`1`,`2`
filesExtractedCount	int32
scanResults
object	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	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo
object	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	Enum: `0`,`1`,`2`
dataId	string
dlpInfo
object	object
verdict	int64
sbomInfo
object	object
finalVerdict
object	object
blocked	boolean
severity	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`
totalPackageCount	int32
verdict	string
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
overviewReport
object	object
isPartialReport	boolean
osInfo
object	object
osName	string
osVersion	string
scanMode	string
steps	array[object]
command	string
packages	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
vulnerabilities	array[object]
id	string
severity	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
arch	string
osName	string
osVersion	string
step	int32
vulnerabilityCount	int32
sha256	string
severity	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
packages	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
target	string
vulnerabilities	array[object]
id	string
severity	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
resultTemplateHash	string
vulnerabilityInfo
object	object
vulnerabilityInfoResult
object	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct
object	object
hasVulnerability	boolean
isCurrent	boolean
product
object	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor
object	object
id	int64
name	string
version	string
versionData
object	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details
object	object
cpe	string
cve	string
cvss
object	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3
object	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	integer	Enum: `0`,`1`,`2`,`3`
exception
object	object
exceptionDetails	string
exceptionMessage	string
created	date-time
lastModified	date-time
discoveryStarted	date-time
fileProcessingDetails
object	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	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
isCopied	boolean
deepCdr
object	object
isSanitized	boolean
isEncrypted	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
hasSanitizedFileBeenCopied	boolean
decryptStatus	integer	Enum: `0`,`1`,`2`
deepCdrOriginalObjectHandlingType	integer	Enum: `0`,`1`,`2`
sanitizationDetails
object	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
exception
object	object
exceptionDetails	string
exceptionMessage	string
metaDefenderCoreUrl	string
discoveryStartedDaySec	int64
filterCount	int64
totalCount	int64

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "result": "{integer}",   "responseKey": "{string}",   "responseMessage": "{string}",   "responseMessageParams": {},   "success": "{RestResponse}",   "error": "{RestResponse}",   "id": "{string}",   "scanId": "{string}",   "name": "{string}",   "path": "{string}",   "hash": "{string}",   "fileOwner": {    "userId": "{string}",    "fullName": "{string}",    "userName": "{string}",    "emailAddress": "{string}"   },   "size": "{int64}"  } ], "filterCount": "{int64}", "totalCount": "{int64}"}
Copy

Fetch all groups

Auth

GET /api/group

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
groups	array[object]
id	string
name	string
description	string
storages	array[object]
id	string
groupId	string
name	string
storageClientId	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`
realTimeScanConfig
object	object
isEnabled	boolean
handlingType
integer	integer	Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
allowedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
sanitizedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
blockedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy
integer	integer	Enum: `0`,`1`
$type	string

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "groups": [  {   "id": "{string}",   "name": "{string}",   "description": "{string}",   "storages": [    {     "id": "{string}",     "groupId": "{string}",     "name": "{string}",     "storageClientId": "{string}",     "storageType": {      "name": "{string}",      "categoryType": "{integer}",      "protocolType": "{integer}",      "vendorType": "{integer}"     },     "realTimeScanConfig": {      "isEnabled": "{boolean}",      "handlingType": "{integer}",      "scanConfigurationId": "{string}"     },     "postActionsScanConfig": {      "fileTaggingConfig": {       "isTaggingPostActionEnabled": "{boolean}",       "fileTags": [        {         "fileTagKey": {          "defaultName": "{string}",          "customName": "{string}"         },         "customValues": [          {           "defaultName": "{string}",           "customName": "{string}"          }         ],         "isEnabled": "{boolean}",         "fileTagType": "{integer}"        }       ]      },      "deepCdrConfig": {       "isDeepCdrPostActionEnabled": "{boolean}",       "deepCdrOriginalFileHandlingType": "{integer}"      },      "moveDeleteRemediationConfig": {       "blockedFileRemediationConfigurationStatus": "{integer}",       "sanitizedFileRemediationConfigurationStatus": "{integer}",       "allowedFileRemediationConfigurationStatus": "{integer}",       "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",       "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",       "blockedFileHandlingType": "{integer}",       "allowedFileHandlingType": "{integer}",       "sanitizedFileHandlingType": "{integer}",       "blockedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"       },       "sanitizedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"       },       "allowedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"       },       "blockingStrategy": "{integer}"      }     },     "$type": "{string}"    }   ]  } ]}
Copy

Expand

Add a group

Auth

Request Body

object	object
name	string
description	string
storageIds	array[string]
userInfo
object	object
userId	string
userName	string

POST /api/group

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/group' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "description": "{string}",  "storageIds": [    "{array[string]...}"  ],  "userInfo": {    "userId": "{string}",    "userName": "{string}"  }}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
group
object	object
id	string
name	string
description	string
storageIds	array[string]

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "group": {  "id": "{string}",  "name": "{string}",  "description": "{string}",  "storageIds": [   "{array[string]...}"  ] }}
Copy

Update a group

Auth

Request Body

object	object
name	string
description	string
groupId	string
userInfo
object	object
userId	string
userName	string

PATCH /api/group

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://<MDSS_HOST>/api/group' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "{string}",  "description": "{string}",  "groupId": "{string}",  "userInfo": {    "userId": "{string}",    "userName": "{string}"  }}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
updatedGroup
object	object
name	string
description	string
storageIds	array[string]

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedGroup": {  "name": "{string}",  "description": "{string}",  "storageIds": [   "{array[string]...}"  ] }}
Copy

Fetch group by ID

Auth

Path Params

groupId string

GET /api/group/{groupId}

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
group
object	object
id	string
name	string
description	string
storages	array[object]
id	string
groupId	string
name	string
storageClientId	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`
realTimeScanConfig
object	object
isEnabled	boolean
handlingType
integer	integer	Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
allowedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
sanitizedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
blockedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy
integer	integer	Enum: `0`,`1`
$type	string

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "group": {  "id": "{string}",  "name": "{string}",  "description": "{string}",  "storages": [   {    "id": "{string}",    "groupId": "{string}",    "name": "{string}",    "storageClientId": "{string}",    "storageType": {     "name": "{string}",     "categoryType": "{integer}",     "protocolType": "{integer}",     "vendorType": "{integer}"    },    "realTimeScanConfig": {     "isEnabled": "{boolean}",     "handlingType": "{integer}",     "scanConfigurationId": "{string}"    },    "postActionsScanConfig": {     "fileTaggingConfig": {      "isTaggingPostActionEnabled": "{boolean}",      "fileTags": [       {        "fileTagKey": {         "defaultName": "{string}",         "customName": "{string}"        },        "customValues": [         {          "defaultName": "{string}",          "customName": "{string}"         }        ],        "isEnabled": "{boolean}",        "fileTagType": "{integer}"       }      ]     },     "deepCdrConfig": {      "isDeepCdrPostActionEnabled": "{boolean}",      "deepCdrOriginalFileHandlingType": "{integer}"     },     "moveDeleteRemediationConfig": {      "blockedFileRemediationConfigurationStatus": "{integer}",      "sanitizedFileRemediationConfigurationStatus": "{integer}",      "allowedFileRemediationConfigurationStatus": "{integer}",      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",      "blockedFileHandlingType": "{integer}",      "allowedFileHandlingType": "{integer}",      "sanitizedFileHandlingType": "{integer}",      "blockedFileStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "sanitizedFileStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "allowedFileStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "blockingStrategy": "{integer}"     }    },    "$type": "{string}"   }  ] }}
Copy

Expand

Delete a group

Auth

Path Params

groupId string

DELETE /api/group/{groupId}

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
groupId	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "groupId": "{string}"}
Copy

Fetch the number of groups

Auth

GET /api/group/count

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
groupCount
object	object
count	int64

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "groupCount": {  "count": "{int64}" }}
Copy

Get Health Status

API that responds with 200 OK if application is running.

/api/health

health

Auth

Query String

verbose boolean

GET /api/health

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

Responses

200

object	object
apiStatus	string

Response

xxxxxxxxxx
 
{ "apiStatus": "{string}"}
Copy

Opswat Central Management

Manage OPSWAT Central Management integration

Get OCM configuration

Auth

GET /api/ocm

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
ocmInformation
object	object
id	string
serverApi	string
registrationCode	string
connectionStatus	integer	Enum: `0`,`1`
enrollStatus	integer	Enum: `0`,`1`
lastServerConnection	int64
lastConfigurationSync	int64
apiKey	string
cmVersion	string
deploymentId	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "ocmInformation": {  "id": "{string}",  "serverApi": "{string}",  "registrationCode": "{string}",  "connectionStatus": "{integer}",  "enrollStatus": "{integer}",  "lastServerConnection": "{int64}",  "lastConfigurationSync": "{int64}",  "apiKey": "{string}",  "cmVersion": "{string}",  "deploymentId": "{string}" }}
Copy

Enroll to OCM

Auth

Request Body

object	object
serverApi	string	minLength: 1
regCode	string	minLength: 1
instanceCustomIp	string	maxLength: 2048 minLength: 7

PUT /api/ocm

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
Copy

UnEnroll to OCM

Auth

POST /api/ocm

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
version	string
lastSupportedConfigVersion	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "version": "{string}", "lastSupportedConfigVersion": "{string}"}
Copy

Get managed status

Check if MDSS is managed by OCM. This is called by OCM v7.

Auth

GET /api/ocm/manage

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

Responses

200

file file

Response

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

Set managed status

Notify that MDSS is managed. This is called by OCM v7.

Auth

Query String

force boolean

Request Body

object	object
serverApi	string	minLength: 1

POST /api/ocm/manage

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/ocm/manage' \ --header 'Authorization: Bearer {token}' \ --data force={force} \ --data '{  "serverApi": "{string}"}'
Copy

Responses

200

file file

Response

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

Delete managed status

Remove MDSS from being managed. This is called by OCM v7.

Auth

DELETE /api/ocm/manage

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

Responses

200

file file

Response

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

Onboarding

Manage onboarding

Fetch onboarding configuration

Auth

Query String

newConfigSetup boolean

GET /api/onboarding

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
hasUserConfigured	boolean
hasStorageConfigured	boolean
hasScanInstanceConfigured	boolean
isOnboardingDone	boolean
isEulaAgreed	boolean

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "hasUserConfigured": "{boolean}", "hasStorageConfigured": "{boolean}", "hasScanInstanceConfigured": "{boolean}", "isOnboardingDone": "{boolean}", "isEulaAgreed": "{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

file file

Response

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

Accept Eula

Auth

POST /api/onboarding/eula

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

Responses

200

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	integer	Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto
object	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto
object	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	object
previousScanId	string
nextScanId	string
scanConfigurationId	string
errors	array[string]
totalCount	int64

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "result": "{integer}",   "responseKey": "{string}",   "responseMessage": "{string}",   "responseMessageParams": {},   "success": "{RestResponse}",   "error": "{RestResponse}",   "id": "{string}",   "name": "{string}",   "startTime": "{date-time}",   "stopTime": "{date-time}",   "scanType": "{string}",   "scanningState": "{integer}",   "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}",   "errors": [    "{array[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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array[object]
id	string
scanPoolId	string
rules	array[string]
type	integer	Enum: `0`,`1`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "id": "{string}",   "scanPoolId": "{string}",   "rules": [    "{array[string]...}"   ],   "type": "{integer}",   "name": "{string}",   "userAgent": "{string}",   "scanPool": {    "id": "{string}",    "name": "{string}",    "scanPoolType": "{integer}",    "isDefault": "{boolean}",    "scanInstances": [     {      "id": "{string}",      "scanPoolId": "{string}",      "url": "{string}",      "apiKey": "{string}",      "timeout": "{string}",      "scanInstanceType": "{integer}"     }    ]   },   "failOverScanPoolId": "{string}",   "failOverScanPool": {    "id": "{string}",    "name": "{string}",    "scanPoolType": "{integer}",    "isDefault": "{boolean}",    "scanInstances": [     {      "id": "{string}",      "scanPoolId": "{string}",      "url": "{string}",      "apiKey": "{string}",      "timeout": "{string}",      "scanInstanceType": "{integer}"     }    ]   }  } ]}
Copy

Expand

Add a new Scan Configuration

Auth

Request Body

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

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}",  "userAgent": "{string}",  "failOverScanPoolId": "{string}"}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
scanConfigurationId	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scanConfigurationId": "{string}"}
Copy

Update an existing Scan Configuration

Auth

Request Body

object	object
id	string
scanPoolId	string
rules	array[string]
name	string	maxLength: 30 minLength: 3
userAgent	string
failOverScanPoolId	string
failOverDisabled	boolean

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}",  "userAgent": "{string}",  "failOverScanPoolId": "{string}",  "failOverDisabled": "{boolean}"}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entry
object	object
id	string
scanPoolId	string
rules	array[string]
type	integer	Enum: `0`,`1`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entry": {  "id": "{string}",  "scanPoolId": "{string}",  "rules": [   "{array[string]...}"  ],  "type": "{integer}",  "name": "{string}",  "userAgent": "{string}",  "scanPool": {   "id": "{string}",   "name": "{string}",   "scanPoolType": "{integer}",   "isDefault": "{boolean}",   "scanInstances": [    {     "id": "{string}",     "scanPoolId": "{string}",     "url": "{string}",     "apiKey": "{string}",     "timeout": "{string}",     "scanInstanceType": "{integer}"    }   ]  },  "failOverScanPoolId": "{string}",  "failOverScanPool": {   "id": "{string}",   "name": "{string}",   "scanPoolType": "{integer}",   "isDefault": "{boolean}",   "scanInstances": [    {     "id": "{string}",     "scanPoolId": "{string}",     "url": "{string}",     "apiKey": "{string}",     "timeout": "{string}",     "scanInstanceType": "{integer}"    }   ]  } }}
Copy

Expand

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
scan
object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	integer	Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto
object	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto
object	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	object
previousScanId	string
nextScanId	string
scanConfigurationId	string
errors	array[string]

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scan": {  "result": "{integer}",  "responseKey": "{string}",  "responseMessage": "{string}",  "responseMessageParams": {},  "success": "{RestResponse}",  "error": "{RestResponse}",  "id": "{string}",  "name": "{string}",  "startTime": "{date-time}",  "stopTime": "{date-time}",  "scanType": "{string}",  "scanningState": "{integer}",  "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}",  "errors": [   "{array[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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
scan
object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	integer	Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto
object	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto
object	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	object
previousScanId	string
nextScanId	string
scanConfigurationId	string
errors	array[string]

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scan": {  "result": "{integer}",  "responseKey": "{string}",  "responseMessage": "{string}",  "responseMessageParams": {},  "success": "{RestResponse}",  "error": "{RestResponse}",  "id": "{string}",  "name": "{string}",  "startTime": "{date-time}",  "stopTime": "{date-time}",  "scanType": "{string}",  "scanningState": "{integer}",  "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}",  "errors": [   "{array[string]...}"  ] }}
Copy

Expand

Start a scan

To scan a specific folder using the optional Folder parameter, provide the folder's name if you're using Box, OneDrive, or SharePoint integrations. For other storage integrations, you should provide the absolute path to the folder you want to scan.

Auth

Request Body

object	object
storageId	string
name	string
scanConfigurationId	string
folder	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}",  "folder": "{string}"}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
scanId	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "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

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
nextScheduledScan
object	object
id	string
name	string
scanConfigurationId	string
type	string
createdAt	date-time
lastScanTime	date-time
nextScanTime	date-time
recurrencePatternDto
object	object
hourlyRecurrenceDto
object	object
everyNumberOfHours	int32
dailyRecurrenceDto
object	object
everyNumberOfDays	int32
weeklyRecurrenceDto
object	object
dayOfWeek	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
monthlyRecurrenceDto
object	object
everyNumberOfMonths	int32
dayOfMonth	int32
createdBy	string
scheduledScansCount	int32

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "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": "{integer}"   },   "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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`,`3`,`4`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
deletedScans	array[object]
id	string
storageId	string
scanScheduleId	string
name	string
userId	string
discoveryState	integer	Enum: `0`,`1`,`2`,`3`,`4`
scanningState	integer	Enum: `0`,`1`,`2`,`3`,`4`
scanType	integer	Enum: `0`,`1`,`2`
startTime	date-time
scanStats	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
totalStatisticsObjectsCount	int64
stopTime	date-time
scanConfigurationId	string
executionId	string
errors	array[string]
additionalPropertiesString	string

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "deletedScans": [  {   "id": "{string}",   "storageId": "{string}",   "scanScheduleId": "{string}",   "name": "{string}",   "userId": "{string}",   "discoveryState": "{integer}",   "scanningState": "{integer}",   "scanType": "{integer}",   "startTime": "{date-time}",   "scanStats": {    "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}"     }    ],    "totalStatisticsObjectsCount": "{int64}"   },   "stopTime": "{date-time}",   "scanConfigurationId": "{string}",   "executionId": "{string}",   "errors": [    "{array[string]...}"   ],   "additionalPropertiesString": "{string}"  } ]}
Copy

Expand

Scan Instance

List, add, update and delete Scan Instances

/api/scaninstance/{id}

/api/scaninstance/{id}

/api/scaninstance/Test

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "id": "{string}",   "scanPoolId": "{string}",   "url": "{string}",   "apiKey": "{string}",   "timeout": "{string}",   "scanInstanceType": "{integer}"  } ]}
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	string

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": "{string}"}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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	string
scanInstanceType	integer	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": "{string}",  "scanInstanceType": "{integer}"}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
scanInstanceId	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scanInstanceId": "{string}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entry
object	object
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entry": {  "id": "{string}",  "scanPoolId": "{string}",  "url": "{string}",  "apiKey": "{string}",  "timeout": "{string}",  "scanInstanceType": "{integer}" }}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
Copy

Test

Auth

Request Body

object	object
url	string
rules	array[string]
apiKey	string
userAgent	string

POST /api/scaninstance/Test

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array[object]
id	string
name	string
scanPoolType	integer	Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "id": "{string}",   "name": "{string}",   "scanPoolType": "{integer}",   "isDefault": "{boolean}",   "scanInstances": [    {     "id": "{string}",     "scanPoolId": "{string}",     "url": "{string}",     "apiKey": "{string}",     "timeout": "{string}",     "scanInstanceType": "{integer}"    }   ]  } ]}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
Copy

Add a new Scan Pool

Auth

Request Body

object object

name

string

maxLength: 30

minLength: 3

scanPoolType

integer

Enum: 0,1

POST /api/scanpool

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
scanPoolId	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scanPoolId": "{string}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entry
object	object
id	string
name	string
scanPoolType	integer	Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entry": {  "id": "{string}",  "name": "{string}",  "scanPoolType": "{integer}",  "isDefault": "{boolean}",  "scanInstances": [   {    "id": "{string}",    "scanPoolId": "{string}",    "url": "{string}",    "apiKey": "{string}",    "timeout": "{string}",    "scanInstanceType": "{integer}"   }  ] }}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
scanWorkflowSnapshots	array[object]
id	string
scanId	string
scanConfiguration
object	object
id	string
scanPoolId	string
rules	array[string]
type	integer	Enum: `0`,`1`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	Enum: `0`,`1`
startTimestamp	int64
stopTimestamp	int64

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scanWorkflowSnapshots": [  {   "id": "{string}",   "scanId": "{string}",   "scanConfiguration": {    "id": "{string}",    "scanPoolId": "{string}",    "rules": [     "{array[string]...}"    ],    "type": "{integer}",    "name": "{string}",    "userAgent": "{string}",    "scanPool": {     "id": "{string}",     "name": "{string}",     "scanPoolType": "{integer}",     "isDefault": "{boolean}",     "scanInstances": [      {       "id": "{string}",       "scanPoolId": "{string}",       "url": "{string}",       "apiKey": "{string}",       "timeout": "{string}",       "scanInstanceType": "{integer}"      }     ]    },    "failOverScanPoolId": "{string}",    "failOverScanPool": {     "id": "{string}",     "name": "{string}",     "scanPoolType": "{integer}",     "isDefault": "{boolean}",     "scanInstances": [      {       "id": "{string}",       "scanPoolId": "{string}",       "url": "{string}",       "apiKey": "{string}",       "timeout": "{string}",       "scanInstanceType": "{integer}"      }     ]    }   },   "startTimestamp": "{int64}",   "stopTimestamp": "{int64}"  } ]}
Copy

Expand

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
items	array[object]
id	string
title	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`
status	integer	Enum: `0`,`1`,`2`
priority	integer	Enum: `0`,`1`,`2`
isEnabled	boolean
howToFixLink	string
failureReason	string
lastUpdateTime	date-time
score	number
isEnabled	boolean

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "items": [  {   "id": "{string}",   "title": "{integer}",   "status": "{integer}",   "priority": "{integer}",   "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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
score	number
resolvedItemsCount	int32
enabledItemsCount	int32
isEnabled	boolean

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`,`3`,`4`,`5`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
item
object	object
id	string
title	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`
status	integer	Enum: `0`,`1`,`2`
priority	integer	Enum: `0`,`1`,`2`
isEnabled	boolean
howToFixLink	string
failureReason	string
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
scanConfig
object	object
realTimeScanConfig
object	object
isEnabled	boolean
startDate	date-time
handlingType	integer	Enum: `0`,`1`
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string
customValues	array[object]
defaultName	string
customName	string
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockedFileHandlingType	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileHandlingType	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileHandlingType	integer	Enum: `0`,`1`,`2`
configurableBlockingStrategy
object	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockingStrategy	integer	Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "item": {  "id": "{string}",  "title": "{integer}",  "status": "{integer}",  "priority": "{integer}",  "isEnabled": "{boolean}",  "howToFixLink": "{string}",  "failureReason": "{string}" }, "storage": {  "id": "{string}",  "name": "{string}",  "groupId": "{string}",  "clientId": "{string}",  "accountId": "{string}",  "storageCredentials": "{string}",  "source": "{string}",  "storageType": {   "name": "{string}",   "categoryType": "{integer}",   "protocolType": "{integer}",   "vendorType": "{integer}"  },  "scanConfig": {   "realTimeScanConfig": {    "isEnabled": "{boolean}",    "startDate": "{date-time}",    "handlingType": "{integer}"   },   "postActionsScanConfig": {    "fileTaggingConfig": {     "isTaggingPostActionEnabled": "{boolean}",     "fileTags": [      {       "fileTagKey": {        "defaultName": "{string}",        "customName": "{string}"       },       "customValues": [        {         "defaultName": "{string}",         "customName": "{string}"        }       ],       "isEnabled": "{boolean}",       "fileTagType": "{integer}"      }     ]    },    "deepCdrConfig": {     "isDeepCdrPostActionEnabled": "{boolean}",     "deepCdrOriginalFileHandlingType": "{integer}"    },    "moveDeleteRemediationConfig": {     "blockedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "blockedFileHandlingType": "{integer}"     },     "sanitizedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "sanitizedFileHandlingType": "{integer}"     },     "allowedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "allowedFileHandlingType": "{integer}"     },     "configurableBlockingStrategy": {      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}"     },     "blockingStrategy": "{integer}"    }   }  } }}
Copy

Expand

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
scanConfig
object	object
realTimeScanConfig
object	object
isEnabled	boolean
startDate	date-time
handlingType	integer	Enum: `0`,`1`
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string
customValues	array[object]
defaultName	string
customName	string
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockedFileHandlingType	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileHandlingType	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileHandlingType	integer	Enum: `0`,`1`,`2`
configurableBlockingStrategy
object	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockingStrategy	integer	Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storage": {  "id": "{string}",  "name": "{string}",  "groupId": "{string}",  "clientId": "{string}",  "accountId": "{string}",  "storageCredentials": "{string}",  "source": "{string}",  "storageType": {   "name": "{string}",   "categoryType": "{integer}",   "protocolType": "{integer}",   "vendorType": "{integer}"  },  "scanConfig": {   "realTimeScanConfig": {    "isEnabled": "{boolean}",    "startDate": "{date-time}",    "handlingType": "{integer}"   },   "postActionsScanConfig": {    "fileTaggingConfig": {     "isTaggingPostActionEnabled": "{boolean}",     "fileTags": [      {       "fileTagKey": {        "defaultName": "{string}",        "customName": "{string}"       },       "customValues": [        {         "defaultName": "{string}",         "customName": "{string}"        }       ],       "isEnabled": "{boolean}",       "fileTagType": "{integer}"      }     ]    },    "deepCdrConfig": {     "isDeepCdrPostActionEnabled": "{boolean}",     "deepCdrOriginalFileHandlingType": "{integer}"    },    "moveDeleteRemediationConfig": {     "blockedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "blockedFileHandlingType": "{integer}"     },     "sanitizedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "sanitizedFileHandlingType": "{integer}"     },     "allowedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "allowedFileHandlingType": "{integer}"     },     "configurableBlockingStrategy": {      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}"     },     "blockingStrategy": "{integer}"    }   }  } }}
Copy

Expand

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
scanConfig
object	object
realTimeScanConfig
object	object
isEnabled	boolean
startDate	date-time
handlingType	integer	Enum: `0`,`1`
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string
customValues	array[object]
defaultName	string
customName	string
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockedFileHandlingType	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileHandlingType	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileHandlingType	integer	Enum: `0`,`1`,`2`
configurableBlockingStrategy
object	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockingStrategy	integer	Enum: `0`,`1`
isEnabled	boolean

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storage": {  "id": "{string}",  "name": "{string}",  "groupId": "{string}",  "clientId": "{string}",  "accountId": "{string}",  "storageCredentials": "{string}",  "source": "{string}",  "storageType": {   "name": "{string}",   "categoryType": "{integer}",   "protocolType": "{integer}",   "vendorType": "{integer}"  },  "scanConfig": {   "realTimeScanConfig": {    "isEnabled": "{boolean}",    "startDate": "{date-time}",    "handlingType": "{integer}"   },   "postActionsScanConfig": {    "fileTaggingConfig": {     "isTaggingPostActionEnabled": "{boolean}",     "fileTags": [      {       "fileTagKey": {        "defaultName": "{string}",        "customName": "{string}"       },       "customValues": [        {         "defaultName": "{string}",         "customName": "{string}"        }       ],       "isEnabled": "{boolean}",       "fileTagType": "{integer}"      }     ]    },    "deepCdrConfig": {     "isDeepCdrPostActionEnabled": "{boolean}",     "deepCdrOriginalFileHandlingType": "{integer}"    },    "moveDeleteRemediationConfig": {     "blockedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "blockedFileHandlingType": "{integer}"     },     "sanitizedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "sanitizedFileHandlingType": "{integer}"     },     "allowedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "allowedFileHandlingType": "{integer}"     },     "configurableBlockingStrategy": {      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}"     },     "blockingStrategy": "{integer}"    }   }  } }, "isEnabled": "{boolean}"}
Copy

Expand

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
scanConfig
object	object
realTimeScanConfig
object	object
isEnabled	boolean
startDate	date-time
handlingType	integer	Enum: `0`,`1`
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string
customValues	array[object]
defaultName	string
customName	string
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockedFileHandlingType	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileHandlingType	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileHandlingType	integer	Enum: `0`,`1`,`2`
configurableBlockingStrategy
object	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockingStrategy	integer	Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storage": {  "id": "{string}",  "name": "{string}",  "groupId": "{string}",  "clientId": "{string}",  "accountId": "{string}",  "storageCredentials": "{string}",  "source": "{string}",  "storageType": {   "name": "{string}",   "categoryType": "{integer}",   "protocolType": "{integer}",   "vendorType": "{integer}"  },  "scanConfig": {   "realTimeScanConfig": {    "isEnabled": "{boolean}",    "startDate": "{date-time}",    "handlingType": "{integer}"   },   "postActionsScanConfig": {    "fileTaggingConfig": {     "isTaggingPostActionEnabled": "{boolean}",     "fileTags": [      {       "fileTagKey": {        "defaultName": "{string}",        "customName": "{string}"       },       "customValues": [        {         "defaultName": "{string}",         "customName": "{string}"        }       ],       "isEnabled": "{boolean}",       "fileTagType": "{integer}"      }     ]    },    "deepCdrConfig": {     "isDeepCdrPostActionEnabled": "{boolean}",     "deepCdrOriginalFileHandlingType": "{integer}"    },    "moveDeleteRemediationConfig": {     "blockedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "blockedFileHandlingType": "{integer}"     },     "sanitizedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "sanitizedFileHandlingType": "{integer}"     },     "allowedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "allowedFileHandlingType": "{integer}"     },     "configurableBlockingStrategy": {      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}"     },     "blockingStrategy": "{integer}"    }   }  } }}
Copy

Expand

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 notifications configuration

Auth

GET /api/settings/notifications

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
emailNotificationsConfig
object	object
generatedReportNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	Enum: `0`,`1`
userRequestNotificationsConfig
object	object
isEnabled	boolean
blockedFileNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	Enum: `0`,`1`,`2`
webhookNotificationsConfig
object	object
scanCompletedNotificationsConfig
object	object
isEnabled	boolean
destinationAddress	string
headers	object
*	string
requestType	integer	Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "emailNotificationsConfig": {  "generatedReportNotificationsConfig": {   "isEnabled": "{boolean}",   "recipientsType": "{integer}"  },  "userRequestNotificationsConfig": {   "isEnabled": "{boolean}"  },  "blockedFileNotificationsConfig": {   "isEnabled": "{boolean}",   "recipientsType": "{integer}"  } }, "webhookNotificationsConfig": {  "scanCompletedNotificationsConfig": {   "isEnabled": "{boolean}",   "destinationAddress": "{string}",   "headers": {},   "requestType": "{integer}"  } }}
Copy

Update notifications configuration

Auth

Request Body

object	object
emailNotificationsConfig
object	object
generatedReportNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	Enum: `0`,`1`
userRequestNotificationsConfig
object	object
isEnabled	boolean
blockedFileNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	Enum: `0`,`1`,`2`
webhookNotificationsConfig
object	object
scanCompletedNotificationsConfig
object	object
isEnabled	boolean
destinationAddress	string
headers	object
*	string
requestType	integer	Enum: `0`,`1`

Expand

PUT /api/settings/notifications

xxxxxxxxxx
 
curl --request PUT \ --url 'http://<MDSS_HOST>/api/settings/notifications' \ --header 'Authorization: Bearer {token}' \ --data '{  "emailNotificationsConfig": {    "generatedReportNotificationsConfig": {      "isEnabled": "{boolean}",      "recipientsType": "{integer}"    },    "userRequestNotificationsConfig": {      "isEnabled": "{boolean}"    },    "blockedFileNotificationsConfig": {      "isEnabled": "{boolean}",      "recipientsType": "{integer}"    }  },  "webhookNotificationsConfig": {    "scanCompletedNotificationsConfig": {      "isEnabled": "{boolean}",      "destinationAddress": "{string}",      "headers": {},      "requestType": "{integer}"    }  }}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
newNotificationsConfig
object	object
id	string
emailNotificationsConfig
object	object
userRequestNotificationsConfig
object	object
isEnabled	boolean
generatedReportNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	Enum: `0`,`1`
blockedFileNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	Enum: `0`,`1`,`2`
webhookNotificationsConfig
object	object
scanCompletedNotificationsConfig
object	object
isEnabled	boolean
destinationAddress	string
headers	object
*	string
requestType	integer	Enum: `0`,`1`
initialNotificationsConfig
object	object
id	string
emailNotificationsConfig
object	object
userRequestNotificationsConfig
object	object
isEnabled	boolean
generatedReportNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	Enum: `0`,`1`
blockedFileNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	Enum: `0`,`1`,`2`
webhookNotificationsConfig
object	object
scanCompletedNotificationsConfig
object	object
isEnabled	boolean
destinationAddress	string
headers	object
*	string
requestType	integer	Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "newNotificationsConfig": {  "id": "{string}",  "emailNotificationsConfig": {   "userRequestNotificationsConfig": {    "isEnabled": "{boolean}"   },   "generatedReportNotificationsConfig": {    "isEnabled": "{boolean}",    "recipientsType": "{integer}"   },   "blockedFileNotificationsConfig": {    "isEnabled": "{boolean}",    "recipientsType": "{integer}"   }  },  "webhookNotificationsConfig": {   "scanCompletedNotificationsConfig": {    "isEnabled": "{boolean}",    "destinationAddress": "{string}",    "headers": {},    "requestType": "{integer}"   }  } }, "initialNotificationsConfig": {  "id": "{string}",  "emailNotificationsConfig": {   "userRequestNotificationsConfig": {    "isEnabled": "{boolean}"   },   "generatedReportNotificationsConfig": {    "isEnabled": "{boolean}",    "recipientsType": "{integer}"   },   "blockedFileNotificationsConfig": {    "isEnabled": "{boolean}",    "recipientsType": "{integer}"   }  },  "webhookNotificationsConfig": {   "scanCompletedNotificationsConfig": {    "isEnabled": "{boolean}",    "destinationAddress": "{string}",    "headers": {},    "requestType": "{integer}"   }  } }}
Copy

Expand

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

object	object
host	string
port	int32
baseUrl	string
senderAddress	string
senderName	string	maxLength: 320
domain	string
username	string
password	string
secureSocketOption
integer	integer	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": "{integer}", "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
integer	integer	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": "{integer}",  "ignoreCertWarnings": "{boolean}",  "isSmtpEnabled": "{boolean}"}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
newSmtpConfig
object	object
id	string
host	string
baseUrl	string
port	int32
senderAddress	string
senderName	string
domain	string
username	string
password	string
secureSocketOption	integer	Enum: `0`,`1`,`2`,`3`,`4`
ignoreCertWarnings	boolean
isSmtpEnabled	boolean
oldSmtpConfig
object	object
id	string
host	string
baseUrl	string
port	int32
senderAddress	string
senderName	string
domain	string
username	string
password	string
secureSocketOption	integer	Enum: `0`,`1`,`2`,`3`,`4`
ignoreCertWarnings	boolean
isSmtpEnabled	boolean

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "newSmtpConfig": {  "id": "{string}",  "host": "{string}",  "baseUrl": "{string}",  "port": "{int32}",  "senderAddress": "{string}",  "senderName": "{string}",  "domain": "{string}",  "username": "{string}",  "password": "{string}",  "secureSocketOption": "{integer}",  "ignoreCertWarnings": "{boolean}",  "isSmtpEnabled": "{boolean}" }, "oldSmtpConfig": {  "id": "{string}",  "host": "{string}",  "baseUrl": "{string}",  "port": "{int32}",  "senderAddress": "{string}",  "senderName": "{string}",  "domain": "{string}",  "username": "{string}",  "password": "{string}",  "secureSocketOption": "{integer}",  "ignoreCertWarnings": "{boolean}",  "isSmtpEnabled": "{boolean}" }}
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

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
retentionAuditDays	int32
reportRetentionConfiguration
object	object
isEnabled	boolean
retentionDays	int32

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
clientId	string
authority	string
baseUrl	string
isEnabled	boolean
ssoType	integer	Enum: `0`
ssoProvider	integer	Enum: `0`,`1`,`2`,`3`
ssoConfig
object	object
id	string
isEnabled	boolean
ssoProvider	integer	Enum: `0`,`1`,`2`,`3`
ssoType	integer	Enum: `0`
baseUrl	string
clientId	string
clientSecret	string
authority	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "clientId": "{string}", "authority": "{string}", "baseUrl": "{string}", "isEnabled": "{boolean}", "ssoType": "{integer}", "ssoProvider": "{integer}", "ssoConfig": {  "id": "{string}",  "isEnabled": "{boolean}",  "ssoProvider": "{integer}",  "ssoType": "{integer}",  "baseUrl": "{string}",  "clientId": "{string}",  "clientSecret": "{string}",  "authority": "{string}" }}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
clientId	string
authority	string
baseUrl	string
isEnabled	boolean
ssoType	integer	Enum: `0`
ssoProvider	integer	Enum: `0`,`1`,`2`,`3`
ssoConfig
object	object
id	string
isEnabled	boolean
ssoProvider	integer	Enum: `0`,`1`,`2`,`3`
ssoType	integer	Enum: `0`
baseUrl	string
clientId	string
clientSecret	string
authority	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "clientId": "{string}", "authority": "{string}", "baseUrl": "{string}", "isEnabled": "{boolean}", "ssoType": "{integer}", "ssoProvider": "{integer}", "ssoConfig": {  "id": "{string}",  "isEnabled": "{boolean}",  "ssoProvider": "{integer}",  "ssoType": "{integer}",  "baseUrl": "{string}",  "clientId": "{string}",  "clientSecret": "{string}",  "authority": "{string}" }}
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

/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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array[object]
id	string
groupId	string
name	string
storageClientId	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`
realTimeScanConfig
object	object
isEnabled	boolean
handlingType
integer	integer	Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
allowedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
sanitizedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
blockedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy
integer	integer	Enum: `0`,`1`
$type	string

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "id": "{string}",   "groupId": "{string}",   "name": "{string}",   "storageClientId": "{string}",   "storageType": {    "name": "{string}",    "categoryType": "{integer}",    "protocolType": "{integer}",    "vendorType": "{integer}"   },   "realTimeScanConfig": {    "isEnabled": "{boolean}",    "handlingType": "{integer}",    "scanConfigurationId": "{string}"   },   "postActionsScanConfig": {    "fileTaggingConfig": {     "isTaggingPostActionEnabled": "{boolean}",     "fileTags": [      {       "fileTagKey": {        "defaultName": "{string}",        "customName": "{string}"       },       "customValues": [        {         "defaultName": "{string}",         "customName": "{string}"        }       ],       "isEnabled": "{boolean}",       "fileTagType": "{integer}"      }     ]    },    "deepCdrConfig": {     "isDeepCdrPostActionEnabled": "{boolean}",     "deepCdrOriginalFileHandlingType": "{integer}"    },    "moveDeleteRemediationConfig": {     "blockedFileRemediationConfigurationStatus": "{integer}",     "sanitizedFileRemediationConfigurationStatus": "{integer}",     "allowedFileRemediationConfigurationStatus": "{integer}",     "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",     "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",     "blockedFileHandlingType": "{integer}",     "allowedFileHandlingType": "{integer}",     "sanitizedFileHandlingType": "{integer}",     "blockedFileStorageConfig": {      "storageId": "{string}",      "userId": "{string}",      "keepFolderStructure": "{boolean}"     },     "sanitizedFileStorageConfig": {      "storageId": "{string}",      "userId": "{string}",      "keepFolderStructure": "{boolean}"     },     "allowedFileStorageConfig": {      "storageId": "{string}",      "userId": "{string}",      "keepFolderStructure": "{boolean}"     },     "blockingStrategy": "{integer}"    }   },   "$type": "{string}"  } ]}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
storage
object	object
id	string
groupId	string
name	string
storageClientId	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`
realTimeScanConfig
object	object
isEnabled	boolean
handlingType
integer	integer	Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
allowedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
sanitizedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
blockedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy
integer	integer	Enum: `0`,`1`
$type	string

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storage": {  "id": "{string}",  "groupId": "{string}",  "name": "{string}",  "storageClientId": "{string}",  "storageType": {   "name": "{string}",   "categoryType": "{integer}",   "protocolType": "{integer}",   "vendorType": "{integer}"  },  "realTimeScanConfig": {   "isEnabled": "{boolean}",   "handlingType": "{integer}",   "scanConfigurationId": "{string}"  },  "postActionsScanConfig": {   "fileTaggingConfig": {    "isTaggingPostActionEnabled": "{boolean}",    "fileTags": [     {      "fileTagKey": {       "defaultName": "{string}",       "customName": "{string}"      },      "customValues": [       {        "defaultName": "{string}",        "customName": "{string}"       }      ],      "isEnabled": "{boolean}",      "fileTagType": "{integer}"     }    ]   },   "deepCdrConfig": {    "isDeepCdrPostActionEnabled": "{boolean}",    "deepCdrOriginalFileHandlingType": "{integer}"   },   "moveDeleteRemediationConfig": {    "blockedFileRemediationConfigurationStatus": "{integer}",    "sanitizedFileRemediationConfigurationStatus": "{integer}",    "allowedFileRemediationConfigurationStatus": "{integer}",    "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",    "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",    "blockedFileHandlingType": "{integer}",    "allowedFileHandlingType": "{integer}",    "sanitizedFileHandlingType": "{integer}",    "blockedFileStorageConfig": {     "storageId": "{string}",     "userId": "{string}",     "keepFolderStructure": "{boolean}"    },    "sanitizedFileStorageConfig": {     "storageId": "{string}",     "userId": "{string}",     "keepFolderStructure": "{boolean}"    },    "allowedFileStorageConfig": {     "storageId": "{string}",     "userId": "{string}",     "keepFolderStructure": "{boolean}"    },    "blockingStrategy": "{integer}"   }  },  "$type": "{string}" }}
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

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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
StorageVendorType	string
StorageProtocolType	string
CredentialsFile	file
Credentials	string
Source	string
GroupId	string
AccountId	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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
updatedStorage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageType
object	object
name	string
categoryType	integer	Enum: `0`,`1`,`2`
protocolType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
vendorType	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`
scanConfig
object	object
realTimeScanConfig
object	object
isEnabled	boolean
startDate	date-time
handlingType	integer	Enum: `0`,`1`
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string
customValues	array[object]
defaultName	string
customName	string
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockedFileHandlingType	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileHandlingType	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfig
object	object
isEnabled	boolean
moveRemediationStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileHandlingType	integer	Enum: `0`,`1`,`2`
configurableBlockingStrategy
object	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockingStrategy	integer	Enum: `0`,`1`

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": {  "id": "{string}",  "name": "{string}",  "groupId": "{string}",  "clientId": "{string}",  "accountId": "{string}",  "storageCredentials": "{string}",  "source": "{string}",  "storageType": {   "name": "{string}",   "categoryType": "{integer}",   "protocolType": "{integer}",   "vendorType": "{integer}"  },  "scanConfig": {   "realTimeScanConfig": {    "isEnabled": "{boolean}",    "startDate": "{date-time}",    "handlingType": "{integer}"   },   "postActionsScanConfig": {    "fileTaggingConfig": {     "isTaggingPostActionEnabled": "{boolean}",     "fileTags": [      {       "fileTagKey": {        "defaultName": "{string}",        "customName": "{string}"       },       "customValues": [        {         "defaultName": "{string}",         "customName": "{string}"        }       ],       "isEnabled": "{boolean}",       "fileTagType": "{integer}"      }     ]    },    "deepCdrConfig": {     "isDeepCdrPostActionEnabled": "{boolean}",     "deepCdrOriginalFileHandlingType": "{integer}"    },    "moveDeleteRemediationConfig": {     "blockedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "blockedFileHandlingType": "{integer}"     },     "sanitizedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "sanitizedFileHandlingType": "{integer}"     },     "allowedFileRemediationConfig": {      "isEnabled": "{boolean}",      "moveRemediationStorageConfig": {       "storageId": "{string}",       "userId": "{string}",       "keepFolderStructure": "{boolean}"      },      "allowedFileHandlingType": "{integer}"     },     "configurableBlockingStrategy": {      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}"     },     "blockingStrategy": "{integer}"    }   }  } }}
Copy

Expand

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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array[object]
id	string
fullName	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [  {   "id": "{string}",   "fullName": "{string}"  } ]}
Copy

Add a storage

Auth

Request Body

object	object
Name	string
StorageVendorType	string
StorageProtocolType	string
CredentialsFile	file
Credentials	string
Source	string
GroupId	string
AccountId	string

POST /api/storage

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
storageId	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}
Copy

Update scan configuration

Auth

Path Params

storageId string

Request Body

object	object
realTimeScanConfig
object	object
isEnabled	boolean
handlingType
integer	integer	Enum: `0`,`1`
scanConfigurationId	string
postActionsScanConfig
object	object
fileTaggingConfig
object	object
isTaggingPostActionEnabled	boolean
fileTags	array[object]
fileTagKey
object	object
defaultName	string
customName	string	maxLength: 128
customValues	array[object]
defaultName	string
customName	string	maxLength: 256
isEnabled	boolean
fileTagType	integer	Enum: `0`,`1`,`2`
deepCdrConfig
object	object
isDeepCdrPostActionEnabled	boolean
deepCdrOriginalFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
moveDeleteRemediationConfig
object	object
blockedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
sanitizedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
allowedFileRemediationConfigurationStatus	integer	Enum: `0`,`1`,`2`
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
blockedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
allowedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
sanitizedFileHandlingType
integer	integer	Enum: `0`,`1`,`2`
blockedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
sanitizedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
allowedFileStorageConfig
object	object
storageId	string
userId	string
keepFolderStructure	boolean
blockingStrategy
integer	integer	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": "{integer}",    "scanConfigurationId": "{string}"  },  "postActionsScanConfig": {    "fileTaggingConfig": {      "isTaggingPostActionEnabled": "{boolean}",      "fileTags": [        {          "fileTagKey": {            "defaultName": "{string}",            "customName": "{string}"          },          "customValues": [            {              "defaultName": "{string}",              "customName": "{string}"            }          ],          "isEnabled": "{boolean}",          "fileTagType": "{integer}"        }      ]    },    "deepCdrConfig": {      "isDeepCdrPostActionEnabled": "{boolean}",      "deepCdrOriginalFileHandlingType": "{integer}"    },    "moveDeleteRemediationConfig": {      "blockedFileRemediationConfigurationStatus": "{integer}",      "sanitizedFileRemediationConfigurationStatus": "{integer}",      "allowedFileRemediationConfigurationStatus": "{integer}",      "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}",      "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}",      "blockedFileHandlingType": "{integer}",      "allowedFileHandlingType": "{integer}",      "sanitizedFileHandlingType": "{integer}",      "blockedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"      },      "sanitizedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"      },      "allowedFileStorageConfig": {        "storageId": "{string}",        "userId": "{string}",        "keepFolderStructure": "{boolean}"      },      "blockingStrategy": "{integer}"    }  }}'
Copy

Expand

Responses

200

file file

Response

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

Add a scan schedule

Auth

Path Params

storageId string

Request Body

object	object
name	string
scanConfigurationId	string
recurrencePattern
object	object
type	string
hourlyRecurrence
object	object
everyNumberOfHours	int32	maximum: 24 minimum: 1
dailyRecurrence
object	object
everyNumberOfDays	int32	maximum: 365 minimum: 1
weeklyRecurrence
object	object
dayOfWeek	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
monthlyRecurrence
object	object
everyNumberOfMonths	int32	maximum: 12 minimum: 1
dayOfMonth	int32
$type	string

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": "{integer}"    },    "monthlyRecurrence": {      "everyNumberOfMonths": "{int32}",      "dayOfMonth": "{int32}"    }  },  "$type": "{string}"}'
Copy

Responses

200

file file

Response

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

Update a scan schedule

Auth

Path Params

storageId string

Request Body

object	object
name	string
scanConfigurationId	string
recurrencePattern
object	object
type	string
hourlyRecurrence
object	object
everyNumberOfHours	int32	maximum: 24 minimum: 1
dailyRecurrence
object	object
everyNumberOfDays	int32	maximum: 365 minimum: 1
weeklyRecurrence
object	object
dayOfWeek	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
monthlyRecurrence
object	object
everyNumberOfMonths	int32	maximum: 12 minimum: 1
dayOfMonth	int32
$type	string
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": "{integer}"    },    "monthlyRecurrence": {      "everyNumberOfMonths": "{int32}",      "dayOfMonth": "{int32}"    }  },  "$type": "{string}",  "id": "{string}"}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
entries	array[object]
id	string
name	string
scanConfigurationId	string
type	string
createdAt	date-time
lastScanTime	date-time
nextScanTime	date-time
recurrencePatternDto
object	object
hourlyRecurrenceDto
object	object
everyNumberOfHours	int32
dailyRecurrenceDto
object	object
everyNumberOfDays	int32
weeklyRecurrenceDto
object	object
dayOfWeek	integer	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
monthlyRecurrenceDto
object	object
everyNumberOfMonths	int32
dayOfMonth	int32
createdBy	string
totalCount	int64
createdByUsers	array[string]

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "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": "{integer}"    },    "monthlyRecurrenceDto": {     "everyNumberOfMonths": "{int32}",     "dayOfMonth": "{int32}"    }   },   "createdBy": "{string}"  } ], "totalCount": "{int64}", "createdByUsers": [  "{array[string]...}" ]}
Copy

Delete scan schedules

Auth

Request Body

array array[string]

DELETE /api/storage/scan_schedule

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
areAllDeleted	boolean

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "areAllDeleted": "{boolean}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
userName	string

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "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/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

object	object
entries	array[object]
id	string
userName	string
fullName	string
email	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
totalCount	int64

Response

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

Register a user

Auth

Request Body

object	object
fullName	string
userName	string
password	string
email	string

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

file file

Response

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

Create a user

Auth

Request Body

object	object
fullName	string
userName	string
password	string
email	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`

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": "{integer}"}'
Copy

Responses

200

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`,`3`,`4`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
accessToken	string
accessTokenExpiryTime	date-time
refreshToken	string
refreshTokenExpiryTime	date-time
fullName	string
email	string
userName	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
user
object	object
id	string
fullName	string
userName	string
passwordHash	string
passwordSalt	string
email	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
accountSecurity
object	object
incrementalDelay	string
failedLoginDate	date-time

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}", "fullName": "{string}", "email": "{string}", "userName": "{string}", "role": "{integer}", "user": {  "id": "{string}",  "fullName": "{string}",  "userName": "{string}",  "passwordHash": "{string}",  "passwordSalt": "{string}",  "email": "{string}",  "role": "{integer}",  "accountSecurity": {   "incrementalDelay": "{string}",   "failedLoginDate": "{date-time}"  } }}
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

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
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

file file

Response

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

Update user role

Auth

Request Body

object	object
userId	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`

PUT /api/user/role

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
accessToken	string
accessTokenExpiryTime	date-time
refreshToken	string
refreshTokenExpiryTime	date-time
user
object	object
id	string
fullName	string
userName	string
passwordHash	string
passwordSalt	string
email	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
accountSecurity
object	object
incrementalDelay	string
failedLoginDate	date-time

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}", "user": {  "id": "{string}",  "fullName": "{string}",  "userName": "{string}",  "passwordHash": "{string}",  "passwordSalt": "{string}",  "email": "{string}",  "role": "{integer}",  "accountSecurity": {   "incrementalDelay": "{string}",   "failedLoginDate": "{date-time}"  } }}
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

object	object
entries	array[object]
id	string
userName	string
fullName	string
email	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
totalCount	int64

Response

xxxxxxxxxx
 
{ "entries": [  {   "id": "{string}",   "userName": "{string}",   "fullName": "{string}",   "email": "{string}",   "role": "{integer}"  } ], "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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
user
object	object
id	string
fullName	string
userName	string
passwordHash	string
passwordSalt	string
email	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
accountSecurity
object	object
incrementalDelay	string
failedLoginDate	date-time

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "user": {  "id": "{string}",  "fullName": "{string}",  "userName": "{string}",  "passwordHash": "{string}",  "passwordSalt": "{string}",  "email": "{string}",  "role": "{integer}",  "accountSecurity": {   "incrementalDelay": "{string}",   "failedLoginDate": "{date-time}"  } }}
Copy

Update a user

Auth

Request Body

object	object
userId	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
userName	string
fullName	string
currentPassword	string
newPassword	string
email	string

PUT /api/user

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
accessToken	string
accessTokenExpiryTime	date-time
refreshToken	string
refreshTokenExpiryTime	date-time
user
object	object
id	string
fullName	string
userName	string
passwordHash	string
passwordSalt	string
email	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
accountSecurity
object	object
incrementalDelay	string
failedLoginDate	date-time

Expand

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}", "user": {  "id": "{string}",  "fullName": "{string}",  "userName": "{string}",  "passwordHash": "{string}",  "passwordSalt": "{string}",  "email": "{string}",  "role": "{integer}",  "accountSecurity": {   "incrementalDelay": "{string}",   "failedLoginDate": "{date-time}"  } }}
Copy

Request password reset

Auth

Request Body

object	object
userInput	string	minLength: 1

POST /api/user/password/reset

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}
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

object	object
result	integer	Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
user	object
id	string
fullName	string
userName	string
passwordHash	string
passwordSalt	string
email	string
role	integer	Enum: `0`,`1`,`2`,`4`,`5`
accountSecurity
object	object
incrementalDelay	string
failedLoginDate	date-time

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "user": {  "id": "{string}",  "fullName": "{string}",  "userName": "{string}",  "passwordHash": "{string}",  "passwordSalt": "{string}",  "email": "{string}",  "role": "{integer}",  "accountSecurity": {   "incrementalDelay": "{string}",   "failedLoginDate": "{date-time}"  } }}
Copy

Webhook

/api/webhook/realtime

/api/webhook/realtime/{storageClientId}

Object event trigger of real time processing

This endpoint takes the parameters and tries to find the file in the specified storage and applies the scan configuration for the specified file

Auth

Request Body

object	object
metadata	string	minLength: 1
storageClientId	string	minLength: 1

POST /api/webhook/realtime

xxxxxxxxxx
 
curl --request POST \ --url 'http://<MDSS_HOST>/api/webhook/realtime' \ --header 'Authorization: Bearer {token}' \ --data '{  "metadata": "{string}",  "storageClientId": "{string}"}'
Copy

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
correlationId	string

400

404

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "correlationId": "{string}"}
Copy

Object event trigger of real time processing by storage client ID

This endpoint takes the parameter and tries to find the file in the specified storage and applies the scan configuration for the specified file

Auth

Path Params

storageClientId string

Request Body

No request body

POST /api/webhook/realtime/{storageClientId}

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

Responses

200

object	object
result	integer	Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
success
RestResponse	RestResponse
error
RestResponse	RestResponse
correlationId	string

400

404

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "correlationId": "{string}"}
Copy

Deprecated Soon To Be Removed

/api/corepool/{corePoolId}

/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}