MetaDefender Storage Security
Need Help? Contact Support
Overview
MetaDefender Storage Security API Release Notes
Search this version
DocsMetaDefender Storage SecurityMetaDefender Storage Security API
DocsMetaDefender Storage SecurityMetaDefender Storage Security API
MetaDefender Storage Security API
About this REST API
Useful links
Authentication
Account
GETFetch all accounts
POSTAdd an account
PATCHUpdate an account
GETFetch account by ID
DELETEDelete an account
GETFetch available storage units for an account
GETFetch the number of accounts
Audit
GETFetch audit logs
Configuration
GETExport configuration file
POSTImport configuration file
GETGet enabled modules
Connector
GETconnector
Deep Cdr
POSTRevert encrypted file
External Logger
GETRetrieve external loggers
PUTUpdate external logger state
PUTUpdate a Syslog server configuration
POSTAdd a new Syslog server configuration
PUTUpdate a Kafka server configuration
POSTAdd a new Kafka server configuration
DELETEDelete external logger
File
PUTScan a file on demand
GETFetch processing results for a file
GETEnumerate processed files
Group
GETFetch all groups
POSTAdd a group
PATCHUpdate a group
GETFetch group by ID
DELETEDelete a group
GETFetch the number of groups
Health Status
GETGet health status
Onboarding
GETFetch onboarding configuration
POSTFinish onboarding
POSTAccept Eula
Report
GETGet scans report
Scan
GETGet scan by ID
GETGet scan by ID with information regarding the previous and next scan
POSTStart a scan
POSTStop a scan
GETGet next scheduled scan
DELETEDelete scans
Scan Instance
GETGet Scan Instances
PUTUpdate an existing Scan Instance
POSTAdd a new Scan Instance
GETGet Scan Instance by ID
DELETEDelete a Scan Instance
POSTTest
Scan Pool
GETGet Scan Pools
PUTUpdate an existing Scan Pool
POSTAdd a new Scan Pool
GETGet Scan Pool by ID
DELETEDelete a Scan Pool
Scan Workflow Snapshot
GETGet all scan workflow snapshots by scan ID
Security Checklist
GETFetch storage security checklist
GETFetch security checklist details
PUTUpdate security checklist item
PUTVerify the security checklist for storage
PATCHEnable/Disable the security checklist
PUTEnable all security checklist items
Settings
GETGet notifications configuration
PUTUpdate notifications configuration
GETFetch SMTP configuration
PATCHUpdate SMTP configuration
POSTOnline license activation
POSTOffline license activation
GETGet license details
POSTDeactivate license
GETFetch retention configuration
PUTUpdate retention configuration
Sso
GETGet Sso Configuration
PATCHUpdate Sso Configuration
Storage
GETFetch all storage units
GETFetch storage by ID
DELETEDelete a storage
PATCHUpdate a storage
GETFetch storage users
POSTAdd a storage
GETFetch all storage units by filters (storage type or status)
PATCHUpdate scan configuration
PUTAdd a scan schedule
PUTUpdate a scan schedule
GETFetch scan schedules
DELETEDelete scan schedules
GETRetrieve storage user name
User
GETFetch active users
POSTRegister a user
POSTCreate a user
POSTAuthenticate with a username and password
POSTRefresh user token
POSTLogout
PUTUpdate user role
GETFetch users
DELETEDelete a user
PUTUpdate a user
POSTRequest password reset
POSTReset user password
Webhook
POSTObject event trigger of real time processing
POSTObject event trigger of real time processing by storage client ID
Workflow
GETGet Scan Configurations
POSTAdd a new Scan Configuration
PATCHUpdate an existing Scan Configuration
GETGet Scan Configuration by ID
DELETEDelete a Scan Configuration
POSTSet a Scan Configuration as default
Deprecated Soon To Be Removed
GETDeprecated, soon to be removed
PUTDeprecated, soon to be removed
POSTDeprecated, soon to be removed
GETDeprecated, soon to be removed
DELETEDeprecated, soon to be removed
GETDeprecated, soon to be removed
PUTDeprecated, soon to be removed
POSTDeprecated, soon to be removed
GETDeprecated, soon to be removed
DELETEDeprecated, soon to be removed
GET(Deprecated - use /workflow) Get Scan Configurations
POST(Deprecated - use /workflow) Add a new Scan Configuration
PATCH(Deprecated - use /workflow) Update an existing Scan Configuration
GET(Deprecated - use /workflow) Get Scan Configuration by ID
DELETE(Deprecated - use /workflow) Delete a Scan Configuration
POST(Deprecated - use /workflow) Set a Scan Configuration as default
GETDeprecated, soon to be removed
GETDeprecated, soon to be removed
GETDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
POSTDeprecated, soon to be removed
PATCHDeprecated, soon to be removed
DELETEDelete scan schedules

MetaDefender Storage Security API v1

This section of the user guide describes how you can programmatically interact with the MetaDefender Storage Security REST API. Below are some common tasks that can be done using the available REST APIs:

  • Authenticate to obtain a JSON Web Token(JWT)
  • Start or stop a process(scan)
  • Add / remove storage units

About this REST API

The exposed endpoint is located by default at http(s)://md-storage-server/api/ (for example, the authentication endpoint is available at http(s)://md-storage-server/api/user/authenticate). All requests are handled by the NGINX web server before being proxied to the backend API Gateway service.

All endpoints perform authentication and authorization checks. For these checks to succeed, a valid token should be presented in the Authorization header in the form of Bearer.

Please note that all issued tokens have a timestamp and signature associated in order to prevent long-term usage without re - authentication.The lifespan of the token is currently set to 60 minutes, meaning you will have to request a new token before it expires in order to avoid error responses.

Server
http://<MDSS_HOST>
Server Variables

Authentication

http Bearer

As mentioned earlier, all endpoints perform authentication and authorization checks. In order for these checks to succeed, a valid token should be presented in the Authorization header in the form of Bearer .

Suggested application logic

If you plan to integrate MetaDefender Storage Security in your custom application or workflow, please consider the following scenarios for successfully making REST API requests:

Scenario Possible use cases
Short-lived integration You are building or enhancing an application that requires sporadic or on-demand access to MetaDefender Storage Security REST APIs.
The application is not expected to make more than a few REST API calls per hour.
The application does not need to preserve a session.
Long-lived integration You are building or enhancing an application that requires continuous, uninterrupted, or hard to predict access to MetaDefender for Secure Storage REST APIs.
Requests are being triggered based on external factors and your application should maintain connectivity with MetaDefender Storage Security REST API.
Session preserving is necessary and authentication should happen without user-interaction.
Your application will make a significant number of REST API requests and you need increased performance
API Key integration You are building or enhancing an application that requires continuous, uninterrupted, or hard to predict access to MetaDefender for Secure Storage REST APIs.
Requests are being triggered based on external factors and your application should maintain connectivity with MetaDefender Storage Security REST API.
Authentication should happen without user-interaction.
Your application will make a significant number of REST API requests and you need increased performance.

Short-lived integration

  • Obtain a signed accessToken by calling /api/user/authenticate API

  • Use this token to call your desired REST API by providing it in the Authorization header

  • Expire the token by calling /api/user/logout

  • Repeat steps 1-3 the next time your application needs to call a REST API

Long-lived integration

  • Obtain a signed token by calling /api/user/authenticate API

  • Securely save the received accessToken and the refreshToken

  • Use the accessToken to call your desired REST API by providing it in the Authorization header

  • Add an exception handler in case you receive a 401 Unauthorized response because the JWT has expired call /api/user/refreshToken to obtain a new accessToken by providing the saved refreshToken.

    a) the accessToken expires after an hour of creation; the expiry time is represented in UTC format by the accessTokenExpiryTime value.
    b) the refreshToken expires after an hour of creation; the expiry time is represented in UTC format by the refreshTokenExpiryTime value. c) if the refreshToken has expired as well, obtain a signed token by calling /api/user/authenticate API

  • Use the newly issued accessToken to call your desired REST API by providing it in the Authorization header

API Key integration

  • In the MetaDefender Storage Security interface, Navigate to Settings -> Users

  • Find your user entry in the user list, click on the three dots on the right side of the entry, and then click on Generate an API Key

  • Generate the key, copy it, and store it somewhere safe

  • Use the API Key to call your desired REST API by providing it as a header with the Key: "ApiKey" and Value:

General considerations

The access token expiration date cannot be extended. By default, the access token is valid for an hour after calling /api/user/authenticate API to obtain it. The refresh token is also valid for an hour but can be extended by calling /api/user/refreshToken and it is also automatically extended with an hour with each non-GET request.

A refresh token is used to request a new access token when the current one expires without requiring re-authentication using a username and password.

The refresh token is used to forcibly expire any previously issued JWT when the refresh token expires or is removed by calling /api/user/logout.

A 3rd party application that needs persistent connectivity with MetaDefender for Secure Storage should implement a timeout mechanism to ensure that the refresh token is renewed before it expires by calling /api/user/refreshToken whenever the JWT (access token) is expired but before the refresh token expires as well.

Fetch all accounts

Auth
GET /api/account
curl --get \
--url 'http://<MDSS_HOST>/api/account' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
accounts4 fieldsarray[object]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"accounts": [
{
"id": "{string}",
"name": "{string}",
"description": "{string}",
"storages": [
{
"id": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"name": "{string}",
"storageClientId": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{int32}"
},
"realTimeScanConfig": {
"isEnabled": "{boolean}",
"handlingType": "{integer}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"priority": "{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}"
}
},
"scansInProgress": "{boolean}",
"isRtpInProgress": "{boolean}",
"isScheduledScanInProgress": "{boolean}",
"storageFunctionality": "{string}",
"$type": "{string}"
}
]
}
]
}
Copy

Add an account

Auth
Query String
Namestring
Descriptionstring
Credentialsstring
ProtocolType
AutoDiscoveryboolean
GroupIdstring
StorageIdsarray
Request Body
objectobject
CredentialsFilefile
POST /api/account
curl --request POST \
--url 'http://<MDSS_HOST>/api/account' \
--header 'Authorization: Bearer {token}' \
--data Name={Name} \
--data Description={Description} \
--data Credentials={Credentials} \
--data ProtocolType={ProtocolType} \
--data AutoDiscovery={AutoDiscovery} \
--data GroupId={GroupId} \
--data StorageIds={StorageIds} \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
account5 fieldsobject
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"account": {
"id": "{string}",
"name": "{string}",
"description": "{string}",
"credentials": "{string}",
"storageIds": [
"{array[string]...}"
]
}
}
Copy

Update an account

Auth
Query String
AccountIdstring
Namestring
Descriptionstring
Credentialsstring
ProtocolType
AutoDiscoveryboolean
GroupIdstring
Request Body
objectobject
CredentialsFilefile
PATCH /api/account
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/account' \
--header 'Authorization: Bearer {token}' \
--data AccountId={AccountId} \
--data Name={Name} \
--data Description={Description} \
--data Credentials={Credentials} \
--data ProtocolType={ProtocolType} \
--data AutoDiscovery={AutoDiscovery} \
--data GroupId={GroupId} \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedAccount
objectobject
namestring
descriptionstring
credentialsstring
protocolType
integerinteger
  • 0: Smb
  • 1: GraphSdk
  • 2: BoxSdk
  • 3: AwsSdk
  • 4: AzureBlobSdk
  • 5: AlibabaCloudSdk
  • 6: GoogleCloudSdk
  • 7: AzureFilesSdk
  • 8: Sftp
  • 9: Nfs
  • 10: Mft
  • 11: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11

autoDiscoveryboolean
groupIdstring
contentOfCredentialsFilestring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"updatedAccount": {
"name": "{string}",
"description": "{string}",
"credentials": "{string}",
"protocolType": "{integer}",
"autoDiscovery": "{boolean}",
"groupId": "{string}",
"contentOfCredentialsFile": "{string}"
}
}
Copy

Fetch account by ID

Auth
Path Params
accountIdstring
GET /api/account/{accountId}
curl --get \
--url 'http://<MDSS_HOST>/api/account/{accountId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
account
objectobject
idstring
namestring
descriptionstring
storages14 fieldsarray[object]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"account": {
"id": "{string}",
"name": "{string}",
"description": "{string}",
"storages": [
{
"id": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"name": "{string}",
"storageClientId": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{int32}"
},
"realTimeScanConfig": {
"isEnabled": "{boolean}",
"handlingType": "{integer}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"priority": "{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}"
}
},
"scansInProgress": "{boolean}",
"isRtpInProgress": "{boolean}",
"isScheduledScanInProgress": "{boolean}",
"storageFunctionality": "{string}",
"$type": "{string}"
}
]
}
}
Copy

Delete an account

Auth
Path Params
accountIdstring
DELETE /api/account/{accountId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/account/{accountId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
accountIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"accountId": "{string}"
}
Copy

Fetch available storage units for an account

Auth
Path Params
accountIdstring
GET /api/account/{accountId}/storages
curl --get \
--url 'http://<MDSS_HOST>/api/account/{accountId}/storages' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entriesarray[object]
bucketNamestring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"entries": [
{
"bucketName": "{string}"
}
]
}
Copy

Fetch the number of accounts

Auth
GET /api/account/count
curl --get \
--url 'http://<MDSS_HOST>/api/account/count' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
accountCount
objectobject
countint64
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"accountCount": {
"count": "{int64}"
}
}
Copy

Audit

List audit information

Fetch audit logs

Auth
Path Params
startIndexstring
countstring
Query String
logTypestring
categoryTypestring
logLevelstring
searchTextstring
GET /api/audit/{startIndex}/{count}
curl --get \
--url 'http://<MDSS_HOST>/api/audit/{startIndex}/{count}' \
--header 'Authorization: Bearer {token}' \
--data logType={logType} \
--data categoryType={categoryType} \
--data logLevel={logLevel} \
--data searchText={searchText}
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries8 fieldsarray[object]
filterCountint64
totalCountint64
Response
{
"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

Export configuration file

Auth
Query String
exportLicenseboolean
exportSmtpboolean
exportEmailNotificationsboolean
exportRetentionboolean
GET /api/configuration/export
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
filefile
Response
{
"schema": "{file}"
}
Copy

Import configuration file

Auth
Request Body
objectobject
ConfigurationFilefile
POST /api/configuration/import
curl --request POST \
--url 'http://<MDSS_HOST>/api/configuration/import' \
--header 'Authorization: Bearer {token}' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedToUpgradeConfigFile
  • 2: FailedRequestBodyIsEmpty
  • 3: FailedToActivateLicense
  • 4: FailedToDeserializeConfigFile
  • 5: FailedOutdatedVersion
  • 6: FailedInvalidConfigFile

Enum: 0,1,2,3,0,1,2,3,4,5,6

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
areSmtpSettingsImportedboolean
isLicenseImportedboolean
isRetentionImportedboolean
activationDto
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"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
curl --get \
--url 'http://<MDSS_HOST>/api/configuration/enabledModules'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
enabledModulesarray[integer]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"enabledModules": [
"{array[integer]...}"
]
}
Copy

Connector

connector

Auth
Query String
sharePathstring
clientIdstring
GET /api/connector
curl --get \
--url 'http://<MDSS_HOST>/api/connector' \
--header 'Authorization: Bearer {token}' \
--data sharePath={sharePath} \
--data clientId={clientId}
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Deep Cdr

Manage sanitized files

Revert encrypted file

Auth
Path Params
fileIdstring
POST /api/deepcdr/revert/{fileId}
curl --request POST \
--url 'http://<MDSS_HOST>/api/deepcdr/revert/{fileId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Retrieve external loggers

Auth
GET /api/externallogger
curl --get \
--url 'http://<MDSS_HOST>/api/externallogger' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries4 fieldsarray[object]
Response
{
"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
objectobject
idstring

minLength: 1

isEnabledboolean
PUT /api/externallogger/status
curl --request PUT \
--url 'http://<MDSS_HOST>/api/externallogger/status' \
--header 'Authorization: Bearer {token}' \
--data '{
"id": "{string}",
"isEnabled": "{boolean}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Update a Syslog server configuration

Auth
Request Body
objectobject
isEnabledboolean
serverAddressstring

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])$

portint32

pattern: ^()(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})$

loggerTypeinteger
  • 0: SyslogUdp
  • 1: Kafka

Enum: 0,1

facilityinteger
  • 0: KernelMessages
  • 1: UserLevelMessages
  • 2: MailSystem
  • 3: SystemDaemons
  • 4: SecurityOrAuthorizationMessages1
  • 5: InternalMessages
  • 6: LinePrinterSubsystem
  • 7: NetworkNewsSubsystem
  • 8: UUCPSubsystem
  • 9: ClockDaemon1
  • 10: SecurityOrAuthorizationMessages2
  • 11: FTPDaemon
  • 12: NTPSubsystem
  • 13: LogAudit
  • 14: LogAlert
  • 15: ClockDaemon2
  • 16: LocalUse0
  • 17: LocalUse1
  • 18: LocalUse2
  • 19: LocalUse3
  • 20: LocalUse4
  • 21: LocalUse5
  • 22: LocalUse6
  • 23: LocalUse7

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23

formatinteger
  • 0: RFC5424

Enum: 0

$typestring
idstring

minLength: 1

PUT /api/externallogger/udpSyslog
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
filefile
Response
{
"schema": "{file}"
}
Copy

Add a new Syslog server configuration

Auth
Request Body
objectobject
isEnabledboolean
serverAddressstring

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])$

portint32

pattern: ^()(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})$

loggerTypeinteger
  • 0: SyslogUdp
  • 1: Kafka

Enum: 0,1

facilityinteger
  • 0: KernelMessages
  • 1: UserLevelMessages
  • 2: MailSystem
  • 3: SystemDaemons
  • 4: SecurityOrAuthorizationMessages1
  • 5: InternalMessages
  • 6: LinePrinterSubsystem
  • 7: NetworkNewsSubsystem
  • 8: UUCPSubsystem
  • 9: ClockDaemon1
  • 10: SecurityOrAuthorizationMessages2
  • 11: FTPDaemon
  • 12: NTPSubsystem
  • 13: LogAudit
  • 14: LogAlert
  • 15: ClockDaemon2
  • 16: LocalUse0
  • 17: LocalUse1
  • 18: LocalUse2
  • 19: LocalUse3
  • 20: LocalUse4
  • 21: LocalUse5
  • 22: LocalUse6
  • 23: LocalUse7

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23

formatinteger
  • 0: RFC5424

Enum: 0

$typestring
POST /api/externallogger/udpSyslog
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
filefile
Response
{
"schema": "{file}"
}
Copy

Update a Kafka server configuration

Auth
Request Body
objectobject
isEnabledboolean
serverAddressWithPortListstring

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])):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})|(?:(?: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]?):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})|(([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]):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})))(?:,(?:(([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])):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})|(?:(?: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]?):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})|(([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]):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})))*?$

loggerTypeinteger
  • 0: SyslogUdp
  • 1: Kafka

Enum: 0,1

topicstring

minLength: 1

configurationstring

minLength: 1

$typestring
idstring

minLength: 1

PUT /api/externallogger/kafka
curl --request PUT \
--url 'http://<MDSS_HOST>/api/externallogger/kafka' \
--header 'Authorization: Bearer {token}' \
--data '{
"isEnabled": "{boolean}",
"serverAddressWithPortList": "{string}",
"loggerType": "{integer}",
"topic": "{string}",
"configuration": "{string}",
"$type": "{string}",
"id": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Add a new Kafka server configuration

Auth
Request Body
objectobject
isEnabledboolean
serverAddressWithPortListstring

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])):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})|(?:(?: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]?):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})|(([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]):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})))(?:,(?:(([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])):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})|(?:(?: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]?):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})|(([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]):(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})))*?$

loggerTypeinteger
  • 0: SyslogUdp
  • 1: Kafka

Enum: 0,1

topicstring

minLength: 1

configurationstring

minLength: 1

$typestring
POST /api/externallogger/kafka
curl --request POST \
--url 'http://<MDSS_HOST>/api/externallogger/kafka' \
--header 'Authorization: Bearer {token}' \
--data '{
"isEnabled": "{boolean}",
"serverAddressWithPortList": "{string}",
"loggerType": "{integer}",
"topic": "{string}",
"configuration": "{string}",
"$type": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Delete external logger

Auth
Path Params
idstring
DELETE /api/externallogger/{id}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/externallogger/{id}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

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
objectobject
fileIdstring

minLength: 1

scanIdstring

minLength: 1

storageProtocolTypeint32
passwordsarray[string]
PUT /api/file
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
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"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
fileIdstring
GET /api/file/{fileId}
curl --get \
--url 'http://<MDSS_HOST>/api/file/{fileId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedFileNotFound
  • 2: FailedScanForFileNotFound
  • 3: FailedStorageForFileNotFound
  • 4: FailedObjectIdentityNotFound

Enum: 0,1,2,3,0,1,2,3,4

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
idstring
scanIdstring
namestring
pathstring
hashstring
fileOwner
objectobject
userIdstring
fullNamestring
userNamestring
emailAddressstring
sizeint64
storageType
objectobject
namestring
categoryTypeinteger
  • 0: Local
  • 1: Cloud
  • 2: Object

Enum: 0,1,2

protocolTypeinteger
  • 0: Smb
  • 1: GraphSdk
  • 2: BoxSdk
  • 3: AwsSdk
  • 4: AzureBlobSdk
  • 5: AlibabaCloudSdk
  • 6: GoogleCloudSdk
  • 7: AzureFilesSdk
  • 8: Sftp
  • 9: Nfs
  • 10: Mft
  • 11: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11

vendorTypeinteger
  • 0: AmazonS3
  • 1: OneDrive
  • 2: Box
  • 3: DellIsilon
  • 4: AzureFiles
  • 5: SmbCompatible
  • 6: S3Compatible
  • 7: AzureBlob
  • 8: AlibabaCloud
  • 9: GoogleCloud
  • 10: Sftp
  • 11: SharePoint
  • 12: Nfs
  • 13: Wasabi
  • 14: OracleCloud
  • 15: NetAppOntap
  • 16: Cubbit
  • 17: Mft
  • 18: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

storageNamestring
storageLocationstring
scanNamestring
progress
objectobject
uploadint32
scanint32
scanResult
objectobject
extractedFiles
objectobject
dataIdstring
scanResultIint32
detectedByint32
filesInArchive11 fieldsarray[object]
filesExtractedCountint32
scanResults
objectobject
scanDetails7 fieldsarray[object]
dataIdstring
scanAllResultIint32
scanAllResultAstring
startTimestring
totalTimenumber
totalAvsint32
progressPercentageint32
fileInfo10 fieldsobject
processInfo
objectobject
postProcessing
objectobject
actionsRanstring
actionsFailedstring
convertedTostring
copyMoveDestinationstring
convertedDestinationstring
sanitizationDetails
objectobject
failureCategorystring
detailsstring
progressPercentageint32
userAgentstring
profilestring
resultstring
blockedReasonstring
fileTypeSkippedScanboolean
processingTimenumber
queueTimenumber
resultIinteger
  • 0: Allowed
  • 1: Blocked
  • 2: Processing

Enum: 0,1,2

dataIdstring
dlpInfo
objectobject
verdictint64
sbomInfo
objectobject
finalVerdict
objectobject
blockedboolean
licensingPackageCounts
objectobject
allowedint32
blockedint32
unknownint32
unsupportedint32
severityinteger
  • 0: None
  • 1: Critical
  • 2: High
  • 3: Medium
  • 4: Low
  • 5: Unknown

Enum: 0,1,2,3,4,5

totalPackageCountint32
verdictstring
vulnerabilityCounts
objectobject
criticalint32
highint32
mediumint32
lowint32
unknownint32
overviewReport
objectobject
isPartialReportboolean
osInfoobject
osNamestring
osVersionstring
scanModestring
steps9 fieldsarray[object]
packages8 fieldsarray[object]
resultTemplateHashstring
vulnerabilityInfo
objectobject
vulnerabilityInfoResult
objectobject
codeint64
hashstring
methodint64
timeStampstring
timingint64
detectedProduct
objectobject
hasVulnerabilityboolean
isCurrentboolean
product
objectobject
idint64
namestring
remediationLinkstring
severitystring
sigNamestring
signatureint64
vendor
objectobject
idint64
namestring
versionstring
versionData
objectobject
countBehindint64
feedIdint64
versionstring
vulnerabilities5 fieldsarray[object]
sessionCookiestring
processingStateinteger
  • 0: InProgress
  • 1: Failed
  • 2: Canceled
  • 3: Available

Enum: 0,1,2,3

exception
objectobject
exceptionDetailsstring
exceptionMessagestring
createddate-time
lastModifieddate-time
discoveryStarteddate-time
fileProcessingDetails
objectobject
streamingStartedTimedate-time
streamingCompletedTimedate-time
streamingTimeSpanMsint64
scanCompletedTimedate-time
processingTimeSpanMsint64
coreEngines5 fieldsarray[object]
remediation
objectobject
isTaggedboolean
isDeletedboolean
isMovedboolean
isCopiedboolean
deepCdr
objectobject
isSanitizedboolean
isEncryptedboolean
isOriginalVersionOfSanitizedFileboolean
hasSanitizedFileBeenMovedboolean
hasSanitizedFileBeenCopiedboolean
decryptStatusinteger
  • 0: NotStarted
  • 1: InProgress
  • 2: Completed

Enum: 0,1,2

deepCdrOriginalObjectHandlingTypeinteger
  • 0: Keep
  • 1: Encrypt
  • 2: Delete

Enum: 0,1,2

sanitizationDetails
objectobject
failureCategorystring
detailsstring
postActionFailedInformationarray[object]
objectActionTypeinteger
  • 0: Tagging
  • 1: DeepCdrSanitization
  • 2: DeepCdrDelete
  • 3: DeepCdrEncrypt
  • 4: DeepCdrKeep
  • 5: AllowedMoved
  • 6: BlockedMoved
  • 7: BlockedDelete
  • 8: SanitizedMoved
  • 9: AllowedCopied
  • 10: BlockedCopied
  • 11: SanitizedCopied
  • 100: SoftDelete

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,100

exception
objectobject
exceptionDetailsstring
exceptionMessagestring
metaDefenderCoreUrlstring
discoveryStartedDaySecint64
Response
{…}
Copy

Enumerate processed files

Auth
Path Params
scanIdstring
startIndexstring
countstring
Query String
sorting_orderstring
searchstring
resultinteger

Enum: 0,1,2,3,4

startDatestring
endDatestring
scanWorkflowSnapshotIdstring
GET /api/file/{scanId}/{startIndex}/{count}
curl --get \
--url 'http://<MDSS_HOST>/api/file/{scanId}/{startIndex}/{count}' \
--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
objectobject
resultinteger
  • 0: Success
  • 1: StorageNotFound
  • 2: ScanNotFound

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entriesarray
filterCountint64
totalCountint64
Response
{
"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
curl --get \
--url 'http://<MDSS_HOST>/api/group' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
groups4 fieldsarray[object]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"groups": [
{
"id": "{string}",
"name": "{string}",
"description": "{string}",
"storages": [
{
"id": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"name": "{string}",
"storageClientId": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{int32}"
},
"realTimeScanConfig": {
"isEnabled": "{boolean}",
"handlingType": "{integer}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"priority": "{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}"
}
},
"scansInProgress": "{boolean}",
"isRtpInProgress": "{boolean}",
"isScheduledScanInProgress": "{boolean}",
"storageFunctionality": "{string}",
"$type": "{string}"
}
]
}
]
}
Copy

Add a group

Auth
Request Body
objectobject
namestring

minLength: 1

descriptionstring
storageIdsarray[string]
POST /api/group
curl --request POST \
--url 'http://<MDSS_HOST>/api/group' \
--header 'Authorization: Bearer {token}' \
--data '{
"name": "{string}",
"description": "{string}",
"storageIds": [
"{array[string]...}"
]
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
group
objectobject
idstring
namestring
descriptionstring
storageIdsarray[string]
Response
{
"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
objectobject
namestring
descriptionstring
groupIdstring

minLength: 1

PATCH /api/group
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/group' \
--header 'Authorization: Bearer {token}' \
--data '{
"name": "{string}",
"description": "{string}",
"groupId": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedGroup
objectobject
namestring
descriptionstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"updatedGroup": {
"name": "{string}",
"description": "{string}"
}
}
Copy

Fetch group by ID

Auth
Path Params
groupIdstring
GET /api/group/{groupId}
curl --get \
--url 'http://<MDSS_HOST>/api/group/{groupId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
group
objectobject
idstring
namestring
descriptionstring
storages14 fieldsarray[object]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"group": {
"id": "{string}",
"name": "{string}",
"description": "{string}",
"storages": [
{
"id": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"name": "{string}",
"storageClientId": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{int32}"
},
"realTimeScanConfig": {
"isEnabled": "{boolean}",
"handlingType": "{integer}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"priority": "{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}"
}
},
"scansInProgress": "{boolean}",
"isRtpInProgress": "{boolean}",
"isScheduledScanInProgress": "{boolean}",
"storageFunctionality": "{string}",
"$type": "{string}"
}
]
}
}
Copy

Delete a group

Auth
Path Params
groupIdstring
DELETE /api/group/{groupId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/group/{groupId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
groupIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"groupId": "{string}"
}
Copy

Fetch the number of groups

Auth
GET /api/group/count
curl --get \
--url 'http://<MDSS_HOST>/api/group/count' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
groupCount
objectobject
countint64
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"groupCount": {
"count": "{int64}"
}
}
Copy

Health Status

API that responds with 200 OK if application is running.

Get health status

Auth
Query String
verboseboolean

Default: false

GET /api/health
curl --get \
--url 'http://<MDSS_HOST>/api/health' \
--data verbose={verbose}
Copy
Responses
200
objectobject
apiStatusstring
Response
{
"apiStatus": "{string}"
}
Copy

Fetch onboarding configuration

Auth
Query String
newConfigSetupboolean
GET /api/onboarding
curl --get \
--url 'http://<MDSS_HOST>/api/onboarding' \
--data newConfigSetup={newConfigSetup}
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
hasUserConfiguredboolean
hasStorageConfiguredboolean
hasScanInstanceConfiguredboolean
isOnboardingDoneboolean
isEulaAgreedboolean
isCloudTypeboolean
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"hasUserConfigured": "{boolean}",
"hasStorageConfigured": "{boolean}",
"hasScanInstanceConfigured": "{boolean}",
"isOnboardingDone": "{boolean}",
"isEulaAgreed": "{boolean}",
"isCloudType": "{boolean}"
}
Copy

Finish onboarding

Auth
POST /api/onboarding
curl --request POST \
--url 'http://<MDSS_HOST>/api/onboarding' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Accept Eula

Auth
POST /api/onboarding/eula
curl --request POST \
--url 'http://<MDSS_HOST>/api/onboarding/eula' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Report

Generate reports

Get scans report

Auth
Query String
storageIdstring
namestring
scanTypesFilterarray

Enum: 0,1,2

scanStatesFilterarray

Enum: 0,1,2,3,4

startDatestring
endDatestring
sortDirectionFilter
startIndexinteger
countinteger
GET /api/report
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
objectobject
resultinteger
  • 0: Success
  • 1: StorageNotFound

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entriesarray
totalCountint64
Response
{
"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}"
},
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"errors": [
"{array[string]...}"
]
}
],
"totalCount": "{int64}"
}
Copy

Get scan by ID

Auth
Path Params
scanIdstring
GET /api/scan/{scanId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/{scanId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: NotFound

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
scan
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
idstring
namestring
startTimedate-time
stopTimedate-time
scanTypestring
scanningStateinteger
  • 0: NotStarted
  • 1: Running
  • 2: Cancelled
  • 3: Failed
  • 4: Completed

Enum: 0,1,2,3,4

scanStatusDto
objectobject
pendingFilesCountint64
allowedFilesCountint64
blockedFilesCountint64
totalFilesCountint64
processingFailedCountint64
processedFilesCountint64
scanStatsDto
objectobject
pciDssComplianceViolationsCountint64
hipaaComplianceViolationsCountint64
gdprComplianceViolationsCountint64
malwareSecurityAlertsCountint64
vulnerabilitiesSecurityAlertsCountint64
piiSecurityAlertsCountint64
pciDssComplianceViolationsPercentageIncreaseint64
hipaaComplianceViolationsPercentageIncreaseint64
gdprComplianceViolationsPercentageIncreaseint64
malwareSecurityAlertsPercentageIncreaseint64
vulnerabilitiesSecurityAlertsPercentageIncreaseint64
piiSecurityAlertsPercentageIncreaseint64
highRiskAccounts3 fieldsarray[object]
scanSequenceDto
objectobject
previousScanIdstring
nextScanIdstring
workflowIdstring

minLength: 1

scanConfigurationIdstring
errorsarray[string]
Response
{
"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}"
},
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"errors": [
"{array[string]...}"
]
}
}
Copy

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

Auth
Path Params
scanIdstring
Query String
scanTypesFilterarray

Enum: 0,1,2

scanStatesFilterarray

Enum: 0,1,2,3,4

GET /api/scan/sequence/{scanId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/sequence/{scanId}' \
--header 'Authorization: Bearer {token}' \
--data scanTypesFilter={scanTypesFilter} \
--data scanStatesFilter={scanStatesFilter}
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: NotFound

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
scan
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
idstring
namestring
startTimedate-time
stopTimedate-time
scanTypestring
scanningStateinteger
  • 0: NotStarted
  • 1: Running
  • 2: Cancelled
  • 3: Failed
  • 4: Completed

Enum: 0,1,2,3,4

scanStatusDto
objectobject
pendingFilesCountint64
allowedFilesCountint64
blockedFilesCountint64
totalFilesCountint64
processingFailedCountint64
processedFilesCountint64
scanStatsDto
objectobject
pciDssComplianceViolationsCountint64
hipaaComplianceViolationsCountint64
gdprComplianceViolationsCountint64
malwareSecurityAlertsCountint64
vulnerabilitiesSecurityAlertsCountint64
piiSecurityAlertsCountint64
pciDssComplianceViolationsPercentageIncreaseint64
hipaaComplianceViolationsPercentageIncreaseint64
gdprComplianceViolationsPercentageIncreaseint64
malwareSecurityAlertsPercentageIncreaseint64
vulnerabilitiesSecurityAlertsPercentageIncreaseint64
piiSecurityAlertsPercentageIncreaseint64
highRiskAccounts3 fieldsarray[object]
scanSequenceDto
objectobject
previousScanIdstring
nextScanIdstring
workflowIdstring

minLength: 1

scanConfigurationIdstring
errorsarray[string]
Response
{
"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}"
},
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"errors": [
"{array[string]...}"
]
}
}
Copy

Start a scan

To scan a specific folder using the optional Folder parameter, provide the absolute folder path: For Amazon S3 / S3 Compatible Types, Azure Blob, Azure Files, and Google Cloud: Including the Folder Location integrated in MDSS and excluding the Bucket Name, Container, etc. For Box: With or without the "All Files" folder For Sharepoint and Onedrive: Excluding the Document Library, Site, or Group For SMB amd SFTP: Including the whole Sharepath (address, root folder) For NFS: Including the Mount directory

Auth
Request Body
objectobject
storageIdstring

Deprecated

namestring

minLength: 1

folderstring
storageIdsarray[string]
workflowIdstring

minLength: 1

scanConfigurationIdstring
POST /api/scan/start
curl --request POST \
--url 'http://<MDSS_HOST>/api/scan/start' \
--header 'Authorization: Bearer {token}' \
--data '{
"storageId": "{string}",
"name": "{string}",
"folder": "{string}",
"storageIds": [
"{array[string]...}"
],
"workflowId": "{string}",
"scanConfigurationId": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
scanIdstring
scanIdsarray[string]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"scanId": "{string}",
"scanIds": [
"{array[string]...}"
]
}
Copy

Stop a scan

Auth
Path Params
scanIdstring
POST /api/scan/stop/{scanId}
curl --request POST \
--url 'http://<MDSS_HOST>/api/scan/stop/{scanId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Get next scheduled scan

Auth
Path Params
storageIdstring
GET /api/scan/scheduled/{storageId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/scheduled/{storageId}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: StorageNotFound

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
nextScheduledScan
objectobject
idstring
namestring
workflowIdstring

minLength: 1

scanConfigurationIdstring
typestring
createdAtdate-time
lastScanTimedate-time
nextScanTimedate-time
recurrencePatternDto
objectobject
hourlyRecurrenceDto
objectobject
everyNumberOfHoursint32
dailyRecurrenceDto
objectobject
everyNumberOfDaysint32
weeklyRecurrenceDto
objectobject
daysOfWeekarray[integer]

Enum: 0,1,2,3,4,5,6

everyNumberOfWeeksint32
monthlyRecurrenceDto
objectobject
everyNumberOfMonthsint32
dayOfMonthint32
createdBystring
scheduledScansCountint32
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"nextScheduledScan": {
"id": "{string}",
"name": "{string}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"type": "{string}",
"createdAt": "{date-time}",
"lastScanTime": "{date-time}",
"nextScanTime": "{date-time}",
"recurrencePatternDto": {
"hourlyRecurrenceDto": {
"everyNumberOfHours": "{int32}"
},
"dailyRecurrenceDto": {
"everyNumberOfDays": "{int32}"
},
"weeklyRecurrenceDto": {
"daysOfWeek": [
"{array[integer]...}"
],
"everyNumberOfWeeks": "{int32}"
},
"monthlyRecurrenceDto": {
"everyNumberOfMonths": "{int32}",
"dayOfMonth": "{int32}"
}
},
"createdBy": "{string}"
},
"scheduledScansCount": "{int32}"
}
Copy

Delete scans

Auth
Path Params
storageIdstring
Request Body
arrayarray[string]
DELETE /api/scan/{storageId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/scan/{storageId}' \
--data '[
"{array[string]...}"
]'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Failed
  • 2: FailedToFilterInstantScheduledAndRtpScans
  • 3: FailedToDeleteFiles
  • 4: FailedInvalidListOfIds

Enum: 0,1,2,3,0,1,2,3,4

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
deletedScans16 fieldsarray[object]
Response
{
"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}",
"workflowId": "{string}",
"executionId": "{string}",
"errors": [
"{array[string]...}"
],
"priority": "{integer}",
"additionalPropertiesString": "{string}"
}
]
}
Copy

Get Scan Instances

Auth
Query String
scanPoolIdstring
GET /api/scaninstance
curl --get \
--url 'http://<MDSS_HOST>/api/scaninstance' \
--data scanPoolId={scanPoolId}
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries6 fieldsarray[object]
Response
{
"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
objectobject
idstring

minLength: 1

urlstring

pattern: ^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})?)?$)|(^((https?):\/\/)?\[(?:0*\:)*?:?0*1\](:(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})?)?$)).)*$

apiKeystring
timeoutstring
PUT /api/scaninstance
curl --request PUT \
--url 'http://<MDSS_HOST>/api/scaninstance' \
--data '{
"id": "{string}",
"url": "{string}",
"apiKey": "{string}",
"timeout": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Add a new Scan Instance

Auth
Request Body
objectobject
scanPoolIdstring

minLength: 1

urlstring

minLength: 1

pattern: ^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})?)?$)|(^((https?):\/\/)?\[(?:0*\:)*?:?0*1\](:(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})?)?$)).)*$

apiKeystring
timeoutstring
scanInstanceTypeinteger
  • 0: MdCore
  • 1: MdCloud

Enum: 0,1

POST /api/scaninstance
curl --request POST \
--url 'http://<MDSS_HOST>/api/scaninstance' \
--data '{
"scanPoolId": "{string}",
"url": "{string}",
"apiKey": "{string}",
"timeout": "{string}",
"scanInstanceType": "{integer}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
scanInstanceIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"scanInstanceId": "{string}"
}
Copy

Get Scan Instance by ID

Auth
Path Params
idstring
GET /api/scaninstance/{id}
curl --get \
--url 'http://<MDSS_HOST>/api/scaninstance/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entry
objectobject
idstring
scanPoolIdstring
urlstring
apiKeystring
timeoutstring
scanInstanceTypeinteger
  • 0: MdCore
  • 1: MdCloud

Enum: 0,1

Response
{
"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
idstring
DELETE /api/scaninstance/{id}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/scaninstance/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Test

Auth
Request Body
objectobject
urlstring

minLength: 1

rulesarray[string]
apiKeystring
userAgentstring
POST /api/scaninstance/Test
curl --request POST \
--url 'http://<MDSS_HOST>/api/scaninstance/Test' \
--data '{
"url": "{string}",
"rules": [
"{array[string]...}"
],
"apiKey": "{string}",
"userAgent": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Get Scan Pools

Auth
GET /api/scanpool
curl --get \
--url 'http://<MDSS_HOST>/api/scanpool'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries5 fieldsarray[object]
Response
{
"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
objectobject
idstring

minLength: 1

namestring

maxLength: 30

minLength: 3

PUT /api/scanpool
curl --request PUT \
--url 'http://<MDSS_HOST>/api/scanpool' \
--data '{
"id": "{string}",
"name": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Add a new Scan Pool

Auth
Request Body
objectobject
namestring

maxLength: 30

minLength: 3

scanPoolTypeinteger
  • 0: MdCore
  • 1: MdCloud

Enum: 0,1

POST /api/scanpool
curl --request POST \
--url 'http://<MDSS_HOST>/api/scanpool' \
--data '{
"name": "{string}",
"scanPoolType": "{integer}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
scanPoolIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"scanPoolId": "{string}"
}
Copy

Get Scan Pool by ID

Auth
Path Params
idstring
GET /api/scanpool/{id}
curl --get \
--url 'http://<MDSS_HOST>/api/scanpool/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entry
objectobject
idstring
namestring
scanPoolTypeinteger
  • 0: MdCore
  • 1: MdCloud

Enum: 0,1

isDefaultboolean
scanInstances6 fieldsarray[object]
Response
{
"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
idstring
DELETE /api/scanpool/{id}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/scanpool/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Scan Workflow Snapshot

List scan workflow snapshots

Get all scan workflow snapshots by scan ID

Auth
Path Params
scanIdstring
GET /api/scanworkflowsnapshot/getAllFromScan/{scanId}
curl --get \
--url 'http://<MDSS_HOST>/api/scanworkflowsnapshot/getAllFromScan/{scanId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
scanWorkflowSnapshots5 fieldsarray[object]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"scanWorkflowSnapshots": [
{
"id": "{string}",
"scanId": "{string}",
"workflow": {
"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}"
}
]
},
"filters": {
"minimumSize": "{int64}",
"maximumSize": "{int64}",
"minimumDateTime": "{date-time}",
"maximumDateTime": "{date-time}"
}
},
"startTimestamp": "{int64}",
"stopTimestamp": "{int64}"
}
]
}
Copy

Fetch storage security checklist

Auth
Path Params
storageIdstring
GET /api/security-checklist/{storageId}
curl --get \
--url 'http://<MDSS_HOST>/api/security-checklist/{storageId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedToGetSecurityChecklistNotFound
  • 2: FailedToGetSecurityChecklistStorageNotFound
  • 3: FailedToGetSecurityChecklistStorageNotOfTypeAmazon

Enum: 0,1,2,3,0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
items7 fieldsarray[object]
lastUpdateTimedate-time
scorenumber
isEnabledboolean
Response
{
"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
storageIdstring
GET /api/security-checklist/{storageId}/info
curl --get \
--url 'http://<MDSS_HOST>/api/security-checklist/{storageId}/info'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedToRetrieveSecurityChecklist

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
scorenumber
resolvedItemsCountint32
enabledItemsCountint32
isEnabledboolean
Response
{
"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
storageIdstring
Request Body
objectobject
idstring

minLength: 1

isEnabledboolean
PUT /api/security-checklist/{storageId}/item
curl --request PUT \
--url 'http://<MDSS_HOST>/api/security-checklist/{storageId}/item' \
--data '{
"id": "{string}",
"isEnabled": "{boolean}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedToUpdateSecurityChecklistItemStorageNotFound
  • 2: FailedToUpdateSecurityChecklistItemStorageNotOfTypeAmazonS3
  • 3: FailedToUpdateSecurityChecklistItemCannotRetrieveItem
  • 4: FailedToUpdateSecurityChecklistItemChecklistNotFound
  • 5: FailedToUpdateSecurityChecklistItemChecklistNotEnabled

Enum: 0,1,2,3,0,1,2,3,4,5

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
item
objectobject
idstring
titleinteger
  • 0: Https
  • 1: AuthenticatedAccessToBuckets
  • 2: LeastPrivilege
  • 3: BucketVersion
  • 4: ServerSideEncryption
  • 5: BucketAccessLogging
  • 6: DataReplication
  • 7: ObjectLocking

Enum: 0,1,2,3,4,5,6,7

statusinteger
  • 0: NotSet
  • 1: Passed
  • 2: Failed

Enum: 0,1,2

priorityinteger
  • 0: Critical
  • 1: Major
  • 2: Minor

Enum: 0,1,2

isEnabledboolean
howToFixLinkstring
failureReasonstring
storage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{…}
Copy

Verify the security checklist for storage

Auth
Path Params
storageIdstring
PUT /api/security-checklist/{storageId}/verify
curl --request PUT \
--url 'http://<MDSS_HOST>/api/security-checklist/{storageId}/verify'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedToCheckStorage
  • 2: Failed

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Enable/Disable the security checklist

Auth
Request Body
objectobject
storageIdstring

minLength: 1

isEnabledboolean
PATCH /api/security-checklist
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/security-checklist' \
--data '{
"storageId": "{string}",
"isEnabled": "{boolean}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedToCheckStorage
  • 2: Failed

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
isEnabledboolean
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
},
"isEnabled": "{boolean}"
}
Copy

Enable all security checklist items

Auth
Path Params
storageIdstring
PUT /api/security-checklist/{storageId}/enable-all
curl --request PUT \
--url 'http://<MDSS_HOST>/api/security-checklist/{storageId}/enable-all'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedToCheckStorage
  • 2: Failed

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Get notifications configuration

Auth
GET /api/settings/notifications
curl --get \
--url 'http://<MDSS_HOST>/api/settings/notifications'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: NotFound

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
emailNotificationsConfig
objectobject
generatedReportNotificationsConfig
objectobject
isEnabledboolean
recipientsTypeinteger
  • 0: OwnerOnly
  • 1: AllRegisteredUsers

Enum: 0,1

userRequestNotificationsConfig
objectobject
isEnabledboolean
blockedFileNotificationsConfig
objectobject
isEnabledboolean
recipientsTypeinteger
  • 0: AllRegisteredUsers
  • 1: FileOwner
  • 2: FileOwnerAndAllRegisteredUsers

Enum: 0,1,2

webhookNotificationsConfig
objectobject
scanCompletedNotificationsConfig
objectobject
isEnabledboolean
destinationAddressstring
headersobject
*string
requestTypeinteger
  • 0: Post
  • 1: Put

Enum: 0,1

Response
{
"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
objectobject
emailNotificationsConfig
objectobject
generatedReportNotificationsConfig
objectobject
isEnabledboolean
recipientsTypeinteger
  • 0: OwnerOnly
  • 1: AllRegisteredUsers

Enum: 0,1

userRequestNotificationsConfig
objectobject
isEnabledboolean
blockedFileNotificationsConfig
objectobject
isEnabledboolean
recipientsTypeinteger
  • 0: AllRegisteredUsers
  • 1: FileOwner
  • 2: FileOwnerAndAllRegisteredUsers

Enum: 0,1,2

webhookNotificationsConfig
objectobject
scanCompletedNotificationsConfig
objectobject
isEnabledboolean
destinationAddressstring
headersobject
*string
requestTypeinteger
  • 0: Post
  • 1: Put

Enum: 0,1

PUT /api/settings/notifications
curl --request PUT \
--url 'http://<MDSS_HOST>/api/settings/notifications' \
--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
objectobject
resultinteger
  • 0: Success
  • 1: NotFound

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
newNotificationsConfig
objectobject
idstring
emailNotificationsConfig3 fieldsobject
webhookNotificationsConfig1 fieldobject
initialNotificationsConfig
objectobject
idstring
emailNotificationsConfig3 fieldsobject
webhookNotificationsConfig1 fieldobject
Response
{
"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

Fetch SMTP configuration

Auth
GET /api/settings/smtp
curl --get \
--url 'http://<MDSS_HOST>/api/settings/smtp'
Copy
Responses
200
objectobject
hoststring
portint32
baseUrlstring
senderAddressstring
senderNamestring

maxLength: 320

domainstring
usernamestring
passwordstring
secureSocketOption
integerinteger
  • 0: None
  • 1: Auto
  • 2: SslOnConnect
  • 3: StartTls
  • 4: StartTlsWhenAvailable

Enum: 0,1,2,3,4

ignoreCertWarningsboolean
isSmtpEnabledboolean
Response
{
"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
objectobject
hoststring
portint32
baseUrlstring
senderAddressstring
senderNamestring

maxLength: 320

domainstring
usernamestring
passwordstring
secureSocketOption
integerinteger
  • 0: None
  • 1: Auto
  • 2: SslOnConnect
  • 3: StartTls
  • 4: StartTlsWhenAvailable

Enum: 0,1,2,3,4

ignoreCertWarningsboolean
isSmtpEnabledboolean
PATCH /api/settings/smtp
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/settings/smtp' \
--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
objectobject
resultinteger
  • 0: Success
  • 1: FailedSmtpConfigInvalid
  • 2: FailedSmtpConfigNotFound

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
newSmtpConfig
objectobject
idstring
hoststring
baseUrlstring
portint32
senderAddressstring
senderNamestring
domainstring
usernamestring
passwordstring
secureSocketOptioninteger
  • 0: None
  • 1: Auto
  • 2: SslOnConnect
  • 3: StartTls
  • 4: StartTlsWhenAvailable

Enum: 0,1,2,3,4

ignoreCertWarningsboolean
isSmtpEnabledboolean
oldSmtpConfig
objectobject
idstring
hoststring
baseUrlstring
portint32
senderAddressstring
senderNamestring
domainstring
usernamestring
passwordstring
secureSocketOptioninteger
  • 0: None
  • 1: Auto
  • 2: SslOnConnect
  • 3: StartTls
  • 4: StartTlsWhenAvailable

Enum: 0,1,2,3,4

ignoreCertWarningsboolean
isSmtpEnabledboolean
Response
{
"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
objectobject
keystring

minLength: 1

POST /api/settings/admin/license/activate/online
curl --request POST \
--url 'http://<MDSS_HOST>/api/settings/admin/license/activate/online' \
--data '{
"key": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Offline license activation

Auth
Request Body
objectobject
LicenseContentfile
POST /api/settings/admin/license/activate/offline
curl --request POST \
--url 'http://<MDSS_HOST>/api/settings/admin/license/activate/offline' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Get license details

Auth
GET /api/settings/admin/license
curl --get \
--url 'http://<MDSS_HOST>/api/settings/admin/license'
Copy
Responses
200
objectobject
apiStatusstring
Response
{
"apiStatus": "{string}"
}
Copy

Deactivate license

Auth
POST /api/settings/admin/license/deactivate
curl --request POST \
--url 'http://<MDSS_HOST>/api/settings/admin/license/deactivate'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Fetch retention configuration

Auth
GET /api/settings/retention
curl --get \
--url 'http://<MDSS_HOST>/api/settings/retention'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: NotFound

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
retentionAuditDaysint32
reportRetentionConfiguration
objectobject
isEnabledboolean
retentionDaysint32
rtpHistoryRetentionConfiguration
objectobject
isEnabledboolean
retentionDaysint32
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"retentionAuditDays": "{int32}",
"reportRetentionConfiguration": {
"isEnabled": "{boolean}",
"retentionDays": "{int32}"
},
"rtpHistoryRetentionConfiguration": {
"isEnabled": "{boolean}",
"retentionDays": "{int32}"
}
}
Copy

Update retention configuration

Auth
Request Body
objectobject
retentionAuditDaysint32

maximum: 50000

minimum: 1

reportRetentionobject
isEnabledboolean
retentionDaysint32

maximum: 50000

minimum: 1

rtpHistoryRetentionobject
isEnabledboolean
retentionDaysint32

maximum: 50000

minimum: 1

PUT /api/settings/retention
curl --request PUT \
--url 'http://<MDSS_HOST>/api/settings/retention' \
--data '{
"retentionAuditDays": "{int32}",
"reportRetention": {
"isEnabled": "{boolean}",
"retentionDays": "{int32}"
},
"rtpHistoryRetention": {
"isEnabled": "{boolean}",
"retentionDays": "{int32}"
}
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"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
curl --get \
--url 'http://<MDSS_HOST>/api/sso/config'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
clientIdstring
authoritystring
baseUrlstring
isEnabledboolean
ssoTypeinteger
  • 0: OpenIdConnect

Enum: 0

ssoProviderinteger
  • 0: Azure
  • 1: Okta
  • 2: Auth0
  • 3: Adfs
  • 4: PingFederate

Enum: 0,1,2,3,4

identityProviderIssuerstring
identityProviderLoginUrlstring
identityProviderLogoutUrlstring
administratorRoleNamestring
readonlyRoleNamestring
ssoConfig
objectobject
idstring
isEnabledboolean
ssoProviderinteger
  • 0: Azure
  • 1: Okta
  • 2: Auth0
  • 3: Adfs
  • 4: PingFederate
  • 5: Opswat

Enum: 0,1,2,3,4,5

ssoTypeinteger
  • 0: OpenIdConnect
  • 1: Saml2

Enum: 0,1

baseUrlstring
clientIdstring
clientSecretstring
authoritystring
identityProviderCertificatestring
identityProviderIssuerstring
loginUrlstring
logoutUrlstring
administratorRoleNamestring
readonlyRoleNamestring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"clientId": "{string}",
"authority": "{string}",
"baseUrl": "{string}",
"isEnabled": "{boolean}",
"ssoType": "{integer}",
"ssoProvider": "{integer}",
"identityProviderIssuer": "{string}",
"identityProviderLoginUrl": "{string}",
"identityProviderLogoutUrl": "{string}",
"administratorRoleName": "{string}",
"readonlyRoleName": "{string}",
"ssoConfig": {
"id": "{string}",
"isEnabled": "{boolean}",
"ssoProvider": "{integer}",
"ssoType": "{integer}",
"baseUrl": "{string}",
"clientId": "{string}",
"clientSecret": "{string}",
"authority": "{string}",
"identityProviderCertificate": "{string}",
"identityProviderIssuer": "{string}",
"loginUrl": "{string}",
"logoutUrl": "{string}",
"administratorRoleName": "{string}",
"readonlyRoleName": "{string}"
}
}
Copy

Update Sso Configuration

Auth
Request Body
objectobject
clientIdstring

maxLength: 255

clientSecretstring

maxLength: 255

authoritystring

maxLength: 255

baseUrlstring

maxLength: 255

identityProviderCertificateobject
contentstring
identityProviderIssuerstring

maxLength: 255

identityProviderLoginUrlstring

maxLength: 255

identityProviderLogoutUrlstring

maxLength: 255

isEnabledboolean
ssoTypeint32
ssoProviderint32
administratorRoleNamestring

maxLength: 63

readonlyRoleNamestring

maxLength: 63

PATCH /api/sso
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/sso' \
--data '{
"clientId": "{string}",
"clientSecret": "{string}",
"authority": "{string}",
"baseUrl": "{string}",
"identityProviderCertificate": {
"content": "{string}"
},
"identityProviderIssuer": "{string}",
"identityProviderLoginUrl": "{string}",
"identityProviderLogoutUrl": "{string}",
"isEnabled": "{boolean}",
"ssoType": "{int32}",
"ssoProvider": "{int32}",
"administratorRoleName": "{string}",
"readonlyRoleName": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
clientIdstring
authoritystring
baseUrlstring
isEnabledboolean
ssoTypeinteger
  • 0: OpenIdConnect

Enum: 0

ssoProviderinteger
  • 0: Azure
  • 1: Okta
  • 2: Auth0
  • 3: Adfs
  • 4: PingFederate

Enum: 0,1,2,3,4

identityProviderIssuerstring
identityProviderLoginUrlstring
identityProviderLogoutUrlstring
administratorRoleNamestring
readonlyRoleNamestring
ssoConfig
objectobject
idstring
isEnabledboolean
ssoProviderinteger
  • 0: Azure
  • 1: Okta
  • 2: Auth0
  • 3: Adfs
  • 4: PingFederate
  • 5: Opswat

Enum: 0,1,2,3,4,5

ssoTypeinteger
  • 0: OpenIdConnect
  • 1: Saml2

Enum: 0,1

baseUrlstring
clientIdstring
clientSecretstring
authoritystring
identityProviderCertificatestring
identityProviderIssuerstring
loginUrlstring
logoutUrlstring
administratorRoleNamestring
readonlyRoleNamestring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"clientId": "{string}",
"authority": "{string}",
"baseUrl": "{string}",
"isEnabled": "{boolean}",
"ssoType": "{integer}",
"ssoProvider": "{integer}",
"identityProviderIssuer": "{string}",
"identityProviderLoginUrl": "{string}",
"identityProviderLogoutUrl": "{string}",
"administratorRoleName": "{string}",
"readonlyRoleName": "{string}",
"ssoConfig": {
"id": "{string}",
"isEnabled": "{boolean}",
"ssoProvider": "{integer}",
"ssoType": "{integer}",
"baseUrl": "{string}",
"clientId": "{string}",
"clientSecret": "{string}",
"authority": "{string}",
"identityProviderCertificate": "{string}",
"identityProviderIssuer": "{string}",
"loginUrl": "{string}",
"logoutUrl": "{string}",
"administratorRoleName": "{string}",
"readonlyRoleName": "{string}"
}
}
Copy

Fetch all storage units

Auth
GET /api/storage/all
curl --get \
--url 'http://<MDSS_HOST>/api/storage/all'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries14 fieldsarray[object]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"entries": [
{
"id": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"name": "{string}",
"storageClientId": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{int32}"
},
"realTimeScanConfig": {
"isEnabled": "{boolean}",
"handlingType": "{integer}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"priority": "{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}"
}
},
"scansInProgress": "{boolean}",
"isRtpInProgress": "{boolean}",
"isScheduledScanInProgress": "{boolean}",
"storageFunctionality": "{string}",
"$type": "{string}"
}
]
}
Copy

Fetch storage by ID

Auth
Path Params
storageIdstring
GET /api/storage/{storageId}
curl --get \
--url 'http://<MDSS_HOST>/api/storage/{storageId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storage
objectobject
idstring
groupIdstring
accountIdstring
namestring
storageClientIdstring
storageType
objectobject
namestring
categoryTypeinteger
  • 0: Local
  • 1: Cloud
  • 2: Object

Enum: 0,1,2

protocolTypeinteger
  • 0: Smb
  • 1: GraphSdk
  • 2: BoxSdk
  • 3: AwsSdk
  • 4: AzureBlobSdk
  • 5: AlibabaCloudSdk
  • 6: GoogleCloudSdk
  • 7: AzureFilesSdk
  • 8: Sftp
  • 9: Nfs
  • 10: Mft
  • 11: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11

vendorTypeinteger
  • 0: AmazonS3
  • 1: OneDrive
  • 2: Box
  • 3: DellIsilon
  • 4: AzureFiles
  • 5: SmbCompatible
  • 6: S3Compatible
  • 7: AzureBlob
  • 8: AlibabaCloud
  • 9: GoogleCloud
  • 10: Sftp
  • 11: SharePoint
  • 12: Nfs
  • 13: Wasabi
  • 14: OracleCloud
  • 15: NetAppOntap
  • 16: Cubbit
  • 17: Mft
  • 18: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

storageStatus
objectobject
messagestring
statusTypeint32
realTimeScanConfig
objectobject
isEnabledboolean
handlingType
integerinteger
  • 0: Polling
  • 1: EventBased

Enum: 0,1

workflowIdstring
scanConfigurationIdstring
prioritystring
postActionsScanConfig
objectobject
fileTaggingConfig
objectobject
isTaggingPostActionEnabledboolean
fileTags4 fieldsarray[object]
deepCdrConfig
objectobject
isDeepCdrPostActionEnabledboolean
deepCdrOriginalFileHandlingType
integerinteger
  • 0: Keep
  • 1: Encrypt
  • 2: Delete

Enum: 0,1,2

moveDeleteRemediationConfig
objectobject
blockedFileRemediationConfigurationStatusinteger
  • 0: None
  • 1: Disabled
  • 2: Enabled

Enum: 0,1,2

sanitizedFileRemediationConfigurationStatusinteger
  • 0: None
  • 1: Disabled
  • 2: Enabled

Enum: 0,1,2

allowedFileRemediationConfigurationStatusinteger
  • 0: None
  • 1: Disabled
  • 2: Enabled

Enum: 0,1,2

shouldTreatFilesWithSensitiveDataAsBlockedboolean
shouldTreatFilesWithVulnerabilitiesAsBlockedboolean
blockedFileHandlingType
integerinteger
  • 0: Delete
  • 1: Move
  • 2: Copy

Enum: 0,1,2

allowedFileHandlingType
integerinteger
  • 0: Delete
  • 1: Move
  • 2: Copy

Enum: 0,1,2

sanitizedFileHandlingType
integerinteger
  • 0: Delete
  • 1: Move
  • 2: Copy

Enum: 0,1,2

blockedFileStorageConfig
objectobject
storageIdstring
userIdstring
keepFolderStructureboolean
sanitizedFileStorageConfig
objectobject
storageIdstring
userIdstring
keepFolderStructureboolean
allowedFileStorageConfig
objectobject
storageIdstring
userIdstring
keepFolderStructureboolean
blockingStrategy
integerinteger
  • 0: Strict
  • 1: Configurable

Enum: 0,1

scansInProgressboolean
isRtpInProgressboolean
isScheduledScanInProgressboolean
storageFunctionalitystring
$typestring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storage": {
"id": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"name": "{string}",
"storageClientId": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{int32}"
},
"realTimeScanConfig": {
"isEnabled": "{boolean}",
"handlingType": "{integer}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"priority": "{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}"
}
},
"scansInProgress": "{boolean}",
"isRtpInProgress": "{boolean}",
"isScheduledScanInProgress": "{boolean}",
"storageFunctionality": "{string}",
"$type": "{string}"
}
}
Copy

Delete a storage

Auth
Path Params
storageIdstring
DELETE /api/storage/{storageId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/storage/{storageId}'
Copy
Responses
200
filefile
Response
{
"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
storageIdstring
Request Body
objectobject
Namestring
StorageVendorTypestring
StorageProtocolTypestring
CredentialsFilefile
Credentialsstring
Sourcestring
GroupIdstring
AccountIdstring
WorkflowIdstring
PATCH /api/storage/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/{storageId}' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Fetch storage users

Auth
Path Params
storageIdstring
Query String
filterstring
GET /api/storage/{storageId}/users
curl --get \
--url 'http://<MDSS_HOST>/api/storage/{storageId}/users' \
--data filter={filter}
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entriesarray[object]
idstring
fullNamestring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"entries": [
{
"id": "{string}",
"fullName": "{string}"
}
]
}
Copy

Add 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
Request Body
objectobject
Namestring
StorageVendorTypestring
StorageProtocolTypestring
CredentialsFilefile
Credentialsstring
Sourcestring
GroupIdstring
AccountIdstring
WorkflowIdstring
POST /api/storage
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Fetch all storage units by filters (storage type or status)

Auth
Path Params
startIndexstring
countstring
Query String
sortingOrderstring
searchstring
storageTypeinteger
storageStatusinteger
GET /api/storage/enumerate/{startIndex}/{count}
curl --get \
--url 'http://<MDSS_HOST>/api/storage/enumerate/{startIndex}/{count}' \
--data sortingOrder={sortingOrder} \
--data search={search} \
--data storageType={storageType} \
--data storageStatus={storageStatus}
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries14 fieldsarray[object]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"entries": [
{
"id": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"name": "{string}",
"storageClientId": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{int32}"
},
"realTimeScanConfig": {
"isEnabled": "{boolean}",
"handlingType": "{integer}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"priority": "{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}"
}
},
"scansInProgress": "{boolean}",
"isRtpInProgress": "{boolean}",
"isScheduledScanInProgress": "{boolean}",
"storageFunctionality": "{string}",
"$type": "{string}"
}
]
}
Copy

Update scan configuration

Auth
Path Params
storageIdstring
Request Body
objectobject
realTimeScanConfig
objectobject
isEnabledboolean
handlingType
integerinteger
  • 0: Polling
  • 1: EventBased

Enum: 0,1

workflowIdstring
scanConfigurationIdstring
prioritystring
postActionsScanConfig
objectobject
fileTaggingConfig
objectobject
isTaggingPostActionEnabledboolean
fileTags4 fieldsarray[object]
deepCdrConfig
objectobject
isDeepCdrPostActionEnabledboolean
deepCdrOriginalFileHandlingType
integerinteger
  • 0: Keep
  • 1: Encrypt
  • 2: Delete

Enum: 0,1,2

moveDeleteRemediationConfig
objectobject
blockedFileRemediationConfigurationStatusinteger
  • 0: None
  • 1: Disabled
  • 2: Enabled

Enum: 0,1,2

sanitizedFileRemediationConfigurationStatusinteger
  • 0: None
  • 1: Disabled
  • 2: Enabled

Enum: 0,1,2

allowedFileRemediationConfigurationStatusinteger
  • 0: None
  • 1: Disabled
  • 2: Enabled

Enum: 0,1,2

shouldTreatFilesWithSensitiveDataAsBlockedboolean
shouldTreatFilesWithVulnerabilitiesAsBlockedboolean
blockedFileHandlingType
integerinteger
  • 0: Delete
  • 1: Move
  • 2: Copy

Enum: 0,1,2

allowedFileHandlingType
integerinteger
  • 0: Delete
  • 1: Move
  • 2: Copy

Enum: 0,1,2

sanitizedFileHandlingType
integerinteger
  • 0: Delete
  • 1: Move
  • 2: Copy

Enum: 0,1,2

blockedFileStorageConfig
objectobject
storageIdstring
userIdstring
keepFolderStructureboolean
sanitizedFileStorageConfig
objectobject
storageIdstring
userIdstring
keepFolderStructureboolean
allowedFileStorageConfig
objectobject
storageIdstring
userIdstring
keepFolderStructureboolean
blockingStrategy
integerinteger
  • 0: Strict
  • 1: Configurable

Enum: 0,1

PATCH /api/storage/{storageId}/scan_config
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/{storageId}/scan_config' \
--data '{
"realTimeScanConfig": {
"isEnabled": "{boolean}",
"handlingType": "{integer}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"priority": "{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
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Add a scan schedule

Auth
Path Params
storageIdstring
Request Body
objectobject
namestring

minLength: 1

workflowIdstring

minLength: 1

scanConfigurationIdstring
recurrencePattern
objectobject
typestring
hourlyRecurrence
objectobject
everyNumberOfHoursint32

maximum: 24

minimum: 1

dailyRecurrence
objectobject
everyNumberOfDaysint32

maximum: 365

minimum: 1

weeklyRecurrence
objectobject
daysOfWeekarray[integer]

Enum: 0,1,2,3,4,5,6

everyNumberOfWeeksint32
monthlyRecurrence
objectobject
everyNumberOfMonthsint32

maximum: 12

minimum: 1

dayOfMonthint32

maximum: 30

minimum: 1

startDatedate-time
timeToStartdate-time
$typestring
PUT /api/storage/{storageId}/scan_schedule
curl --request PUT \
--url 'http://<MDSS_HOST>/api/storage/{storageId}/scan_schedule' \
--data '{
"name": "{string}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"recurrencePattern": {
"type": "{string}",
"hourlyRecurrence": {
"everyNumberOfHours": "{int32}"
},
"dailyRecurrence": {
"everyNumberOfDays": "{int32}"
},
"weeklyRecurrence": {
"daysOfWeek": [
"{array[integer]...}"
],
"everyNumberOfWeeks": "{int32}"
},
"monthlyRecurrence": {
"everyNumberOfMonths": "{int32}",
"dayOfMonth": "{int32}"
},
"startDate": "{date-time}",
"timeToStart": "{date-time}"
},
"$type": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Update a scan schedule

Auth
Path Params
storageIdstring
Request Body
objectobject
namestring

minLength: 1

workflowIdstring

minLength: 1

scanConfigurationIdstring
recurrencePattern
objectobject
typestring
hourlyRecurrence
objectobject
everyNumberOfHoursint32

maximum: 24

minimum: 1

dailyRecurrence
objectobject
everyNumberOfDaysint32

maximum: 365

minimum: 1

weeklyRecurrence
objectobject
daysOfWeekarray[integer]

Enum: 0,1,2,3,4,5,6

everyNumberOfWeeksint32
monthlyRecurrence
objectobject
everyNumberOfMonthsint32

maximum: 12

minimum: 1

dayOfMonthint32

maximum: 30

minimum: 1

startDatedate-time
timeToStartdate-time
$typestring
idstring
PUT /api/storage/scan_schedule/update/{storageId}
curl --request PUT \
--url 'http://<MDSS_HOST>/api/storage/scan_schedule/update/{storageId}' \
--data '{
"name": "{string}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"recurrencePattern": {
"type": "{string}",
"hourlyRecurrence": {
"everyNumberOfHours": "{int32}"
},
"dailyRecurrence": {
"everyNumberOfDays": "{int32}"
},
"weeklyRecurrence": {
"daysOfWeek": [
"{array[integer]...}"
],
"everyNumberOfWeeks": "{int32}"
},
"monthlyRecurrence": {
"everyNumberOfMonths": "{int32}",
"dayOfMonth": "{int32}"
},
"startDate": "{date-time}",
"timeToStart": "{date-time}"
},
"$type": "{string}",
"id": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Fetch scan schedules

Auth
Path Params
storageIdstring
sortDirectioninteger

Enum: 0,1

startIndexinteger
countinteger
Query String
namestring
userstring
typestring
GET /api/storage/scan_schedules/{storageId}/{sortDirection}/{startIndex}/{count}
curl --get \
--url 'http://<MDSS_HOST>/api/storage/scan_schedules/{storageId}/{sortDirection}/{startIndex}/{count}' \
--data name={name} \
--data user={user} \
--data type={type}
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: StorageNotFound
  • 2: UserNotFound

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries10 fieldsarray[object]
totalCountint64
createdByUsersarray[string]
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"entries": [
{
"id": "{string}",
"name": "{string}",
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"type": "{string}",
"createdAt": "{date-time}",
"lastScanTime": "{date-time}",
"nextScanTime": "{date-time}",
"recurrencePatternDto": {
"hourlyRecurrenceDto": {
"everyNumberOfHours": "{int32}"
},
"dailyRecurrenceDto": {
"everyNumberOfDays": "{int32}"
},
"weeklyRecurrenceDto": {
"daysOfWeek": [
"{array[integer]...}"
],
"everyNumberOfWeeks": "{int32}"
},
"monthlyRecurrenceDto": {
"everyNumberOfMonths": "{int32}",
"dayOfMonth": "{int32}"
}
},
"createdBy": "{string}"
}
],
"totalCount": "{int64}",
"createdByUsers": [
"{array[string]...}"
]
}
Copy

Delete scan schedules

Auth
Request Body
arrayarray[string]
DELETE /api/storage/scan_schedule
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/storage/scan_schedule' \
--data '[
"{array[string]...}"
]'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedInvalidListOfIds

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
areAllDeletedboolean
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"areAllDeleted": "{boolean}"
}
Copy

Retrieve storage user name

Auth
Path Params
storageIdstring
userIdstring
GET /api/storage/{storageId}/{userId}
curl --get \
--url 'http://<MDSS_HOST>/api/storage/{storageId}/{userId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
userNamestring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"userName": "{string}"
}
Copy

Fetch active users

Auth
Headers
searchTermstring
Path Params
startIndexstring
countstring
GET /api/user/active/{startIndex}/{count}
curl --get \
--url 'http://<MDSS_HOST>/api/user/active/{startIndex}/{count}' \
--header 'searchTerm: {searchTerm}'
Copy
Responses
200
objectobject
entries5 fieldsarray[object]
totalCountint64
Response
{
"entries": [
{
"id": "{string}",
"userName": "{string}",
"fullName": "{string}",
"email": "{string}",
"role": "{integer}"
}
],
"totalCount": "{int64}"
}
Copy

Register a user

Auth
Request Body
objectobject
fullNamestring

minLength: 1

userNamestring

minLength: 1

passwordstring

minLength: 1

emailstring

minLength: 1

POST /api/user/register
curl --request POST \
--url 'http://<MDSS_HOST>/api/user/register' \
--data '{
"fullName": "{string}",
"userName": "{string}",
"password": "{string}",
"email": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Create a user

Auth
Request Body
objectobject
fullNamestring

minLength: 1

userNamestring

minLength: 1

passwordstring

minLength: 1

emailstring

minLength: 1

roleinteger
  • 0: None
  • 1: ReadOnlyAdministrator
  • 2: Administrator
  • 4: SsoAdministrator
  • 5: SsoReadOnlyAdministrator
  • 6: TenantAdministrator

Enum: 0,1,2,4,5,6

POST /api/user/create
curl --request POST \
--url 'http://<MDSS_HOST>/api/user/create' \
--data '{
"fullName": "{string}",
"userName": "{string}",
"password": "{string}",
"email": "{string}",
"role": "{integer}"
}'
Copy
Responses
200
filefile
Response
{
"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
objectobject
userNamestring

minLength: 1

passwordstring

minLength: 1

POST /api/user/authenticate
curl --request POST \
--url 'http://<MDSS_HOST>/api/user/authenticate' \
--data '{
"userName": "{string}",
"password": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedInvalidUserNameOrPassword
  • 2: FailedTooManyLoginAttempts
  • 3: FailedAccountIsNotActivated
  • 4: FailedSsoAuthentication

Enum: 0,1,2,3,0,1,2,3,4

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
accessTokenstring
accessTokenExpiryTimedate-time
refreshTokenstring
refreshTokenExpiryTimedate-time
fullNamestring
emailstring
userNamestring
roleinteger
  • 0: None
  • 1: ReadOnlyAdministrator
  • 2: Administrator
  • 4: SsoAdministrator
  • 5: SsoReadOnlyAdministrator
  • 6: TenantAdministrator

Enum: 0,1,2,4,5,6

user
objectobject
idstring
fullNamestring
userNamestring
passwordHashstring
passwordSaltstring
emailstring
roleinteger
  • 0: None
  • 1: ReadOnlyAdministrator
  • 2: Administrator
  • 4: SsoAdministrator
  • 5: SsoReadOnlyAdministrator
  • 6: TenantAdministrator

Enum: 0,1,2,4,5,6

accountSecurityobject
incrementalDelaystring
failedLoginDatedate-time
ssoUserIdstring
Response
{
"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}"
},
"ssoUserId": "{string}"
}
}
Copy

Refresh user token

Auth
Request Body
objectobject
accessTokenstring

minLength: 1

refreshTokenstring

minLength: 1

POST /api/user/refreshToken
curl --request POST \
--url 'http://<MDSS_HOST>/api/user/refreshToken' \
--data '{
"accessToken": "{string}",
"refreshToken": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Logout

Auth
POST /api/user/logout
curl --request POST \
--url 'http://<MDSS_HOST>/api/user/logout'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Update user role

Auth
Request Body
objectobject
userIdstring

minLength: 1

roleinteger
  • 0: None
  • 1: ReadOnlyAdministrator
  • 2: Administrator
  • 4: SsoAdministrator
  • 5: SsoReadOnlyAdministrator
  • 6: TenantAdministrator

Enum: 0,1,2,4,5,6

PUT /api/user/role
curl --request PUT \
--url 'http://<MDSS_HOST>/api/user/role' \
--data '{
"userId": "{string}",
"role": "{integer}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
accessTokenstring
accessTokenExpiryTimedate-time
refreshTokenstring
refreshTokenExpiryTimedate-time
user
objectobject
idstring
fullNamestring
userNamestring
passwordHashstring
passwordSaltstring
emailstring
roleinteger
  • 0: None
  • 1: ReadOnlyAdministrator
  • 2: Administrator
  • 4: SsoAdministrator
  • 5: SsoReadOnlyAdministrator
  • 6: TenantAdministrator

Enum: 0,1,2,4,5,6

accountSecurityobject
incrementalDelaystring
failedLoginDatedate-time
ssoUserIdstring
Response
{
"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}"
},
"ssoUserId": "{string}"
}
}
Copy

Fetch users

Auth
GET /api/user/requests
curl --get \
--url 'http://<MDSS_HOST>/api/user/requests'
Copy
Responses
200
objectobject
entries5 fieldsarray[object]
totalCountint64
Response
{
"entries": [
{
"id": "{string}",
"userName": "{string}",
"fullName": "{string}",
"email": "{string}",
"role": "{integer}"
}
],
"totalCount": "{int64}"
}
Copy

Delete a user

Auth
Path Params
userIdstring
DELETE /api/user/{userId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/user/{userId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedToDeleteScanSchedules

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
user
objectobject
idstring
fullNamestring
userNamestring
passwordHashstring
passwordSaltstring
emailstring
roleinteger
  • 0: None
  • 1: ReadOnlyAdministrator
  • 2: Administrator
  • 4: SsoAdministrator
  • 5: SsoReadOnlyAdministrator
  • 6: TenantAdministrator

Enum: 0,1,2,4,5,6

accountSecurityobject
incrementalDelaystring
failedLoginDatedate-time
ssoUserIdstring
Response
{
"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}"
},
"ssoUserId": "{string}"
}
}
Copy

Update a user

Auth
Request Body
objectobject
userIdstring
roleinteger
  • 0: None
  • 1: ReadOnlyAdministrator
  • 2: Administrator
  • 4: SsoAdministrator
  • 5: SsoReadOnlyAdministrator
  • 6: TenantAdministrator

Enum: 0,1,2,4,5,6

userNamestring
fullNamestring
currentPasswordstring
newPasswordstring
emailstring
PUT /api/user
curl --request PUT \
--url 'http://<MDSS_HOST>/api/user' \
--data '{
"userId": "{string}",
"role": "{integer}",
"userName": "{string}",
"fullName": "{string}",
"currentPassword": "{string}",
"newPassword": "{string}",
"email": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
accessTokenstring
accessTokenExpiryTimedate-time
refreshTokenstring
refreshTokenExpiryTimedate-time
user
objectobject
idstring
fullNamestring
userNamestring
passwordHashstring
passwordSaltstring
emailstring
roleinteger
  • 0: None
  • 1: ReadOnlyAdministrator
  • 2: Administrator
  • 4: SsoAdministrator
  • 5: SsoReadOnlyAdministrator
  • 6: TenantAdministrator

Enum: 0,1,2,4,5,6

accountSecurityobject
incrementalDelaystring
failedLoginDatedate-time
ssoUserIdstring
Response
{
"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}"
},
"ssoUserId": "{string}"
}
}
Copy

Request password reset

Auth
Request Body
objectobject
userInputstring

minLength: 1

POST /api/user/password/reset
curl --request POST \
--url 'http://<MDSS_HOST>/api/user/password/reset' \
--data '{
"userInput": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedSmtpNotEnabled

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Reset user password

Auth
Request Body
objectobject
newPasswordstring

minLength: 12

newPasswordConfirmationstring

minLength: 12

secureTokenstring
POST /api/user/password
curl --request POST \
--url 'http://<MDSS_HOST>/api/user/password' \
--data '{
"newPassword": "{string}",
"newPasswordConfirmation": "{string}",
"secureToken": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
user9 fieldsobject
Response
{
"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}"
},
"ssoUserId": "{string}"
}
}
Copy

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
objectobject
metadatastring

minLength: 1

storageClientIdstring

minLength: 1

POST /api/webhook/realtime
curl --request POST \
--url 'http://<MDSS_HOST>/api/webhook/realtime' \
--data '{
"metadata": "{string}",
"storageClientId": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Failed
  • 2: NotFound

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
correlationIdstring
400
404
Response
{
"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
storageClientIdstring
Request Body
No request body
POST /api/webhook/realtime/{storageClientId}
curl --request POST \
--url 'http://<MDSS_HOST>/api/webhook/realtime/{storageClientId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Failed
  • 2: NotFound

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
correlationIdstring
400
404
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"correlationId": "{string}"
}
Copy

Get Scan Configurations

Auth
GET /api/workflow
curl --get \
--url 'http://<MDSS_HOST>/api/workflow'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries10 fieldsarray[object]
Response
{
"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}"
}
]
},
"filters": {
"minimumSize": "{int64}",
"maximumSize": "{int64}",
"minimumDateTime": "{date-time}",
"maximumDateTime": "{date-time}"
}
}
]
}
Copy

Add a new Scan Configuration

Auth
Request Body
objectobject
scanPoolIdstring

minLength: 1

rulesarray[string]
namestring

maxLength: 30

minLength: 3

userAgentstring
failOverScanPoolIdstring
filters4 fieldsobject
POST /api/workflow
curl --request POST \
--url 'http://<MDSS_HOST>/api/workflow' \
--data '{
"scanPoolId": "{string}",
"rules": [
"{array[string]...}"
],
"name": "{string}",
"userAgent": "{string}",
"failOverScanPoolId": "{string}",
"filters": {
"minimumSize": "{int64}",
"maximumSize": "{int64}",
"minimumDateTime": "{date-time}",
"maximumDateTime": "{date-time}"
}
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
workflowIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"workflowId": "{string}"
}
Copy

Update an existing Scan Configuration

Auth
Request Body
objectobject
idstring

minLength: 1

scanPoolIdstring
rulesarray[string]
namestring

maxLength: 30

minLength: 3

userAgentstring
failOverScanPoolIdstring
failOverDisabledboolean
filters
objectobject
minimumSizeint64
maximumSizeint64
minimumDateTimedate-time
maximumDateTimedate-time
PATCH /api/workflow
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/workflow' \
--data '{
"id": "{string}",
"scanPoolId": "{string}",
"rules": [
"{array[string]...}"
],
"name": "{string}",
"userAgent": "{string}",
"failOverScanPoolId": "{string}",
"failOverDisabled": "{boolean}",
"filters": {
"minimumSize": "{int64}",
"maximumSize": "{int64}",
"minimumDateTime": "{date-time}",
"maximumDateTime": "{date-time}"
}
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Get Scan Configuration by ID

Auth
Path Params
idstring
GET /api/workflow/{id}
curl --get \
--url 'http://<MDSS_HOST>/api/workflow/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entry
objectobject
idstring
scanPoolIdstring
rulesarray[string]
typeinteger
  • 0: Default
  • 1: Basic

Enum: 0,1

namestring
userAgentstring
scanPool5 fieldsobject
failOverScanPoolIdstring
failOverScanPool
objectobject
idstring
namestring
scanPoolTypeinteger
  • 0: MdCore
  • 1: MdCloud

Enum: 0,1

isDefaultboolean
scanInstances6 fieldsarray[object]
filters4 fieldsobject
Response
{
"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}"
}
]
},
"filters": {
"minimumSize": "{int64}",
"maximumSize": "{int64}",
"minimumDateTime": "{date-time}",
"maximumDateTime": "{date-time}"
}
}
}
Copy

Delete a Scan Configuration

Auth
Path Params
idstring
DELETE /api/workflow/{id}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/workflow/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Set a Scan Configuration as default

Auth
Path Params
idstring
POST /api/workflow/setDefault/{id}
curl --request POST \
--url 'http://<MDSS_HOST>/api/workflow/setDefault/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Deprecated Soon To Be Removed

Deprecated, soon to be removedDeprecated

Fetch MetaDefender Core Pools

Auth
GET /api/corepool
curl --get \
--url 'http://<MDSS_HOST>/api/corepool'
Copy
Responses
200
objectobject

Deprecated

entries4 fieldsarray[object]
Response
{
"entries": [
{
"id": "{string}",
"name": "{string}",
"mdCores": [
{
"id": "{string}",
"url": "{string}",
"ip": "{string}",
"apiKey": "{string}",
"timeout": "{string}",
"userAgent": "{string}",
"workflowRule": "{string}",
"displayName": "{string}"
}
],
"usedBy": [
{
"name": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
}
}
]
}
]
}
Copy

Deprecated, soon to be removedDeprecated

Update an existing MetaDefender Core Pool

Auth
Request Body
objectobject

Deprecated

idstring

minLength: 1

namestring

maxLength: 30

minLength: 3

PUT /api/corepool
curl --request PUT \
--url 'http://<MDSS_HOST>/api/corepool' \
--data '{
"id": "{string}",
"name": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Deprecated, soon to be removedDeprecated

Add a new MetaDefender Core Pool

Auth
Request Body
objectobject

Deprecated

namestring

maxLength: 30

minLength: 3

POST /api/corepool
curl --request POST \
--url 'http://<MDSS_HOST>/api/corepool' \
--data '{
"name": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Deprecated, soon to be removedDeprecated

Get MetaDefender Core Pool by ID

Auth
Path Params
corePoolIdstring
GET /api/corepool/{corePoolId}
curl --get \
--url 'http://<MDSS_HOST>/api/corepool/{corePoolId}'
Copy
Responses
200
objectobject

Deprecated

resultinteger
  • 0: Success
  • 1: NotFound

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
corePool
objectobject

Deprecated

idstring
namestring
mdCores8 fieldsarray[object]
usedByarray[object]
namestring
storageType
objectobject
namestring
categoryTypeinteger
  • 0: Local
  • 1: Cloud
  • 2: Object

Enum: 0,1,2

protocolTypeinteger
  • 0: Smb
  • 1: GraphSdk
  • 2: BoxSdk
  • 3: AwsSdk
  • 4: AzureBlobSdk
  • 5: AlibabaCloudSdk
  • 6: GoogleCloudSdk
  • 7: AzureFilesSdk
  • 8: Sftp
  • 9: Nfs
  • 10: Mft
  • 11: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11

vendorTypeinteger
  • 0: AmazonS3
  • 1: OneDrive
  • 2: Box
  • 3: DellIsilon
  • 4: AzureFiles
  • 5: SmbCompatible
  • 6: S3Compatible
  • 7: AzureBlob
  • 8: AlibabaCloud
  • 9: GoogleCloud
  • 10: Sftp
  • 11: SharePoint
  • 12: Nfs
  • 13: Wasabi
  • 14: OracleCloud
  • 15: NetAppOntap
  • 16: Cubbit
  • 17: Mft
  • 18: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"corePool": {
"id": "{string}",
"name": "{string}",
"mdCores": [
{
"id": "{string}",
"url": "{string}",
"ip": "{string}",
"apiKey": "{string}",
"timeout": "{string}",
"userAgent": "{string}",
"workflowRule": "{string}",
"displayName": "{string}"
}
],
"usedBy": [
{
"name": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
}
}
]
}
}
Copy

Deprecated, soon to be removedDeprecated

Delete MetaDefender Core Pool

Auth
Path Params
idstring
DELETE /api/corepool/{id}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/corepool/{id}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Deprecated, soon to be removedDeprecated

Fetch MetaDefender Core servers

Auth
Query String
corePoolIdstring
GET /api/metadefendercore
curl --get \
--url 'http://<MDSS_HOST>/api/metadefendercore' \
--data corePoolId={corePoolId}
Copy
Responses
200
objectobject

Deprecated

entries8 fieldsarray[object]
Response
{
"entries": [
{
"id": "{string}",
"url": "{string}",
"ip": "{string}",
"apiKey": "{string}",
"timeout": "{string}",
"userAgent": "{string}",
"workflowRule": "{string}",
"displayName": "{string}"
}
]
}
Copy

Deprecated, soon to be removedDeprecated

Update MetaDefender Core server

Auth
Request Body
objectobject

Deprecated

idstring
urlstring

minLength: 1

pattern: ^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})?)?$)|(^((https?):\/\/)?\[(?:0*\:)*?:?0*1\](:(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})?)?$)).)*$

apiKeystring
timeoutstring
userAgentstring
workflowRulestring
corePoolIdstring
PUT /api/metadefendercore
curl --request PUT \
--url 'http://<MDSS_HOST>/api/metadefendercore' \
--data '{
"id": "{string}",
"url": "{string}",
"apiKey": "{string}",
"timeout": "{string}",
"userAgent": "{string}",
"workflowRule": "{string}",
"corePoolId": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Deprecated, soon to be removedDeprecated

Add a new MetaDefender Core Server

Auth
Request Body
objectobject

Deprecated

idstring
urlstring

minLength: 1

pattern: ^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})?)?$)|(^((https?):\/\/)?\[(?:0*\:)*?:?0*1\](:(6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]|[1-5][0-9]{4}|[1-9][0-9]{0,3})?)?$)).)*$

apiKeystring
timeoutstring
userAgentstring
workflowRulestring
corePoolIdstring
POST /api/metadefendercore
curl --request POST \
--url 'http://<MDSS_HOST>/api/metadefendercore' \
--data '{
"id": "{string}",
"url": "{string}",
"apiKey": "{string}",
"timeout": "{string}",
"userAgent": "{string}",
"workflowRule": "{string}",
"corePoolId": "{string}"
}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

Deprecated, soon to be removedDeprecated

Get MetaDefender Core server by ID

Auth
Path Params
metaDefenderIdstring
GET /api/metadefendercore/{metaDefenderId}
curl --get \
--url 'http://<MDSS_HOST>/api/metadefendercore/{metaDefenderId}'
Copy
Responses
200
objectobject

Deprecated

idstring
urlstring
ipstring
apiKeystring
timeoutstring
userAgentstring
workflowRulestring
displayNamestring
Response
{
"id": "{string}",
"url": "{string}",
"ip": "{string}",
"apiKey": "{string}",
"timeout": "{string}",
"userAgent": "{string}",
"workflowRule": "{string}",
"displayName": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

Delete MetaDefender Core server

Auth
Path Params
metaDefenderIdstring
DELETE /api/metadefendercore/{metaDefenderId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/metadefendercore/{metaDefenderId}'
Copy
Responses
200
filefile
Response
{
"schema": "{file}"
}
Copy

(Deprecated - use /workflow) Get Scan ConfigurationsDeprecated

Auth
GET /api/scanconfiguration
curl --get \
--url 'http://<MDSS_HOST>/api/scanconfiguration'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entries9 fieldsarray[object]
Response
{
"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

(Deprecated - use /workflow) Add a new Scan ConfigurationDeprecated

Auth
Request Body
objectobject
scanPoolIdstring

minLength: 1

rulesarray[string]
namestring

maxLength: 30

minLength: 3

userAgentstring
failOverScanPoolIdstring
POST /api/scanconfiguration
curl --request POST \
--url 'http://<MDSS_HOST>/api/scanconfiguration' \
--data '{
"scanPoolId": "{string}",
"rules": [
"{array[string]...}"
],
"name": "{string}",
"userAgent": "{string}",
"failOverScanPoolId": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
scanConfigurationIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"scanConfigurationId": "{string}"
}
Copy

(Deprecated - use /workflow) Update an existing Scan ConfigurationDeprecated

Auth
Request Body
objectobject
idstring

minLength: 1

scanPoolIdstring
rulesarray[string]
namestring

maxLength: 30

minLength: 3

userAgentstring
failOverScanPoolIdstring
failOverDisabledboolean
PATCH /api/scanconfiguration
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/scanconfiguration' \
--data '{
"id": "{string}",
"scanPoolId": "{string}",
"rules": [
"{array[string]...}"
],
"name": "{string}",
"userAgent": "{string}",
"failOverScanPoolId": "{string}",
"failOverDisabled": "{boolean}"
}'
Copy
Responses
200
objectobject

Deprecated

resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

(Deprecated - use /workflow) Get Scan Configuration by IDDeprecated

Auth
Path Params
idstring
GET /api/scanconfiguration/{id}
curl --get \
--url 'http://<MDSS_HOST>/api/scanconfiguration/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
entry
objectobject
idstring
scanPoolIdstring
rulesarray[string]
typeinteger
  • 0: Default
  • 1: Basic

Enum: 0,1

namestring
userAgentstring
scanPool5 fieldsobject
failOverScanPoolIdstring
failOverScanPool
objectobject
idstring
namestring
scanPoolTypeinteger
  • 0: MdCore
  • 1: MdCloud

Enum: 0,1

isDefaultboolean
scanInstances6 fieldsarray[object]
Response
{
"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

(Deprecated - use /workflow) Delete a Scan ConfigurationDeprecated

Auth
Path Params
idstring
DELETE /api/scanconfiguration/{id}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/scanconfiguration/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

(Deprecated - use /workflow) Set a Scan Configuration as defaultDeprecated

Auth
Path Params
idstring
POST /api/scanconfiguration/setDefault/{id}
curl --request POST \
--url 'http://<MDSS_HOST>/api/scanconfiguration/setDefault/{id}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
scanIdstring
activeFileIdstring
GET /api/scan/active/{scanId}/{activeFileId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/active/{scanId}/{activeFileId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
idstring
namestring
startTimedate-time
stopTimedate-time
scanTypestring
scanningStateinteger
  • 0: NotStarted
  • 1: Running
  • 2: Cancelled
  • 3: Failed
  • 4: Completed

Enum: 0,1,2,3,4

scanStatusDto
objectobject
pendingFilesCountint64
allowedFilesCountint64
blockedFilesCountint64
totalFilesCountint64
processingFailedCountint64
processedFilesCountint64
scanStatsDto
objectobject
pciDssComplianceViolationsCountint64
hipaaComplianceViolationsCountint64
gdprComplianceViolationsCountint64
malwareSecurityAlertsCountint64
vulnerabilitiesSecurityAlertsCountint64
piiSecurityAlertsCountint64
pciDssComplianceViolationsPercentageIncreaseint64
hipaaComplianceViolationsPercentageIncreaseint64
gdprComplianceViolationsPercentageIncreaseint64
malwareSecurityAlertsPercentageIncreaseint64
vulnerabilitiesSecurityAlertsPercentageIncreaseint64
piiSecurityAlertsPercentageIncreaseint64
highRiskAccounts3 fieldsarray[object]
scanSequenceDto
objectobject
previousScanIdstring
nextScanIdstring
workflowIdstring

minLength: 1

scanConfigurationIdstring
errorsarray[string]
Response
{
"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}"
},
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"errors": [
"{array[string]...}"
]
}
Copy

Deprecated, soon to be removedDeprecated

(Deprecated) Get Real-Time scan

Auth
Path Params
storageIdstring
GET /api/scan/realtime/{storageId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/realtime/{storageId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedStorageNotFound
  • 2: FailedRealTimeScanNotFound

Enum: 0,1,2,3,0,1,2

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
idstring
namestring
startTimedate-time
stopTimedate-time
scanTypestring
scanningStateinteger
  • 0: NotStarted
  • 1: Running
  • 2: Cancelled
  • 3: Failed
  • 4: Completed

Enum: 0,1,2,3,4

scanStatusDto
objectobject
pendingFilesCountint64
allowedFilesCountint64
blockedFilesCountint64
totalFilesCountint64
processingFailedCountint64
processedFilesCountint64
scanStatsDto
objectobject
pciDssComplianceViolationsCountint64
hipaaComplianceViolationsCountint64
gdprComplianceViolationsCountint64
malwareSecurityAlertsCountint64
vulnerabilitiesSecurityAlertsCountint64
piiSecurityAlertsCountint64
pciDssComplianceViolationsPercentageIncreaseint64
hipaaComplianceViolationsPercentageIncreaseint64
gdprComplianceViolationsPercentageIncreaseint64
malwareSecurityAlertsPercentageIncreaseint64
vulnerabilitiesSecurityAlertsPercentageIncreaseint64
piiSecurityAlertsPercentageIncreaseint64
highRiskAccounts3 fieldsarray[object]
scanSequenceDto
objectobject
previousScanIdstring
nextScanIdstring
workflowIdstring

minLength: 1

scanConfigurationIdstring
errorsarray[string]
isRealTimeEnabledboolean
handlingTypeinteger
  • 0: Polling
  • 1: EventBased

Enum: 0,1

Response
{
"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}"
},
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"errors": [
"{array[string]...}"
],
"isRealTimeEnabled": "{boolean}",
"handlingType": "{integer}"
}
Copy

Deprecated, soon to be removedDeprecated

(Deprecated) Fetch last completed scan

Auth
Path Params
storageIdstring
GET /api/scan/last_completed/{storageId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/last_completed/{storageId}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
idstring
namestring
startTimedate-time
stopTimedate-time
scanTypestring
scanningStateinteger
  • 0: NotStarted
  • 1: Running
  • 2: Cancelled
  • 3: Failed
  • 4: Completed

Enum: 0,1,2,3,4

scanStatusDto
objectobject
pendingFilesCountint64
allowedFilesCountint64
blockedFilesCountint64
totalFilesCountint64
processingFailedCountint64
processedFilesCountint64
scanStatsDto
objectobject
pciDssComplianceViolationsCountint64
hipaaComplianceViolationsCountint64
gdprComplianceViolationsCountint64
malwareSecurityAlertsCountint64
vulnerabilitiesSecurityAlertsCountint64
piiSecurityAlertsCountint64
pciDssComplianceViolationsPercentageIncreaseint64
hipaaComplianceViolationsPercentageIncreaseint64
gdprComplianceViolationsPercentageIncreaseint64
malwareSecurityAlertsPercentageIncreaseint64
vulnerabilitiesSecurityAlertsPercentageIncreaseint64
piiSecurityAlertsPercentageIncreaseint64
highRiskAccounts3 fieldsarray[object]
scanSequenceDto
objectobject
previousScanIdstring
nextScanIdstring
workflowIdstring

minLength: 1

scanConfigurationIdstring
errorsarray[string]
Response
{
"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}"
},
"workflowId": "{string}",
"scanConfigurationId": "{string}",
"errors": [
"{array[string]...}"
]
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
serviceUrlstring
secretsManagerServiceUrlstring
kmsServiceUrlstring
accessKeyIdstring
secretAccessKeystring
regionEndpointstring
bucketNamestring

minLength: 1

folderLocationstring
useIamRoleboolean
assumeRoleArnstring

pattern: ^arn:aws(-cn|-us-gov)?:iam::\d+:role/[a-zA-Z0-9_+=,.@-]+$

useClientSideEncryptionboolean
secretNamestring
storageVendorTypeinteger
  • 0: AmazonS3
  • 1: OneDrive
  • 2: Box
  • 3: DellIsilon
  • 4: AzureFiles
  • 5: SmbCompatible
  • 6: S3Compatible
  • 7: AzureBlob
  • 8: AlibabaCloud
  • 9: GoogleCloud
  • 10: Sftp
  • 11: SharePoint
  • 12: Nfs
  • 13: Wasabi
  • 14: OracleCloud
  • 15: NetAppOntap
  • 16: Cubbit
  • 17: Mft
  • 18: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

usePathStyleAddressingboolean
POST /api/storage/amazons3
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/amazons3' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"serviceUrl": "{string}",
"secretsManagerServiceUrl": "{string}",
"kmsServiceUrl": "{string}",
"accessKeyId": "{string}",
"secretAccessKey": "{string}",
"regionEndpoint": "{string}",
"bucketName": "{string}",
"folderLocation": "{string}",
"useIamRole": "{boolean}",
"assumeRoleArn": "{string}",
"useClientSideEncryption": "{boolean}",
"secretName": "{string}",
"storageVendorType": "{integer}",
"usePathStyleAddressing": "{boolean}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
serviceUrlstring
secretsManagerServiceUrlstring
kmsServiceUrlstring
accessKeyIdstring
secretAccessKeystring
regionEndpointstring
bucketNamestring

minLength: 1

folderLocationstring
useIamRoleboolean
assumeRoleArnstring

pattern: ^arn:aws(-cn|-us-gov)?:iam::\d+:role/[a-zA-Z0-9_+=,.@-]+$

useClientSideEncryptionboolean
secretNamestring
storageVendorTypeinteger
  • 0: AmazonS3
  • 1: OneDrive
  • 2: Box
  • 3: DellIsilon
  • 4: AzureFiles
  • 5: SmbCompatible
  • 6: S3Compatible
  • 7: AzureBlob
  • 8: AlibabaCloud
  • 9: GoogleCloud
  • 10: Sftp
  • 11: SharePoint
  • 12: Nfs
  • 13: Wasabi
  • 14: OracleCloud
  • 15: NetAppOntap
  • 16: Cubbit
  • 17: Mft
  • 18: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

usePathStyleAddressingboolean
PATCH /api/storage/amazons3/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/amazons3/{storageId}' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"serviceUrl": "{string}",
"secretsManagerServiceUrl": "{string}",
"kmsServiceUrl": "{string}",
"accessKeyId": "{string}",
"secretAccessKey": "{string}",
"regionEndpoint": "{string}",
"bucketName": "{string}",
"folderLocation": "{string}",
"useIamRole": "{boolean}",
"assumeRoleArn": "{string}",
"useClientSideEncryption": "{boolean}",
"secretName": "{string}",
"storageVendorType": "{integer}",
"usePathStyleAddressing": "{boolean}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
tenantIdstring

maxLength: 36

minLength: 36

clientIdstring

maxLength: 36

minLength: 36

clientSecretstring

maxLength: 50

minLength: 1

groupstring
POST /api/storage/onedrive
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/onedrive' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"tenantId": "{string}",
"clientId": "{string}",
"clientSecret": "{string}",
"group": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
tenantIdstring

maxLength: 36

minLength: 36

clientIdstring

maxLength: 36

minLength: 36

clientSecretstring

maxLength: 50

minLength: 1

groupstring
PATCH /api/storage/onedrive/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/onedrive/{storageId}' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"tenantId": "{string}",
"clientId": "{string}",
"clientSecret": "{string}",
"group": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Deprecated, soon to be removedDeprecated

(Deprecated - use /storage) Add a Box storage

Auth
Request Body
objectobject
Credentialsfile
UserNamestring
FolderPathstring
GroupNamestring
Namestring
GroupIdstring
AccountIdstring
WorkflowIdstring
POST /api/storage/box
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/box' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
objectobject
Credentialsfile
UserNamestring
FolderPathstring
GroupNamestring
Namestring
GroupIdstring
AccountIdstring
WorkflowIdstring
PATCH /api/storage/box/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/box/{storageId}' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
storageVendorTypeinteger
  • 0: AmazonS3
  • 1: OneDrive
  • 2: Box
  • 3: DellIsilon
  • 4: AzureFiles
  • 5: SmbCompatible
  • 6: S3Compatible
  • 7: AzureBlob
  • 8: AlibabaCloud
  • 9: GoogleCloud
  • 10: Sftp
  • 11: SharePoint
  • 12: Nfs
  • 13: Wasabi
  • 14: OracleCloud
  • 15: NetAppOntap
  • 16: Cubbit
  • 17: Mft
  • 18: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

userstring

minLength: 1

passwordstring

minLength: 1

sharePathstring

minLength: 1

POST /api/storage/smb
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/smb' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"storageVendorType": "{integer}",
"user": "{string}",
"password": "{string}",
"sharePath": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
storageVendorTypeinteger
  • 0: AmazonS3
  • 1: OneDrive
  • 2: Box
  • 3: DellIsilon
  • 4: AzureFiles
  • 5: SmbCompatible
  • 6: S3Compatible
  • 7: AzureBlob
  • 8: AlibabaCloud
  • 9: GoogleCloud
  • 10: Sftp
  • 11: SharePoint
  • 12: Nfs
  • 13: Wasabi
  • 14: OracleCloud
  • 15: NetAppOntap
  • 16: Cubbit
  • 17: Mft
  • 18: SharepointOnPrem

Enum: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

userstring

minLength: 1

passwordstring

minLength: 1

sharePathstring

minLength: 1

PATCH /api/storage/smb/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/smb/{storageId}' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"storageVendorType": "{integer}",
"user": "{string}",
"password": "{string}",
"sharePath": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
tenantIdstring

maxLength: 36

minLength: 36

storageAccountstring

maxLength: 24

minLength: 3

clientIdstring

maxLength: 36

minLength: 36

clientSecretstring

maxLength: 50

minLength: 1

containerstring

maxLength: 63

minLength: 0

cloudTypestring

maxLength: 63

minLength: 0

POST /api/storage/azureblob
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/azureblob' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"tenantId": "{string}",
"storageAccount": "{string}",
"clientId": "{string}",
"clientSecret": "{string}",
"container": "{string}",
"cloudType": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
tenantIdstring

maxLength: 36

minLength: 36

storageAccountstring

maxLength: 24

minLength: 3

clientIdstring

maxLength: 36

minLength: 36

clientSecretstring

maxLength: 50

minLength: 1

containerstring

maxLength: 63

minLength: 0

cloudTypestring

maxLength: 63

minLength: 0

PATCH /api/storage/azureblob/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/azureblob/{storageId}' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"tenantId": "{string}",
"storageAccount": "{string}",
"clientId": "{string}",
"clientSecret": "{string}",
"container": "{string}",
"cloudType": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
endpointstring

minLength: 1

accessKeyIdstring
accessKeySecretstring
bucketNamestring

minLength: 1

folderLocationstring
useRamRoleboolean
POST /api/storage/alibabacloud
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/alibabacloud' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"endpoint": "{string}",
"accessKeyId": "{string}",
"accessKeySecret": "{string}",
"bucketName": "{string}",
"folderLocation": "{string}",
"useRamRole": "{boolean}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
endpointstring

minLength: 1

accessKeyIdstring
accessKeySecretstring
bucketNamestring

minLength: 1

folderLocationstring
useRamRoleboolean
PATCH /api/storage/alibabacloud/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/alibabacloud/{storageId}' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"endpoint": "{string}",
"accessKeyId": "{string}",
"accessKeySecret": "{string}",
"bucketName": "{string}",
"folderLocation": "{string}",
"useRamRole": "{boolean}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Request Body
objectobject
Credentialsfile
BucketNamestring
FolderLocationstring
UseAdcboolean
Namestring
GroupIdstring
AccountIdstring
WorkflowIdstring
POST /api/storage/googlecloud
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/googlecloud' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
objectobject
Credentialsfile
BucketNamestring
FolderLocationstring
UseAdcboolean
Namestring
GroupIdstring
AccountIdstring
WorkflowIdstring
PATCH /api/storage/googlecloud/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/googlecloud/{storageId}' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
accountNamestring

minLength: 1

accountKeystring

minLength: 1

shareNamestring

minLength: 1

folderLocationstring
POST /api/storage/azurefiles
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/azurefiles' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"accountName": "{string}",
"accountKey": "{string}",
"shareName": "{string}",
"folderLocation": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
objectobject
namestring

maxLength: 60

minLength: 1

groupIdstring
accountIdstring
workflowIdstring
accountNamestring

minLength: 1

accountKeystring

minLength: 1

shareNamestring

minLength: 1

folderLocationstring
PATCH /api/storage/azurefiles/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/azurefiles/{storageId}' \
--data '{
"name": "{string}",
"groupId": "{string}",
"accountId": "{string}",
"workflowId": "{string}",
"accountName": "{string}",
"accountKey": "{string}",
"shareName": "{string}",
"folderLocation": "{string}"
}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Deprecated, soon to be removedDeprecated

(Deprecated - use /storage) Add an Mft storage

Auth
Request Body
ServiceUrlstring
ApiKeystring
ScanUsersstring
Namestring
GroupIdstring
AccountIdstring
WorkflowIdstring
POST /api/storage/mft
curl --request POST \
--url 'http://<MDSS_HOST>/api/storage/mft' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
storageIdstring
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"storageId": "{string}"
}
Copy

Deprecated, soon to be removedDeprecated

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

Auth
Path Params
storageIdstring
Request Body
ServiceUrlstring
ApiKeystring
ScanUsersstring
Namestring
GroupIdstring
AccountIdstring
WorkflowIdstring
PATCH /api/storage/mft/{storageId}
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/storage/mft/{storageId}' \
--form 'file=@{file}'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: Error
  • 2: InternalError
  • 3: NotFound

Enum: 0,1,2,3

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
updatedStorage
objectobject
idstring
namestring
groupIdstring
clientIdstring
accountIdstring
storageCredentialsstring
sourcestring
storageFunctionalitystring
storageType4 fieldsobject
storageStatusobject
messagestring
statusTypeinteger
  • 0: NotTested
  • 1: Testing
  • 2: Operational
  • 3: Error

Enum: 0,1,2,3

scanConfig2 fieldsobject
workflowIdstring
Response
{
"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}",
"storageFunctionality": "{string}",
"storageType": {
"name": "{string}",
"categoryType": "{integer}",
"protocolType": "{integer}",
"vendorType": "{integer}"
},
"storageStatus": {
"message": "{string}",
"statusType": "{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}"
}
}
},
"workflowId": "{string}"
}
}
Copy

Delete scan schedulesDeprecated

Auth
Path Params
storageIdstring
Request Body
arrayarray[string]
DELETE /api/storage/scan_schedule/{storageId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/storage/scan_schedule/{storageId}' \
--data '[
"{array[string]...}"
]'
Copy
Responses
200
objectobject
resultinteger
  • 0: Success
  • 1: FailedInvalidListOfIds

Enum: 0,1,2,3,0,1

responseKeystring
responseMessagestring
responseMessageParamsobject
*string
success
RestResponseRestResponse
error
RestResponseRestResponse
areAllDeletedboolean
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"success": "{RestResponse}",
"error": "{RestResponse}",
"areAllDeleted": "{boolean}"
}
Copy