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.
Useful links
Server
http://<MDSS_HOST>
Server Variables
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 APIUse 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.
Account
Manage your accounts
Fetch all accounts
Auth
GET /api/account
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/account' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| accounts | array[object] | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | |||
| object | object | ||
| message | string | ||
| statusType | int32 | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| handlingType | |||
| integer | integer |
Enum: | |
| workflowId | string | ||
| scanConfigurationId | string | ||
| priority | string | ||
| postActionsScanConfig | |||
| object | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | |||
| object | object | ||
| defaultName | string | ||
| customName | string | maxLength: 128 | |
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | maxLength: 256 | |
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | |||
| object | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | |||
| integer | integer |
Enum: | |
| moveDeleteRemediationConfig | |||
| object | object | ||
| blockedFileRemediationConfigurationStatus | integer |
Enum: | |
| sanitizedFileRemediationConfigurationStatus | integer |
Enum: | |
| allowedFileRemediationConfigurationStatus | integer |
Enum: | |
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockedFileHandlingType | |||
| integer | integer |
Enum: | |
| allowedFileHandlingType | |||
| integer | integer |
Enum: | |
| sanitizedFileHandlingType | |||
| integer | integer |
Enum: | |
| blockedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockingStrategy | |||
| integer | integer |
Enum: | |
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accounts": [ { "id": "{string}", "name": "{string}", "description": "{string}", "storages": [ { "id": "{string}", "groupId": "{string}", "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}" } ] } ]}Expand
Add an account
Auth
Query String
| Name | string | ||
| Description | string | ||
| Credentials | string | ||
| ProtocolType | |||
| AutoDiscovery | boolean | ||
| GroupId | string | ||
| StorageIds | array |
Request Body
| object | object | ||
| CredentialsFile | file |
POST /api/account
xxxxxxxxxxcurl --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}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| account | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| storageIds | array[string] |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "account": { "id": "{string}", "name": "{string}", "description": "{string}", "credentials": "{string}", "storageIds": [ "{array[string]...}" ] }}Update an account
Auth
Query String
| AccountId | string | ||
| Name | string | ||
| Description | string | ||
| Credentials | string | ||
| ProtocolType | |||
| AutoDiscovery | boolean | ||
| GroupId | string |
Request Body
| object | object | ||
| CredentialsFile | file |
PATCH /api/account
xxxxxxxxxxcurl --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}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedAccount | |||
| object | object | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| groupId | string | ||
| contentOfCredentialsFile | string |
Expand
Response
xxxxxxxxxx{ "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}" }}Fetch account by ID
Auth
Path Params
| accountId | string |
GET /api/account/{accountId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/account/%7BaccountId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | |||
| object | object | ||
| message | string | ||
| statusType | int32 | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| handlingType | |||
| integer | integer |
Enum: | |
| workflowId | string | ||
| scanConfigurationId | string | ||
| priority | string | ||
| postActionsScanConfig | |||
| object | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | |||
| object | object | ||
| defaultName | string | ||
| customName | string | maxLength: 128 | |
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | maxLength: 256 | |
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | |||
| object | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | |||
| integer | integer |
Enum: | |
| moveDeleteRemediationConfig | |||
| object | object | ||
| blockedFileRemediationConfigurationStatus | integer |
Enum: | |
| sanitizedFileRemediationConfigurationStatus | integer |
Enum: | |
| allowedFileRemediationConfigurationStatus | integer |
Enum: | |
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockedFileHandlingType | |||
| integer | integer |
Enum: | |
| allowedFileHandlingType | |||
| integer | integer |
Enum: | |
| sanitizedFileHandlingType | |||
| integer | integer |
Enum: | |
| blockedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockingStrategy | |||
| integer | integer |
Enum: | |
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "account": { "id": "{string}", "name": "{string}", "description": "{string}", "storages": [ { "id": "{string}", "groupId": "{string}", "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}" } ] }}Expand
Delete an account
Auth
Path Params
| accountId | string |
DELETE /api/account/{accountId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/account/%7BaccountId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| accountId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accountId": "{string}"}Fetch available storage units for an account
Auth
Path Params
| accountId | string |
GET /api/account/{accountId}/storages
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/account/%7BaccountId%7D/storages' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| bucketName | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "bucketName": "{string}" } ]}Fetch the number of accounts
Auth
GET /api/account/count
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/account/count' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| accountCount | |||
| object | object | ||
| count | int64 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accountCount": { "count": "{int64}" }}Audit
List audit information
Endpoints
Fetch audit logs
Auth
Path Params
| startIndex | string | ||
| count | string |
Query String
| logType | string | ||
| categoryType | string | ||
| logLevel | string | ||
| searchText | string |
GET /api/audit/{startIndex}/{count}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/audit/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}' \ --data logType={logType} \ --data categoryType={categoryType} \ --data logLevel={logLevel} \ --data searchText={searchText}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| logLevel | integer |
Enum: | |
| details | string | ||
| logType | integer |
Enum: | |
| userId | string | ||
| category | integer |
Enum: | |
| timeStamp | date-time | ||
| userName | string | ||
| filterCount | int64 | ||
| totalCount | int64 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "id": "{string}", "logLevel": "{integer}", "details": "{string}", "logType": "{integer}", "userId": "{string}", "category": "{integer}", "timeStamp": "{date-time}", "userName": "{string}" } ], "filterCount": "{int64}", "totalCount": "{int64}"}Configuration
Import or export configuration file
Export configuration file
Auth
Query String
| exportLicense | boolean | ||
| exportSmtp | boolean | ||
| exportEmailNotifications | boolean | ||
| exportRetention | boolean |
GET /api/configuration/export
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/configuration/export' \ --header 'Authorization: Bearer {token}' \ --data exportLicense={exportLicense} \ --data exportSmtp={exportSmtp} \ --data exportEmailNotifications={exportEmailNotifications} \ --data exportRetention={exportRetention}Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Import configuration file
Auth
Request Body
| object | object | ||
| ConfigurationFile | file |
POST /api/configuration/import
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/configuration/import' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| areSmtpSettingsImported | boolean | ||
| isLicenseImported | boolean | ||
| isRetentionImported | boolean | ||
| activationDto | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "areSmtpSettingsImported": "{boolean}", "isLicenseImported": "{boolean}", "isRetentionImported": "{boolean}", "activationDto": { "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}" }}Get enabled modules
Auth
GET /api/configuration/enabledModules
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/configuration/enabledModules'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| enabledModules | array[integer] |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "enabledModules": [ "{array[integer]...}" ]}Connector
Endpoints
connector
Auth
Query String
| sharePath | string | ||
| clientId | string |
GET /api/connector
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/connector' \ --header 'Authorization: Bearer {token}' \ --data sharePath={sharePath} \ --data clientId={clientId}Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Deep Cdr
Manage sanitized files
Endpoints
Revert encrypted file
Auth
Path Params
| fileId | string |
POST /api/deepcdr/revert/{fileId}
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/deepcdr/revert/%7BfileId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}External Logger
Manage external loggers
Retrieve external loggers
Auth
GET /api/externallogger
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/externallogger' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| isEnabled | boolean | ||
| loggerType | integer |
Enum: | |
| connectionSettings | |||
| object | object | ||
| $type | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "id": "{string}", "isEnabled": "{boolean}", "loggerType": "{integer}", "connectionSettings": { "$type": "{string}" } } ]}Update external logger state
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| isEnabled | boolean |
PUT /api/externallogger/status
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/externallogger/status' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "isEnabled": "{boolean}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Update a Syslog server configuration
Auth
Request Body
| object | object | ||
| isEnabled | boolean | ||
| serverAddress | string | minLength: 1 pattern: | |
| port | int32 | pattern: | |
| loggerType | integer |
Enum: | |
| facility | integer |
Enum: | |
| format | integer |
Enum: | |
| $type | string | ||
| id | string | minLength: 1 |
Expand
PUT /api/externallogger/udpSyslog
xxxxxxxxxxcurl --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}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Add a new Syslog server configuration
Auth
Request Body
| object | object | ||
| isEnabled | boolean | ||
| serverAddress | string | minLength: 1 pattern: | |
| port | int32 | pattern: | |
| loggerType | integer |
Enum: | |
| facility | integer |
Enum: | |
| format | integer |
Enum: | |
| $type | string |
Expand
POST /api/externallogger/udpSyslog
xxxxxxxxxxcurl --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}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Update a Kafka server configuration
Auth
Request Body
| object | object | ||
| isEnabled | boolean | ||
| serverAddressWithPortList | string | minLength: 1 pattern: | |
| loggerType | integer |
Enum: | |
| topic | string | minLength: 1 | |
| configuration | string | minLength: 1 | |
| $type | string | ||
| id | string | minLength: 1 |
Expand
PUT /api/externallogger/kafka
xxxxxxxxxxcurl --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}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Add a new Kafka server configuration
Auth
Request Body
| object | object | ||
| isEnabled | boolean | ||
| serverAddressWithPortList | string | minLength: 1 pattern: | |
| loggerType | integer |
Enum: | |
| topic | string | minLength: 1 | |
| configuration | string | minLength: 1 | |
| $type | string |
Expand
POST /api/externallogger/kafka
xxxxxxxxxxcurl --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}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Delete external logger
Auth
Path Params
| id | string |
DELETE /api/externallogger/{id}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/externallogger/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}File
Retrieve processed files information
Scan a file on demand
This request is used to update a scanned file with passwords, in case it is an encrypted archive andit could not be scanned because the passwords to decrypt it were not provided. It can also be used withoutproviding any passwords to simply rescan a specific file from a finished scan.
Auth
Request Body
| object | object | ||
| fileId | string | minLength: 1 | |
| scanId | string | minLength: 1 | |
| storageProtocolType | int32 | ||
| passwords | array[string] |
PUT /api/file
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/file' \ --header 'Authorization: Bearer {token}' \ --data '{ "fileId": "{string}", "scanId": "{string}", "storageProtocolType": "{int32}", "passwords": [ "{array[string]...}" ]}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Fetch processing results for a file
File processing is done asynchronously and each analysis request is tracked by a file ID. Because processing a file is a potentially time-consuming operation, scheduling a file for processing and retrieving the results needs to be done using two separate API calls.
This request needs to be made multiple times until the analysis is complete. Analysis completion can be tracked using the processingState and the progress values from the response..
Auth
Path Params
| fileId | string |
GET /api/file/{fileId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/file/%7BfileId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| id | string | ||
| scanId | string | ||
| name | string | ||
| path | string | ||
| hash | string | ||
| fileOwner | |||
| object | object | ||
| userId | string | ||
| fullName | string | ||
| userName | string | ||
| emailAddress | string | ||
| size | int64 | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageName | string | ||
| storageLocation | string | ||
| scanName | string | ||
| progress | |||
| object | object | ||
| upload | int32 | ||
| scan | int32 | ||
| scanResult | |||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesInArchive | array[object] | ||
| displayName | string | ||
| dataId | string | ||
| fileType | string | ||
| fileTypeDescription | string | ||
| scanResultI | int32 | ||
| scanAllResultI | int32 | ||
| detectedBy | int32 | ||
| scannedWith | int32 | ||
| progressPercentage | int32 | ||
| fileSize | int64 | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails | array[object] | ||
| engineName | string | ||
| threatFound | string | ||
| scanResultI | int32 | ||
| defTime | string | ||
| scanTime | number | ||
| engId | string | ||
| waitTime | number | ||
| dataId | string | ||
| scanAllResultI | int32 | ||
| scanAllResultA | string | ||
| startTime | string | ||
| totalTime | number | ||
| totalAvs | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| originalFilePath | string | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| dataId | string | ||
| dlpInfo | |||
| object | object | ||
| verdict | int64 | ||
| sbomInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| severity | integer |
Enum: | |
| totalPackageCount | int32 | ||
| verdict | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| overviewReport | |||
| object | object | ||
| isPartialReport | boolean | ||
| osInfo | object | ||
| osName | string | ||
| osVersion | string | ||
| scanMode | string | ||
| steps | array[object] | ||
| command | string | ||
| packages | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| licenses | object | ||
| allowed | array[object] | ||
| id | string | ||
| blocked | array[object] | ||
| id | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| licenseStatus | string | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| step | int32 | ||
| vulnerabilityCount | int32 | ||
| sha256 | string | ||
| severity | integer |
Enum: | |
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| packages | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| licenses | object | ||
| allowed | array[object] | ||
| id | string | ||
| blocked | array[object] | ||
| id | string | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| resultTemplateHash | string | ||
| vulnerabilityInfo | |||
| object | object | ||
| vulnerabilityInfoResult | |||
| object | object | ||
| code | int64 | ||
| hash | string | ||
| method | int64 | ||
| timeStamp | string | ||
| timing | int64 | ||
| detectedProduct | |||
| object | object | ||
| hasVulnerability | boolean | ||
| isCurrent | boolean | ||
| product | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| remediationLink | string | ||
| severity | string | ||
| sigName | string | ||
| signature | int64 | ||
| vendor | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| version | string | ||
| versionData | |||
| object | object | ||
| countBehind | int64 | ||
| feedId | int64 | ||
| version | string | ||
| vulnerabilities | array[object] | ||
| description | string | ||
| details | |||
| object | object | ||
| cpe | string | ||
| cve | string | ||
| cvss | |||
| object | object | ||
| accessComplexity | string | ||
| accessVector | string | ||
| authentication | string | ||
| availabilityImpact | string | ||
| confidentialityImpact | string | ||
| generatedOnEpoch | string | ||
| integrityImpact | string | ||
| score | string | ||
| source | string | ||
| cvss3 | |||
| object | object | ||
| attackComplexity | string | ||
| attackVector | string | ||
| availabilityImpact | string | ||
| baseScore | string | ||
| baseSeverity | string | ||
| confidentialityImpact | string | ||
| exploitabilityScore | string | ||
| impactScore | string | ||
| integrityImpact | string | ||
| privilegesRequired | string | ||
| scope | string | ||
| userInteraction | string | ||
| vectorString | string | ||
| cwe | string | ||
| lastModifiedEpoch | string | ||
| publishedEpoch | string | ||
| references | array[string] | ||
| severity | string | ||
| severityIndex | int32 | ||
| staticId | int64 | ||
| sessionCookie | string | ||
| processingState | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| created | date-time | ||
| lastModified | date-time | ||
| discoveryStarted | date-time | ||
| fileProcessingDetails | |||
| object | object | ||
| streamingStartedTime | date-time | ||
| streamingCompletedTime | date-time | ||
| streamingTimeSpanMs | int64 | ||
| scanCompletedTime | date-time | ||
| processingTimeSpanMs | int64 | ||
| coreEngines | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | |||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| isSanitized | boolean | ||
| isEncrypted | boolean | ||
| isOriginalVersionOfSanitizedFile | boolean | ||
| hasSanitizedFileBeenMoved | boolean | ||
| hasSanitizedFileBeenCopied | boolean | ||
| decryptStatus | integer |
Enum: | |
| deepCdrOriginalObjectHandlingType | integer |
Enum: | |
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| metaDefenderCoreUrl | string | ||
| discoveryStartedDaySec | int64 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "id": "{string}", "scanId": "{string}", "name": "{string}", "path": "{string}", "hash": "{string}", "fileOwner": {...}, "size": "{int64}", "storageType": {...}, "storageName": "{string}", "storageLocation": "{string}", "scanName": "{string}", "progress": {...}, "scanResult": {...}, "processingState": "{integer}", "exception": {...}, "created": "{date-time}", "lastModified": "{date-time}", "discoveryStarted": "{date-time}", "fileProcessingDetails": {...}, "coreEngines": [...], "remediation": {...}, "metaDefenderCoreUrl": "{string}", "discoveryStartedDaySec": "{int64}"}Enumerate processed files
Auth
Path Params
| scanId | string | ||
| startIndex | string | ||
| count | string |
Query String
| sorting | string | ||
| search | string | ||
| result | integer | Enum: | |
| startDate | string | ||
| endDate | string | ||
| scanWorkflowSnapshotId | string |
GET /api/file/{scanId}/{startIndex}/{count}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/file/%7BscanId%7D/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}' \ --data sorting_order={sorting_order} \ --data search={search} \ --data result={result} \ --data startDate={startDate} \ --data endDate={endDate} \ --data scanWorkflowSnapshotId={scanWorkflowSnapshotId}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| id | string | ||
| scanId | string | ||
| name | string | ||
| path | string | ||
| hash | string | ||
| fileOwner | |||
| object | object | ||
| userId | string | ||
| fullName | string | ||
| userName | string | ||
| emailAddress | string | ||
| size | int64 | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageName | string | ||
| storageLocation | string | ||
| scanName | string | ||
| progress | |||
| object | object | ||
| upload | int32 | ||
| scan | int32 | ||
| scanResult | |||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesInArchive | array[object] | ||
| displayName | string | ||
| dataId | string | ||
| fileType | string | ||
| fileTypeDescription | string | ||
| scanResultI | int32 | ||
| scanAllResultI | int32 | ||
| detectedBy | int32 | ||
| scannedWith | int32 | ||
| progressPercentage | int32 | ||
| fileSize | int64 | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails | array[object] | ||
| engineName | string | ||
| threatFound | string | ||
| scanResultI | int32 | ||
| defTime | string | ||
| scanTime | number | ||
| engId | string | ||
| waitTime | number | ||
| dataId | string | ||
| scanAllResultI | int32 | ||
| scanAllResultA | string | ||
| startTime | string | ||
| totalTime | number | ||
| totalAvs | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| originalFilePath | string | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| dataId | string | ||
| dlpInfo | |||
| object | object | ||
| verdict | int64 | ||
| sbomInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| severity | integer |
Enum: | |
| totalPackageCount | int32 | ||
| verdict | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| overviewReport | |||
| object | object | ||
| isPartialReport | boolean | ||
| osInfo | object | ||
| osName | string | ||
| osVersion | string | ||
| scanMode | string | ||
| steps | array[object] | ||
| command | string | ||
| packages | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| licenses | object | ||
| allowed | array[object] | ||
| id | string | ||
| blocked | array[object] | ||
| id | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| licenseStatus | string | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| step | int32 | ||
| vulnerabilityCount | int32 | ||
| sha256 | string | ||
| severity | integer |
Enum: | |
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| packages | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| licenses | object | ||
| allowed | array[object] | ||
| id | string | ||
| blocked | array[object] | ||
| id | string | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| resultTemplateHash | string | ||
| vulnerabilityInfo | |||
| object | object | ||
| vulnerabilityInfoResult | |||
| object | object | ||
| code | int64 | ||
| hash | string | ||
| method | int64 | ||
| timeStamp | string | ||
| timing | int64 | ||
| detectedProduct | |||
| object | object | ||
| hasVulnerability | boolean | ||
| isCurrent | boolean | ||
| product | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| remediationLink | string | ||
| severity | string | ||
| sigName | string | ||
| signature | int64 | ||
| vendor | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| version | string | ||
| versionData | |||
| object | object | ||
| countBehind | int64 | ||
| feedId | int64 | ||
| version | string | ||
| vulnerabilities | array[object] | ||
| description | string | ||
| details | |||
| object | object | ||
| cpe | string | ||
| cve | string | ||
| cvss | |||
| object | object | ||
| accessComplexity | string | ||
| accessVector | string | ||
| authentication | string | ||
| availabilityImpact | string | ||
| confidentialityImpact | string | ||
| generatedOnEpoch | string | ||
| integrityImpact | string | ||
| score | string | ||
| source | string | ||
| cvss3 | |||
| object | object | ||
| attackComplexity | string | ||
| attackVector | string | ||
| availabilityImpact | string | ||
| baseScore | string | ||
| baseSeverity | string | ||
| confidentialityImpact | string | ||
| exploitabilityScore | string | ||
| impactScore | string | ||
| integrityImpact | string | ||
| privilegesRequired | string | ||
| scope | string | ||
| userInteraction | string | ||
| vectorString | string | ||
| cwe | string | ||
| lastModifiedEpoch | string | ||
| publishedEpoch | string | ||
| references | array[string] | ||
| severity | string | ||
| severityIndex | int32 | ||
| staticId | int64 | ||
| sessionCookie | string | ||
| processingState | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| created | date-time | ||
| lastModified | date-time | ||
| discoveryStarted | date-time | ||
| fileProcessingDetails | |||
| object | object | ||
| streamingStartedTime | date-time | ||
| streamingCompletedTime | date-time | ||
| streamingTimeSpanMs | int64 | ||
| scanCompletedTime | date-time | ||
| processingTimeSpanMs | int64 | ||
| coreEngines | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | |||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| isSanitized | boolean | ||
| isEncrypted | boolean | ||
| isOriginalVersionOfSanitizedFile | boolean | ||
| hasSanitizedFileBeenMoved | boolean | ||
| hasSanitizedFileBeenCopied | boolean | ||
| decryptStatus | integer |
Enum: | |
| deepCdrOriginalObjectHandlingType | integer |
Enum: | |
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| metaDefenderCoreUrl | string | ||
| discoveryStartedDaySec | int64 | ||
| filterCount | int64 | ||
| totalCount | int64 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "id": "{string}", "scanId": "{string}", "name": "{string}", "path": "{string}", "hash": "{string}", "fileOwner": { "userId": "{string}", "fullName": "{string}", "userName": "{string}", "emailAddress": "{string}" }, "size": "{int64}" } ], "filterCount": "{int64}", "totalCount": "{int64}"}Group
Manage your groups
Fetch all groups
Auth
GET /api/group
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/group' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| groups | array[object] | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | |||
| object | object | ||
| message | string | ||
| statusType | int32 | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| handlingType | |||
| integer | integer |
Enum: | |
| workflowId | string | ||
| scanConfigurationId | string | ||
| priority | string | ||
| postActionsScanConfig | |||
| object | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | |||
| object | object | ||
| defaultName | string | ||
| customName | string | maxLength: 128 | |
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | maxLength: 256 | |
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | |||
| object | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | |||
| integer | integer |
Enum: | |
| moveDeleteRemediationConfig | |||
| object | object | ||
| blockedFileRemediationConfigurationStatus | integer |
Enum: | |
| sanitizedFileRemediationConfigurationStatus | integer |
Enum: | |
| allowedFileRemediationConfigurationStatus | integer |
Enum: | |
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockedFileHandlingType | |||
| integer | integer |
Enum: | |
| allowedFileHandlingType | |||
| integer | integer |
Enum: | |
| sanitizedFileHandlingType | |||
| integer | integer |
Enum: | |
| blockedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockingStrategy | |||
| integer | integer |
Enum: | |
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "groups": [ { "id": "{string}", "name": "{string}", "description": "{string}", "storages": [ { "id": "{string}", "groupId": "{string}", "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}" } ] } ]}Expand
Add a group
Auth
Request Body
| object | object | ||
| name | string | minLength: 1 | |
| description | string | ||
| storageIds | array[string] |
POST /api/group
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/group' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "description": "{string}", "storageIds": [ "{array[string]...}" ]}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| group | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storageIds | array[string] |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "group": { "id": "{string}", "name": "{string}", "description": "{string}", "storageIds": [ "{array[string]...}" ] }}Update a group
Auth
Request Body
| object | object | ||
| name | string | ||
| description | string | ||
| groupId | string | minLength: 1 |
PATCH /api/group
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/group' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "description": "{string}", "groupId": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedGroup | |||
| object | object | ||
| name | string | ||
| description | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedGroup": { "name": "{string}", "description": "{string}" }}Fetch group by ID
Auth
Path Params
| groupId | string |
GET /api/group/{groupId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/group/%7BgroupId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| group | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | |||
| object | object | ||
| message | string | ||
| statusType | int32 | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| handlingType | |||
| integer | integer |
Enum: | |
| workflowId | string | ||
| scanConfigurationId | string | ||
| priority | string | ||
| postActionsScanConfig | |||
| object | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | |||
| object | object | ||
| defaultName | string | ||
| customName | string | maxLength: 128 | |
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | maxLength: 256 | |
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | |||
| object | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | |||
| integer | integer |
Enum: | |
| moveDeleteRemediationConfig | |||
| object | object | ||
| blockedFileRemediationConfigurationStatus | integer |
Enum: | |
| sanitizedFileRemediationConfigurationStatus | integer |
Enum: | |
| allowedFileRemediationConfigurationStatus | integer |
Enum: | |
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockedFileHandlingType | |||
| integer | integer |
Enum: | |
| allowedFileHandlingType | |||
| integer | integer |
Enum: | |
| sanitizedFileHandlingType | |||
| integer | integer |
Enum: | |
| blockedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockingStrategy | |||
| integer | integer |
Enum: | |
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "group": { "id": "{string}", "name": "{string}", "description": "{string}", "storages": [ { "id": "{string}", "groupId": "{string}", "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}" } ] }}Expand
Delete a group
Auth
Path Params
| groupId | string |
DELETE /api/group/{groupId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/group/%7BgroupId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| groupId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "groupId": "{string}"}Fetch the number of groups
Auth
GET /api/group/count
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/group/count' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| groupCount | |||
| object | object | ||
| count | int64 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "groupCount": { "count": "{int64}" }}Health Status
API that responds with 200 OK if application is running.
Endpoints
Get health status
Auth
Query String
| verbose | boolean |
GET /api/health
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/health' \ --data verbose={verbose}Responses
200
| object | object | ||
| apiStatus | string |
Response
xxxxxxxxxx{ "apiStatus": "{string}"}Onboarding
Manage onboarding
Fetch onboarding configuration
Auth
Query String
| newConfigSetup | boolean |
GET /api/onboarding
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/onboarding' \ --data newConfigSetup={newConfigSetup}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| hasUserConfigured | boolean | ||
| hasStorageConfigured | boolean | ||
| hasScanInstanceConfigured | boolean | ||
| isOnboardingDone | boolean | ||
| isEulaAgreed | boolean | ||
| isCloudType | boolean |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "hasUserConfigured": "{boolean}", "hasStorageConfigured": "{boolean}", "hasScanInstanceConfigured": "{boolean}", "isOnboardingDone": "{boolean}", "isEulaAgreed": "{boolean}", "isCloudType": "{boolean}"}Finish onboarding
Auth
POST /api/onboarding
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/onboarding' \ --header 'Authorization: Bearer {token}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Accept Eula
Auth
POST /api/onboarding/eula
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/onboarding/eula' \ --header 'Authorization: Bearer {token}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Report
Generate reports
Endpoints
Get scans report
Auth
Query String
| storageId | string | ||
| name | string | ||
| scanTypesFilter | array | Enum: | |
| scanStatesFilter | array | Enum: | |
| startDate | string | ||
| endDate | string | ||
| sortDirectionFilter | |||
| startIndex | integer | ||
| count | integer |
GET /api/report
xxxxxxxxxxcurl --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}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | |||
| object | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | |||
| object | object | ||
| pciDssComplianceViolationsCount | int64 | ||
| hipaaComplianceViolationsCount | int64 | ||
| gdprComplianceViolationsCount | int64 | ||
| malwareSecurityAlertsCount | int64 | ||
| vulnerabilitiesSecurityAlertsCount | int64 | ||
| piiSecurityAlertsCount | int64 | ||
| pciDssComplianceViolationsPercentageIncrease | int64 | ||
| hipaaComplianceViolationsPercentageIncrease | int64 | ||
| gdprComplianceViolationsPercentageIncrease | int64 | ||
| malwareSecurityAlertsPercentageIncrease | int64 | ||
| vulnerabilitiesSecurityAlertsPercentageIncrease | int64 | ||
| piiSecurityAlertsPercentageIncrease | int64 | ||
| highRiskAccounts | array[object] | ||
| id | string | ||
| displayName | string | ||
| blockedFilesCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] | ||
| totalCount | int64 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "id": "{string}", "name": "{string}", "startTime": "{date-time}", "stopTime": "{date-time}", "scanType": "{string}", "scanningState": "{integer}", "scanStatusDto": { "pendingFilesCount": "{int64}", "allowedFilesCount": "{int64}", "blockedFilesCount": "{int64}", "totalFilesCount": "{int64}", "processingFailedCount": "{int64}", "processedFilesCount": "{int64}" }, "scanStatsDto": { "pciDssComplianceViolationsCount": "{int64}", "hipaaComplianceViolationsCount": "{int64}", "gdprComplianceViolationsCount": "{int64}", "malwareSecurityAlertsCount": "{int64}", "vulnerabilitiesSecurityAlertsCount": "{int64}", "piiSecurityAlertsCount": "{int64}", "pciDssComplianceViolationsPercentageIncrease": "{int64}", "hipaaComplianceViolationsPercentageIncrease": "{int64}", "gdprComplianceViolationsPercentageIncrease": "{int64}", "malwareSecurityAlertsPercentageIncrease": "{int64}", "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}", "piiSecurityAlertsPercentageIncrease": "{int64}", "highRiskAccounts": [ { "id": "{string}", "displayName": "{string}", "blockedFilesCount": "{int64}" } ] }, "scanSequenceDto": { "previousScanId": "{string}", "nextScanId": "{string}" }, "workflowId": "{string}", "scanConfigurationId": "{string}", "errors": [ "{array[string]...}" ] } ], "totalCount": "{int64}"}Expand
Get scan by ID
Auth
Path Params
| scanId | string |
GET /api/scan/{scanId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scan/%7BscanId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | |||
| object | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | |||
| object | object | ||
| pciDssComplianceViolationsCount | int64 | ||
| hipaaComplianceViolationsCount | int64 | ||
| gdprComplianceViolationsCount | int64 | ||
| malwareSecurityAlertsCount | int64 | ||
| vulnerabilitiesSecurityAlertsCount | int64 | ||
| piiSecurityAlertsCount | int64 | ||
| pciDssComplianceViolationsPercentageIncrease | int64 | ||
| hipaaComplianceViolationsPercentageIncrease | int64 | ||
| gdprComplianceViolationsPercentageIncrease | int64 | ||
| malwareSecurityAlertsPercentageIncrease | int64 | ||
| vulnerabilitiesSecurityAlertsPercentageIncrease | int64 | ||
| piiSecurityAlertsPercentageIncrease | int64 | ||
| highRiskAccounts | array[object] | ||
| id | string | ||
| displayName | string | ||
| blockedFilesCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scan": { "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "id": "{string}", "name": "{string}", "startTime": "{date-time}", "stopTime": "{date-time}", "scanType": "{string}", "scanningState": "{integer}", "scanStatusDto": { "pendingFilesCount": "{int64}", "allowedFilesCount": "{int64}", "blockedFilesCount": "{int64}", "totalFilesCount": "{int64}", "processingFailedCount": "{int64}", "processedFilesCount": "{int64}" }, "scanStatsDto": { "pciDssComplianceViolationsCount": "{int64}", "hipaaComplianceViolationsCount": "{int64}", "gdprComplianceViolationsCount": "{int64}", "malwareSecurityAlertsCount": "{int64}", "vulnerabilitiesSecurityAlertsCount": "{int64}", "piiSecurityAlertsCount": "{int64}", "pciDssComplianceViolationsPercentageIncrease": "{int64}", "hipaaComplianceViolationsPercentageIncrease": "{int64}", "gdprComplianceViolationsPercentageIncrease": "{int64}", "malwareSecurityAlertsPercentageIncrease": "{int64}", "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}", "piiSecurityAlertsPercentageIncrease": "{int64}", "highRiskAccounts": [ { "id": "{string}", "displayName": "{string}", "blockedFilesCount": "{int64}" } ] }, "scanSequenceDto": { "previousScanId": "{string}", "nextScanId": "{string}" }, "workflowId": "{string}", "scanConfigurationId": "{string}", "errors": [ "{array[string]...}" ] }}Expand
Get scan by ID with information regarding the previous and next scan
Auth
Path Params
| scanId | string |
Query String
| scanTypesFilter | array | Enum: | |
| scanStatesFilter | array | Enum: |
GET /api/scan/sequence/{scanId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scan/sequence/%7BscanId%7D' \ --header 'Authorization: Bearer {token}' \ --data scanTypesFilter={scanTypesFilter} \ --data scanStatesFilter={scanStatesFilter}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | |||
| object | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | |||
| object | object | ||
| pciDssComplianceViolationsCount | int64 | ||
| hipaaComplianceViolationsCount | int64 | ||
| gdprComplianceViolationsCount | int64 | ||
| malwareSecurityAlertsCount | int64 | ||
| vulnerabilitiesSecurityAlertsCount | int64 | ||
| piiSecurityAlertsCount | int64 | ||
| pciDssComplianceViolationsPercentageIncrease | int64 | ||
| hipaaComplianceViolationsPercentageIncrease | int64 | ||
| gdprComplianceViolationsPercentageIncrease | int64 | ||
| malwareSecurityAlertsPercentageIncrease | int64 | ||
| vulnerabilitiesSecurityAlertsPercentageIncrease | int64 | ||
| piiSecurityAlertsPercentageIncrease | int64 | ||
| highRiskAccounts | array[object] | ||
| id | string | ||
| displayName | string | ||
| blockedFilesCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scan": { "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "id": "{string}", "name": "{string}", "startTime": "{date-time}", "stopTime": "{date-time}", "scanType": "{string}", "scanningState": "{integer}", "scanStatusDto": { "pendingFilesCount": "{int64}", "allowedFilesCount": "{int64}", "blockedFilesCount": "{int64}", "totalFilesCount": "{int64}", "processingFailedCount": "{int64}", "processedFilesCount": "{int64}" }, "scanStatsDto": { "pciDssComplianceViolationsCount": "{int64}", "hipaaComplianceViolationsCount": "{int64}", "gdprComplianceViolationsCount": "{int64}", "malwareSecurityAlertsCount": "{int64}", "vulnerabilitiesSecurityAlertsCount": "{int64}", "piiSecurityAlertsCount": "{int64}", "pciDssComplianceViolationsPercentageIncrease": "{int64}", "hipaaComplianceViolationsPercentageIncrease": "{int64}", "gdprComplianceViolationsPercentageIncrease": "{int64}", "malwareSecurityAlertsPercentageIncrease": "{int64}", "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}", "piiSecurityAlertsPercentageIncrease": "{int64}", "highRiskAccounts": [ { "id": "{string}", "displayName": "{string}", "blockedFilesCount": "{int64}" } ] }, "scanSequenceDto": { "previousScanId": "{string}", "nextScanId": "{string}" }, "workflowId": "{string}", "scanConfigurationId": "{string}", "errors": [ "{array[string]...}" ] }}Expand
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
| object | object | ||
| storageId | string | Deprecated | |
| name | string | minLength: 1 | |
| folder | string | ||
| storageIds | array[string] | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string |
POST /api/scan/start
xxxxxxxxxxcurl --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}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| scanId | string | ||
| scanIds | array[string] |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scanId": "{string}", "scanIds": [ "{array[string]...}" ]}Stop a scan
Auth
Path Params
| scanId | string |
POST /api/scan/stop/{scanId}
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/scan/stop/%7BscanId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Get next scheduled scan
Auth
Path Params
| storageId | string |
GET /api/scan/scheduled/{storageId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scan/scheduled/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| nextScheduledScan | |||
| object | object | ||
| id | string | ||
| name | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| type | string | ||
| createdAt | date-time | ||
| lastScanTime | date-time | ||
| nextScanTime | date-time | ||
| recurrencePatternDto | |||
| object | object | ||
| hourlyRecurrenceDto | |||
| object | object | ||
| everyNumberOfHours | int32 | ||
| dailyRecurrenceDto | |||
| object | object | ||
| everyNumberOfDays | int32 | ||
| weeklyRecurrenceDto | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrenceDto | |||
| object | object | ||
| everyNumberOfMonths | int32 | ||
| dayOfMonth | int32 | ||
| createdBy | string | ||
| scheduledScansCount | int32 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "nextScheduledScan": { "id": "{string}", "name": "{string}", "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}"}Delete scans
Auth
Path Params
| storageId | string |
Request Body
| array | array[string] |
DELETE /api/scan/{storageId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/scan/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '[ "{array[string]...}"]'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| deletedScans | array[object] | ||
| id | string | ||
| storageId | string | ||
| scanScheduleId | string | ||
| name | string | ||
| userId | string | ||
| discoveryState | integer |
Enum: | |
| scanningState | integer |
Enum: | |
| scanType | integer |
Enum: | |
| startTime | date-time | ||
| scanStats | object | ||
| pciDssComplianceViolationsCount | int64 | ||
| hipaaComplianceViolationsCount | int64 | ||
| gdprComplianceViolationsCount | int64 | ||
| malwareSecurityAlertsCount | int64 | ||
| vulnerabilitiesSecurityAlertsCount | int64 | ||
| piiSecurityAlertsCount | int64 | ||
| pciDssComplianceViolationsPercentageIncrease | int64 | ||
| hipaaComplianceViolationsPercentageIncrease | int64 | ||
| gdprComplianceViolationsPercentageIncrease | int64 | ||
| malwareSecurityAlertsPercentageIncrease | int64 | ||
| vulnerabilitiesSecurityAlertsPercentageIncrease | int64 | ||
| piiSecurityAlertsPercentageIncrease | int64 | ||
| highRiskAccounts | array[object] | ||
| id | string | ||
| displayName | string | ||
| blockedFilesCount | int64 | ||
| totalStatisticsObjectsCount | int64 | ||
| stopTime | date-time | ||
| workflowId | string | ||
| executionId | string | ||
| errors | array[string] | ||
| priority | integer |
Enum: | |
| additionalPropertiesString | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "deletedScans": [ { "id": "{string}", "storageId": "{string}", "scanScheduleId": "{string}", "name": "{string}", "userId": "{string}", "discoveryState": "{integer}", "scanningState": "{integer}", "scanType": "{integer}", "startTime": "{date-time}", "scanStats": { "pciDssComplianceViolationsCount": "{int64}", "hipaaComplianceViolationsCount": "{int64}", "gdprComplianceViolationsCount": "{int64}", "malwareSecurityAlertsCount": "{int64}", "vulnerabilitiesSecurityAlertsCount": "{int64}", "piiSecurityAlertsCount": "{int64}", "pciDssComplianceViolationsPercentageIncrease": "{int64}", "hipaaComplianceViolationsPercentageIncrease": "{int64}", "gdprComplianceViolationsPercentageIncrease": "{int64}", "malwareSecurityAlertsPercentageIncrease": "{int64}", "vulnerabilitiesSecurityAlertsPercentageIncrease": "{int64}", "piiSecurityAlertsPercentageIncrease": "{int64}", "highRiskAccounts": [ { "id": "{string}", "displayName": "{string}", "blockedFilesCount": "{int64}" } ], "totalStatisticsObjectsCount": "{int64}" }, "stopTime": "{date-time}", "workflowId": "{string}", "executionId": "{string}", "errors": [ "{array[string]...}" ], "priority": "{integer}", "additionalPropertiesString": "{string}" } ]}Expand
Scan Instance
List, add, update and delete Scan Instances
Get Scan Instances
Auth
Query String
| scanPoolId | string |
GET /api/scaninstance
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scaninstance' \ --header 'Authorization: Bearer {token}' \ --data scanPoolId={scanPoolId}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ]}Update an existing Scan Instance
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| url | string | pattern: | |
| apiKey | string | ||
| timeout | string |
PUT /api/scaninstance
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/scaninstance' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Add a new Scan Instance
Auth
Request Body
| object | object | ||
| scanPoolId | string | minLength: 1 | |
| url | string | minLength: 1 pattern: | |
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
POST /api/scaninstance
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/scaninstance' \ --header 'Authorization: Bearer {token}' \ --data '{ "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| scanInstanceId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scanInstanceId": "{string}"}Get Scan Instance by ID
Auth
Path Params
| id | string |
GET /api/scaninstance/{id}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scaninstance/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entry | |||
| object | object | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entry": { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" }}Delete a Scan Instance
Auth
Path Params
| id | string |
DELETE /api/scaninstance/{id}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/scaninstance/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Test
Auth
Request Body
| object | object | ||
| url | string | minLength: 1 | |
| rules | array[string] | ||
| apiKey | string | ||
| userAgent | string |
POST /api/scaninstance/Test
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/scaninstance/Test' \ --header 'Authorization: Bearer {token}' \ --data '{ "url": "{string}", "rules": [ "{array[string]...}" ], "apiKey": "{string}", "userAgent": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Scan Pool
List, add, update and delete Scan Pools
Get Scan Pools
Auth
GET /api/scanpool
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scanpool' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] } ]}Update an existing Scan Pool
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| name | string | maxLength: 30 minLength: 3 |
PUT /api/scanpool
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/scanpool' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "name": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Add a new Scan Pool
Auth
Request Body
| object | object | ||
| name | string | maxLength: 30 minLength: 3 | |
| scanPoolType | integer |
Enum: |
POST /api/scanpool
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/scanpool' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "scanPoolType": "{integer}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| scanPoolId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scanPoolId": "{string}"}Get Scan Pool by ID
Auth
Path Params
| id | string |
GET /api/scanpool/{id}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scanpool/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entry | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entry": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] }}Delete a Scan Pool
Auth
Path Params
| id | string |
DELETE /api/scanpool/{id}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/scanpool/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Scan Workflow Snapshot
List scan workflow snapshots
Get all scan workflow snapshots by scan ID
Auth
Path Params
| scanId | string |
GET /api/scanworkflowsnapshot/getAllFromScan/{scanId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scanworkflowsnapshot/getAllFromScan/%7BscanId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| scanWorkflowSnapshots | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | |||
| object | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| name | string | ||
| userAgent | string | ||
| scanPool | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 |
Expand
Response
xxxxxxxxxx{ "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}" } ]}Expand
Security Checklist
Manage security checklist
Fetch storage security checklist
Auth
Path Params
| storageId | string |
GET /api/security-checklist/{storageId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| items | array[object] | ||
| id | string | ||
| title | integer |
Enum: | |
| status | integer |
Enum: | |
| priority | integer |
Enum: | |
| isEnabled | boolean | ||
| howToFixLink | string | ||
| failureReason | string | ||
| lastUpdateTime | date-time | ||
| score | number | ||
| isEnabled | boolean |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "items": [ { "id": "{string}", "title": "{integer}", "status": "{integer}", "priority": "{integer}", "isEnabled": "{boolean}", "howToFixLink": "{string}", "failureReason": "{string}" } ], "lastUpdateTime": "{date-time}", "score": "{number}", "isEnabled": "{boolean}"}Fetch security checklist details
Auth
Path Params
| storageId | string |
GET /api/security-checklist/{storageId}/info
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D/info' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| score | number | ||
| resolvedItemsCount | int32 | ||
| enabledItemsCount | int32 | ||
| isEnabled | boolean |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "score": "{number}", "resolvedItemsCount": "{int32}", "enabledItemsCount": "{int32}", "isEnabled": "{boolean}"}Update security checklist item
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| isEnabled | boolean |
PUT /api/security-checklist/{storageId}/item
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D/item' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "isEnabled": "{boolean}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| item | |||
| object | object | ||
| id | string | ||
| title | integer |
Enum: | |
| status | integer |
Enum: | |
| priority | integer |
Enum: | |
| isEnabled | boolean | ||
| howToFixLink | string | ||
| failureReason | string | ||
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "item": {...}, "storage": {...}}Verify the security checklist for storage
Auth
Path Params
| storageId | string |
PUT /api/security-checklist/{storageId}/verify
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D/verify' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Enable/Disable the security checklist
Auth
Request Body
| object | object | ||
| storageId | string | minLength: 1 | |
| isEnabled | boolean |
PATCH /api/security-checklist
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/security-checklist' \ --header 'Authorization: Bearer {token}' \ --data '{ "storageId": "{string}", "isEnabled": "{boolean}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string | ||
| isEnabled | boolean |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}"}Expand
Enable all security checklist items
Auth
Path Params
| storageId | string |
PUT /api/security-checklist/{storageId}/enable-all
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/security-checklist/%7BstorageId%7D/enable-all' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Settings
List or update your settings
Endpoints
Get notifications configuration
Auth
GET /api/settings/notifications
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/settings/notifications' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| emailNotificationsConfig | |||
| object | object | ||
| generatedReportNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| userRequestNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| blockedFileNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| webhookNotificationsConfig | |||
| object | object | ||
| scanCompletedNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| destinationAddress | string | ||
| headers | object | ||
| * | string | ||
| requestType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "emailNotificationsConfig": { "generatedReportNotificationsConfig": { "isEnabled": "{boolean}", "recipientsType": "{integer}" }, "userRequestNotificationsConfig": { "isEnabled": "{boolean}" }, "blockedFileNotificationsConfig": { "isEnabled": "{boolean}", "recipientsType": "{integer}" } }, "webhookNotificationsConfig": { "scanCompletedNotificationsConfig": { "isEnabled": "{boolean}", "destinationAddress": "{string}", "headers": {}, "requestType": "{integer}" } }}Update notifications configuration
Auth
Request Body
| object | object | ||
| emailNotificationsConfig | |||
| object | object | ||
| generatedReportNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| userRequestNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| blockedFileNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| webhookNotificationsConfig | |||
| object | object | ||
| scanCompletedNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| destinationAddress | string | ||
| headers | object | ||
| * | string | ||
| requestType | integer |
Enum: |
Expand
PUT /api/settings/notifications
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/settings/notifications' \ --header 'Authorization: Bearer {token}' \ --data '{ "emailNotificationsConfig": { "generatedReportNotificationsConfig": { "isEnabled": "{boolean}", "recipientsType": "{integer}" }, "userRequestNotificationsConfig": { "isEnabled": "{boolean}" }, "blockedFileNotificationsConfig": { "isEnabled": "{boolean}", "recipientsType": "{integer}" } }, "webhookNotificationsConfig": { "scanCompletedNotificationsConfig": { "isEnabled": "{boolean}", "destinationAddress": "{string}", "headers": {}, "requestType": "{integer}" } }}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| newNotificationsConfig | |||
| object | object | ||
| id | string | ||
| emailNotificationsConfig | object | ||
| userRequestNotificationsConfig | object | ||
| isEnabled | boolean | ||
| generatedReportNotificationsConfig | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| blockedFileNotificationsConfig | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| webhookNotificationsConfig | object | ||
| scanCompletedNotificationsConfig | object | ||
| isEnabled | boolean | ||
| destinationAddress | string | ||
| headers | object | ||
| * | string | ||
| requestType | integer |
Enum: | |
| initialNotificationsConfig | |||
| object | object | ||
| id | string | ||
| emailNotificationsConfig | object | ||
| userRequestNotificationsConfig | object | ||
| isEnabled | boolean | ||
| generatedReportNotificationsConfig | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| blockedFileNotificationsConfig | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| webhookNotificationsConfig | object | ||
| scanCompletedNotificationsConfig | object | ||
| isEnabled | boolean | ||
| destinationAddress | string | ||
| headers | object | ||
| * | string | ||
| requestType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "newNotificationsConfig": { "id": "{string}", "emailNotificationsConfig": { "userRequestNotificationsConfig": { "isEnabled": "{boolean}" }, "generatedReportNotificationsConfig": { "isEnabled": "{boolean}", "recipientsType": "{integer}" }, "blockedFileNotificationsConfig": { "isEnabled": "{boolean}", "recipientsType": "{integer}" } }, "webhookNotificationsConfig": { "scanCompletedNotificationsConfig": { "isEnabled": "{boolean}", "destinationAddress": "{string}", "headers": {}, "requestType": "{integer}" } } }, "initialNotificationsConfig": { "id": "{string}", "emailNotificationsConfig": { "userRequestNotificationsConfig": { "isEnabled": "{boolean}" }, "generatedReportNotificationsConfig": { "isEnabled": "{boolean}", "recipientsType": "{integer}" }, "blockedFileNotificationsConfig": { "isEnabled": "{boolean}", "recipientsType": "{integer}" } }, "webhookNotificationsConfig": { "scanCompletedNotificationsConfig": { "isEnabled": "{boolean}", "destinationAddress": "{string}", "headers": {}, "requestType": "{integer}" } } }}Expand
Fetch SMTP configuration
Auth
GET /api/settings/smtp
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/settings/smtp' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| host | string | ||
| port | int32 | ||
| baseUrl | string | ||
| senderAddress | string | ||
| senderName | string | maxLength: 320 | |
| domain | string | ||
| username | string | ||
| password | string | ||
| secureSocketOption | |||
| integer | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean |
Response
xxxxxxxxxx{ "host": "{string}", "port": "{int32}", "baseUrl": "{string}", "senderAddress": "{string}", "senderName": "{string}", "domain": "{string}", "username": "{string}", "password": "{string}", "secureSocketOption": "{integer}", "ignoreCertWarnings": "{boolean}", "isSmtpEnabled": "{boolean}"}Update SMTP configuration
Auth
Request Body
| object | object | ||
| host | string | ||
| port | int32 | ||
| baseUrl | string | ||
| senderAddress | string | ||
| senderName | string | maxLength: 320 | |
| domain | string | ||
| username | string | ||
| password | string | ||
| secureSocketOption | |||
| integer | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean |
PATCH /api/settings/smtp
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/settings/smtp' \ --header 'Authorization: Bearer {token}' \ --data '{ "host": "{string}", "port": "{int32}", "baseUrl": "{string}", "senderAddress": "{string}", "senderName": "{string}", "domain": "{string}", "username": "{string}", "password": "{string}", "secureSocketOption": "{integer}", "ignoreCertWarnings": "{boolean}", "isSmtpEnabled": "{boolean}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| newSmtpConfig | |||
| object | object | ||
| id | string | ||
| host | string | ||
| baseUrl | string | ||
| port | int32 | ||
| senderAddress | string | ||
| senderName | string | ||
| domain | string | ||
| username | string | ||
| password | string | ||
| secureSocketOption | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean | ||
| oldSmtpConfig | |||
| object | object | ||
| id | string | ||
| host | string | ||
| baseUrl | string | ||
| port | int32 | ||
| senderAddress | string | ||
| senderName | string | ||
| domain | string | ||
| username | string | ||
| password | string | ||
| secureSocketOption | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "newSmtpConfig": { "id": "{string}", "host": "{string}", "baseUrl": "{string}", "port": "{int32}", "senderAddress": "{string}", "senderName": "{string}", "domain": "{string}", "username": "{string}", "password": "{string}", "secureSocketOption": "{integer}", "ignoreCertWarnings": "{boolean}", "isSmtpEnabled": "{boolean}" }, "oldSmtpConfig": { "id": "{string}", "host": "{string}", "baseUrl": "{string}", "port": "{int32}", "senderAddress": "{string}", "senderName": "{string}", "domain": "{string}", "username": "{string}", "password": "{string}", "secureSocketOption": "{integer}", "ignoreCertWarnings": "{boolean}", "isSmtpEnabled": "{boolean}" }}Online license activation
Auth
Request Body
| object | object | ||
| key | string | minLength: 1 |
POST /api/settings/admin/license/activate/online
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/settings/admin/license/activate/online' \ --header 'Authorization: Bearer {token}' \ --data '{ "key": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Offline license activation
Auth
Request Body
| object | object | ||
| LicenseContent | file |
POST /api/settings/admin/license/activate/offline
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/settings/admin/license/activate/offline' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Get license details
Auth
GET /api/settings/admin/license
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/settings/admin/license' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| apiStatus | string |
Response
xxxxxxxxxx{ "apiStatus": "{string}"}Deactivate license
Auth
POST /api/settings/admin/license/deactivate
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/settings/admin/license/deactivate' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Fetch retention configuration
Auth
GET /api/settings/retention
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/settings/retention' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| retentionAuditDays | int32 | ||
| reportRetentionConfiguration | |||
| object | object | ||
| isEnabled | boolean | ||
| retentionDays | int32 | ||
| rtpHistoryRetentionConfiguration | |||
| object | object | ||
| isEnabled | boolean | ||
| retentionDays | int32 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "retentionAuditDays": "{int32}", "reportRetentionConfiguration": { "isEnabled": "{boolean}", "retentionDays": "{int32}" }, "rtpHistoryRetentionConfiguration": { "isEnabled": "{boolean}", "retentionDays": "{int32}" }}Update retention configuration
Auth
Request Body
| object | object | ||
| retentionAuditDays | int32 | maximum: 50000 minimum: 1 | |
| reportRetention | object | ||
| isEnabled | boolean | ||
| retentionDays | int32 | maximum: 50000 minimum: 1 | |
| rtpHistoryRetention | object | ||
| isEnabled | boolean | ||
| retentionDays | int32 | maximum: 50000 minimum: 1 |
PUT /api/settings/retention
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/settings/retention' \ --header 'Authorization: Bearer {token}' \ --data '{ "retentionAuditDays": "{int32}", "reportRetention": { "isEnabled": "{boolean}", "retentionDays": "{int32}" }, "rtpHistoryRetention": { "isEnabled": "{boolean}", "retentionDays": "{int32}" }}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Sso
Sso Authentication and Sso configuration update
Get Sso Configuration
Auth
GET /api/sso/config
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/sso/config' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| clientId | string | ||
| authority | string | ||
| baseUrl | string | ||
| isEnabled | boolean | ||
| ssoType | integer |
Enum: | |
| ssoProvider | integer |
Enum: | |
| identityProviderIssuer | string | ||
| identityProviderLoginUrl | string | ||
| identityProviderLogoutUrl | string | ||
| administratorRoleName | string | ||
| readonlyRoleName | string | ||
| ssoConfig | |||
| object | object | ||
| id | string | ||
| isEnabled | boolean | ||
| ssoProvider | integer |
Enum: | |
| ssoType | integer |
Enum: | |
| baseUrl | string | ||
| clientId | string | ||
| clientSecret | string | ||
| authority | string | ||
| identityProviderCertificate | string | ||
| identityProviderIssuer | string | ||
| loginUrl | string | ||
| logoutUrl | string | ||
| administratorRoleName | string | ||
| readonlyRoleName | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "clientId": "{string}", "authority": "{string}", "baseUrl": "{string}", "isEnabled": "{boolean}", "ssoType": "{integer}", "ssoProvider": "{integer}", "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}" }}Update Sso Configuration
Auth
Request Body
| object | object | ||
| clientId | string | maxLength: 255 | |
| clientSecret | string | maxLength: 255 | |
| authority | string | maxLength: 255 | |
| baseUrl | string | maxLength: 255 | |
| identityProviderCertificate | object | ||
| content | string | ||
| identityProviderIssuer | string | maxLength: 255 | |
| identityProviderLoginUrl | string | maxLength: 255 | |
| identityProviderLogoutUrl | string | maxLength: 255 | |
| isEnabled | boolean | ||
| ssoType | int32 | ||
| ssoProvider | int32 | ||
| administratorRoleName | string | maxLength: 63 | |
| readonlyRoleName | string | maxLength: 63 |
PATCH /api/sso
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/sso' \ --header 'Authorization: Bearer {token}' \ --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}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| clientId | string | ||
| authority | string | ||
| baseUrl | string | ||
| isEnabled | boolean | ||
| ssoType | integer |
Enum: | |
| ssoProvider | integer |
Enum: | |
| identityProviderIssuer | string | ||
| identityProviderLoginUrl | string | ||
| identityProviderLogoutUrl | string | ||
| administratorRoleName | string | ||
| readonlyRoleName | string | ||
| ssoConfig | |||
| object | object | ||
| id | string | ||
| isEnabled | boolean | ||
| ssoProvider | integer |
Enum: | |
| ssoType | integer |
Enum: | |
| baseUrl | string | ||
| clientId | string | ||
| clientSecret | string | ||
| authority | string | ||
| identityProviderCertificate | string | ||
| identityProviderIssuer | string | ||
| loginUrl | string | ||
| logoutUrl | string | ||
| administratorRoleName | string | ||
| readonlyRoleName | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "clientId": "{string}", "authority": "{string}", "baseUrl": "{string}", "isEnabled": "{boolean}", "ssoType": "{integer}", "ssoProvider": "{integer}", "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}" }}Storage
Manage your storage units
Endpoints
Fetch all storage units
Auth
GET /api/storage/all
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/storage/all' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | |||
| object | object | ||
| message | string | ||
| statusType | int32 | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| handlingType | |||
| integer | integer |
Enum: | |
| workflowId | string | ||
| scanConfigurationId | string | ||
| priority | string | ||
| postActionsScanConfig | |||
| object | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | |||
| object | object | ||
| defaultName | string | ||
| customName | string | maxLength: 128 | |
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | maxLength: 256 | |
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | |||
| object | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | |||
| integer | integer |
Enum: | |
| moveDeleteRemediationConfig | |||
| object | object | ||
| blockedFileRemediationConfigurationStatus | integer |
Enum: | |
| sanitizedFileRemediationConfigurationStatus | integer |
Enum: | |
| allowedFileRemediationConfigurationStatus | integer |
Enum: | |
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockedFileHandlingType | |||
| integer | integer |
Enum: | |
| allowedFileHandlingType | |||
| integer | integer |
Enum: | |
| sanitizedFileHandlingType | |||
| integer | integer |
Enum: | |
| blockedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockingStrategy | |||
| integer | integer |
Enum: | |
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "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}" } ]}Expand
Fetch storage by ID
Auth
Path Params
| storageId | string |
GET /api/storage/{storageId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storage | |||
| object | object | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | |||
| object | object | ||
| message | string | ||
| statusType | int32 | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| handlingType | |||
| integer | integer |
Enum: | |
| workflowId | string | ||
| scanConfigurationId | string | ||
| priority | string | ||
| postActionsScanConfig | |||
| object | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | |||
| object | object | ||
| defaultName | string | ||
| customName | string | maxLength: 128 | |
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | maxLength: 256 | |
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | |||
| object | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | |||
| integer | integer |
Enum: | |
| moveDeleteRemediationConfig | |||
| object | object | ||
| blockedFileRemediationConfigurationStatus | integer |
Enum: | |
| sanitizedFileRemediationConfigurationStatus | integer |
Enum: | |
| allowedFileRemediationConfigurationStatus | integer |
Enum: | |
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockedFileHandlingType | |||
| integer | integer |
Enum: | |
| allowedFileHandlingType | |||
| integer | integer |
Enum: | |
| sanitizedFileHandlingType | |||
| integer | integer |
Enum: | |
| blockedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockingStrategy | |||
| integer | integer |
Enum: | |
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "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}" }}Expand
Delete a storage
Auth
Path Params
| storageId | string |
DELETE /api/storage/{storageId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Update a storage
Note! The following are templates for what is expected in the Credentials, CredentialsFile and Source fields. Please provide the correct values for your storage integration instead of null/false
Alibaba Cloud storage units:
Credentials: "{"Endpoint":null,"AccessKeyId":null,"AccessKeySecret":null,"UseRamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Amazon S3 / S3 Compatible storage units:
Credentials: "{"ServiceUrl":null,"AccessKeyId":null,"SecretAccessKey":null,"RegionEndpoint":null,"AssumeRoleArn":null,"UseIamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Azure Blob storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null,"StorageAccount":null}"
Source: "{"Container":null}"
Azure Files storage units:
Credentials: "{"AccountName":null,"AccountKey":null,"ShareName":null}"
Source: "{"FolderLocation":null}"
Box storage units:
CredentialsFile: upload the credentials file
Source: "{"FolderLocation":null}"
Dell Isilon / SMB Compatible storage units:
Credentials: "{"User":null,"Password":null,"Server":null}"
Source: "{"SharePath":null}"
Google Cloud storage units:
CredentialsFile: upload the credentials file
Credentials: "{"UseAdc":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
OneDrive storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null}"
Source: "{"Group":null}"
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| Name | string | ||
| StorageVendorType | string | ||
| StorageProtocolType | string | ||
| CredentialsFile | file | ||
| Credentials | string | ||
| Source | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string |
PATCH /api/storage/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Fetch storage users
Auth
Path Params
| storageId | string |
Query String
| filter | string |
GET /api/storage/{storageId}/users
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/users' \ --header 'Authorization: Bearer {token}' \ --data filter={filter}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| fullName | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "id": "{string}", "fullName": "{string}" } ]}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
| object | object | ||
| Name | string | ||
| StorageVendorType | string | ||
| StorageProtocolType | string | ||
| CredentialsFile | file | ||
| Credentials | string | ||
| Source | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string |
POST /api/storage
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Fetch all storage units by filters (storage type or status)
Auth
Path Params
| startIndex | string | ||
| count | string |
Query String
| sortingOrder | string | ||
| search | string | ||
| storageType | integer | ||
| storageStatus | integer |
GET /api/storage/enumerate/{startIndex}/{count}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/storage/enumerate/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}' \ --data sortingOrder={sortingOrder} \ --data search={search} \ --data storageType={storageType} \ --data storageStatus={storageStatus}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | |||
| object | object | ||
| message | string | ||
| statusType | int32 | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| handlingType | |||
| integer | integer |
Enum: | |
| workflowId | string | ||
| scanConfigurationId | string | ||
| priority | string | ||
| postActionsScanConfig | |||
| object | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | |||
| object | object | ||
| defaultName | string | ||
| customName | string | maxLength: 128 | |
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | maxLength: 256 | |
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | |||
| object | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | |||
| integer | integer |
Enum: | |
| moveDeleteRemediationConfig | |||
| object | object | ||
| blockedFileRemediationConfigurationStatus | integer |
Enum: | |
| sanitizedFileRemediationConfigurationStatus | integer |
Enum: | |
| allowedFileRemediationConfigurationStatus | integer |
Enum: | |
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockedFileHandlingType | |||
| integer | integer |
Enum: | |
| allowedFileHandlingType | |||
| integer | integer |
Enum: | |
| sanitizedFileHandlingType | |||
| integer | integer |
Enum: | |
| blockedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockingStrategy | |||
| integer | integer |
Enum: | |
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "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}" } ]}Expand
Update scan configuration
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| handlingType | |||
| integer | integer |
Enum: | |
| workflowId | string | ||
| scanConfigurationId | string | ||
| priority | string | ||
| postActionsScanConfig | |||
| object | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | |||
| object | object | ||
| defaultName | string | ||
| customName | string | maxLength: 128 | |
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | maxLength: 256 | |
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | |||
| object | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | |||
| integer | integer |
Enum: | |
| moveDeleteRemediationConfig | |||
| object | object | ||
| blockedFileRemediationConfigurationStatus | integer |
Enum: | |
| sanitizedFileRemediationConfigurationStatus | integer |
Enum: | |
| allowedFileRemediationConfigurationStatus | integer |
Enum: | |
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockedFileHandlingType | |||
| integer | integer |
Enum: | |
| allowedFileHandlingType | |||
| integer | integer |
Enum: | |
| sanitizedFileHandlingType | |||
| integer | integer |
Enum: | |
| blockedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileStorageConfig | |||
| object | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockingStrategy | |||
| integer | integer |
Enum: |
Expand
PATCH /api/storage/{storageId}/scan_config
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/scan_config' \ --header 'Authorization: Bearer {token}' \ --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}" } }}'Expand
Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Add a scan schedule
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | minLength: 1 | |
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| recurrencePattern | |||
| object | object | ||
| type | string | ||
| hourlyRecurrence | |||
| object | object | ||
| everyNumberOfHours | int32 | maximum: 24 minimum: 1 | |
| dailyRecurrence | |||
| object | object | ||
| everyNumberOfDays | int32 | maximum: 365 minimum: 1 | |
| weeklyRecurrence | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrence | |||
| object | object | ||
| everyNumberOfMonths | int32 | maximum: 12 minimum: 1 | |
| dayOfMonth | int32 | maximum: 30 minimum: 1 | |
| startDate | date-time | ||
| timeToStart | date-time | ||
| $type | string |
Expand
PUT /api/storage/{storageId}/scan_schedule
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/scan_schedule' \ --header 'Authorization: Bearer {token}' \ --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}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Update a scan schedule
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | minLength: 1 | |
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| recurrencePattern | |||
| object | object | ||
| type | string | ||
| hourlyRecurrence | |||
| object | object | ||
| everyNumberOfHours | int32 | maximum: 24 minimum: 1 | |
| dailyRecurrence | |||
| object | object | ||
| everyNumberOfDays | int32 | maximum: 365 minimum: 1 | |
| weeklyRecurrence | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrence | |||
| object | object | ||
| everyNumberOfMonths | int32 | maximum: 12 minimum: 1 | |
| dayOfMonth | int32 | maximum: 30 minimum: 1 | |
| startDate | date-time | ||
| timeToStart | date-time | ||
| $type | string | ||
| id | string |
Expand
PUT /api/storage/scan_schedule/update/{storageId}
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/storage/scan_schedule/update/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --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}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Fetch scan schedules
Auth
Path Params
| storageId | string | ||
| sortDirection | integer | Enum: | |
| startIndex | integer | ||
| count | integer |
Query String
| name | string | ||
| user | string | ||
| type | string |
GET /api/storage/scan_schedules/{storageId}/{sortDirection}/{startIndex}/{count}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/storage/scan_schedules/%7BstorageId%7D/%7BsortDirection%7D/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}' \ --data name={name} \ --data user={user} \ --data type={type}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| name | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| type | string | ||
| createdAt | date-time | ||
| lastScanTime | date-time | ||
| nextScanTime | date-time | ||
| recurrencePatternDto | |||
| object | object | ||
| hourlyRecurrenceDto | |||
| object | object | ||
| everyNumberOfHours | int32 | ||
| dailyRecurrenceDto | |||
| object | object | ||
| everyNumberOfDays | int32 | ||
| weeklyRecurrenceDto | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrenceDto | |||
| object | object | ||
| everyNumberOfMonths | int32 | ||
| dayOfMonth | int32 | ||
| createdBy | string | ||
| totalCount | int64 | ||
| createdByUsers | array[string] |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "id": "{string}", "name": "{string}", "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]...}" ]}Delete scan schedules
Auth
Request Body
| array | array[string] |
DELETE /api/storage/scan_schedule
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/storage/scan_schedule' \ --header 'Authorization: Bearer {token}' \ --data '[ "{array[string]...}"]'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| areAllDeleted | boolean |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "areAllDeleted": "{boolean}"}Retrieve storage user name
Auth
Path Params
| storageId | string | ||
| userId | string |
GET /api/storage/{storageId}/{userId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/%7BuserId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| userName | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "userName": "{string}"}User
Create, list and update user accounts
Fetch active users
Auth
Headers
| searchTerm | string |
Path Params
| startIndex | string | ||
| count | string |
GET /api/user/active/{startIndex}/{count}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/user/active/%7BstartIndex%7D/%7Bcount%7D' \ --header 'searchTerm: {searchTerm}' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| entries | array[object] | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| totalCount | int64 |
Response
xxxxxxxxxx{ "entries": [ { "id": "{string}", "userName": "{string}", "fullName": "{string}", "email": "{string}", "role": "{integer}" } ], "totalCount": "{int64}"}Register a user
Auth
Request Body
| object | object | ||
| fullName | string | minLength: 1 | |
| userName | string | minLength: 1 | |
| password | string | minLength: 1 | |
| string | minLength: 1 |
POST /api/user/register
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/user/register' \ --data '{ "fullName": "{string}", "userName": "{string}", "password": "{string}", "email": "{string}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Create a user
Auth
Request Body
| object | object | ||
| fullName | string | minLength: 1 | |
| userName | string | minLength: 1 | |
| password | string | minLength: 1 | |
| string | minLength: 1 | ||
| role | integer |
Enum: |
POST /api/user/create
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/user/create' \ --header 'Authorization: Bearer {token}' \ --data '{ "fullName": "{string}", "userName": "{string}", "password": "{string}", "email": "{string}", "role": "{integer}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Authenticate with a username and password
Authenticate with a username and password to obtain a JWT token,Most of the APIs require authentication in the form of providing a JWT token. Call this API in order to receive a token but please note that it's only valid for an hour so it should be periodically refreshed.
Auth
Request Body
| object | object | ||
| userName | string | minLength: 1 | |
| password | string | minLength: 1 |
POST /api/user/authenticate
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/user/authenticate' \ --data '{ "userName": "{string}", "password": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| accessToken | string | ||
| accessTokenExpiryTime | date-time | ||
| refreshToken | string | ||
| refreshTokenExpiryTime | date-time | ||
| fullName | string | ||
| string | |||
| userName | string | ||
| role | integer |
Enum: | |
| user | |||
| object | object | ||
| id | string | ||
| fullName | string | ||
| userName | string | ||
| passwordHash | string | ||
| passwordSalt | string | ||
| string | |||
| role | integer |
Enum: | |
| accountSecurity | object | ||
| incrementalDelay | string | ||
| failedLoginDate | date-time | ||
| ssoUserId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}", "fullName": "{string}", "email": "{string}", "userName": "{string}", "role": "{integer}", "user": { "id": "{string}", "fullName": "{string}", "userName": "{string}", "passwordHash": "{string}", "passwordSalt": "{string}", "email": "{string}", "role": "{integer}", "accountSecurity": { "incrementalDelay": "{string}", "failedLoginDate": "{date-time}" }, "ssoUserId": "{string}" }}Refresh user token
Auth
Request Body
| object | object | ||
| accessToken | string | minLength: 1 | |
| refreshToken | string | minLength: 1 |
POST /api/user/refreshToken
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/user/refreshToken' \ --data '{ "accessToken": "{string}", "refreshToken": "{string}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Logout
Auth
POST /api/user/logout
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/user/logout'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Update user role
Auth
Request Body
| object | object | ||
| userId | string | minLength: 1 | |
| role | integer |
Enum: |
PUT /api/user/role
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/user/role' \ --header 'Authorization: Bearer {token}' \ --data '{ "userId": "{string}", "role": "{integer}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| accessToken | string | ||
| accessTokenExpiryTime | date-time | ||
| refreshToken | string | ||
| refreshTokenExpiryTime | date-time | ||
| user | |||
| object | object | ||
| id | string | ||
| fullName | string | ||
| userName | string | ||
| passwordHash | string | ||
| passwordSalt | string | ||
| string | |||
| role | integer |
Enum: | |
| accountSecurity | object | ||
| incrementalDelay | string | ||
| failedLoginDate | date-time | ||
| ssoUserId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}", "user": { "id": "{string}", "fullName": "{string}", "userName": "{string}", "passwordHash": "{string}", "passwordSalt": "{string}", "email": "{string}", "role": "{integer}", "accountSecurity": { "incrementalDelay": "{string}", "failedLoginDate": "{date-time}" }, "ssoUserId": "{string}" }}Fetch users
Auth
GET /api/user/requests
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/user/requests' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| entries | array[object] | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| totalCount | int64 |
Response
xxxxxxxxxx{ "entries": [ { "id": "{string}", "userName": "{string}", "fullName": "{string}", "email": "{string}", "role": "{integer}" } ], "totalCount": "{int64}"}Delete a user
Auth
Path Params
| userId | string |
DELETE /api/user/{userId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/user/%7BuserId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| user | |||
| object | object | ||
| id | string | ||
| fullName | string | ||
| userName | string | ||
| passwordHash | string | ||
| passwordSalt | string | ||
| string | |||
| role | integer |
Enum: | |
| accountSecurity | object | ||
| incrementalDelay | string | ||
| failedLoginDate | date-time | ||
| ssoUserId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "user": { "id": "{string}", "fullName": "{string}", "userName": "{string}", "passwordHash": "{string}", "passwordSalt": "{string}", "email": "{string}", "role": "{integer}", "accountSecurity": { "incrementalDelay": "{string}", "failedLoginDate": "{date-time}" }, "ssoUserId": "{string}" }}Update a user
Auth
Request Body
| object | object | ||
| userId | string | ||
| role | integer |
Enum: | |
| userName | string | ||
| fullName | string | ||
| currentPassword | string | ||
| newPassword | string | ||
| string |
PUT /api/user
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/user' \ --header 'Authorization: Bearer {token}' \ --data '{ "userId": "{string}", "role": "{integer}", "userName": "{string}", "fullName": "{string}", "currentPassword": "{string}", "newPassword": "{string}", "email": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| accessToken | string | ||
| accessTokenExpiryTime | date-time | ||
| refreshToken | string | ||
| refreshTokenExpiryTime | date-time | ||
| user | |||
| object | object | ||
| id | string | ||
| fullName | string | ||
| userName | string | ||
| passwordHash | string | ||
| passwordSalt | string | ||
| string | |||
| role | integer |
Enum: | |
| accountSecurity | object | ||
| incrementalDelay | string | ||
| failedLoginDate | date-time | ||
| ssoUserId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}", "user": { "id": "{string}", "fullName": "{string}", "userName": "{string}", "passwordHash": "{string}", "passwordSalt": "{string}", "email": "{string}", "role": "{integer}", "accountSecurity": { "incrementalDelay": "{string}", "failedLoginDate": "{date-time}" }, "ssoUserId": "{string}" }}Request password reset
Auth
Request Body
| object | object | ||
| userInput | string | minLength: 1 |
POST /api/user/password/reset
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/user/password/reset' \ --data '{ "userInput": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Reset user password
Auth
Request Body
| object | object | ||
| newPassword | string | minLength: 12 | |
| newPasswordConfirmation | string | minLength: 12 | |
| secureToken | string |
POST /api/user/password
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/user/password' \ --data '{ "newPassword": "{string}", "newPasswordConfirmation": "{string}", "secureToken": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| user | object | ||
| id | string | ||
| fullName | string | ||
| userName | string | ||
| passwordHash | string | ||
| passwordSalt | string | ||
| string | |||
| role | integer |
Enum: | |
| accountSecurity | object | ||
| incrementalDelay | string | ||
| failedLoginDate | date-time | ||
| ssoUserId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "user": { "id": "{string}", "fullName": "{string}", "userName": "{string}", "passwordHash": "{string}", "passwordSalt": "{string}", "email": "{string}", "role": "{integer}", "accountSecurity": { "incrementalDelay": "{string}", "failedLoginDate": "{date-time}" }, "ssoUserId": "{string}" }}Webhook
Object event trigger of real time processing
This endpoint takes the parameters and tries to find the file in the specified storage and applies the scan configuration for the specified file
Auth
Request Body
| object | object | ||
| metadata | string | minLength: 1 | |
| storageClientId | string | minLength: 1 |
POST /api/webhook/realtime
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/webhook/realtime' \ --header 'Authorization: Bearer {token}' \ --data '{ "metadata": "{string}", "storageClientId": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| correlationId | string |
400
404
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "correlationId": "{string}"}Object event trigger of real time processing by storage client ID
This endpoint takes the parameter and tries to find the file in the specified storage and applies the scan configuration for the specified file
Auth
Path Params
| storageClientId | string |
Request Body
| No request body |
POST /api/webhook/realtime/{storageClientId}
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/webhook/realtime/%7BstorageClientId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| correlationId | string |
400
404
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "correlationId": "{string}"}Workflow
List, add, update and delete Scan Configurations
Get Scan Configurations
Auth
GET /api/workflow
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/workflow' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| name | string | ||
| userAgent | string | ||
| scanPool | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "id": "{string}", "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "type": "{integer}", "name": "{string}", "userAgent": "{string}", "scanPool": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] }, "failOverScanPoolId": "{string}", "failOverScanPool": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] }, "filters": { "minimumSize": "{int64}", "maximumSize": "{int64}", "minimumDateTime": "{date-time}", "maximumDateTime": "{date-time}" } } ]}Expand
Add a new Scan Configuration
Auth
Request Body
| object | object | ||
| scanPoolId | string | minLength: 1 | |
| rules | array[string] | ||
| name | string | maxLength: 30 minLength: 3 | |
| userAgent | string | ||
| failOverScanPoolId | string | ||
| filters | object | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time |
POST /api/workflow
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/workflow' \ --header 'Authorization: Bearer {token}' \ --data '{ "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "name": "{string}", "userAgent": "{string}", "failOverScanPoolId": "{string}", "filters": { "minimumSize": "{int64}", "maximumSize": "{int64}", "minimumDateTime": "{date-time}", "maximumDateTime": "{date-time}" }}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| workflowId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "workflowId": "{string}"}Update an existing Scan Configuration
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| scanPoolId | string | ||
| rules | array[string] | ||
| name | string | maxLength: 30 minLength: 3 | |
| userAgent | string | ||
| failOverScanPoolId | string | ||
| failOverDisabled | boolean | ||
| filters | |||
| object | object | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time |
PATCH /api/workflow
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/workflow' \ --header 'Authorization: Bearer {token}' \ --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}" }}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Get Scan Configuration by ID
Auth
Path Params
| id | string |
GET /api/workflow/{id}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/workflow/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entry | |||
| object | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| name | string | ||
| userAgent | string | ||
| scanPool | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entry": { "id": "{string}", "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "type": "{integer}", "name": "{string}", "userAgent": "{string}", "scanPool": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] }, "failOverScanPoolId": "{string}", "failOverScanPool": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] }, "filters": { "minimumSize": "{int64}", "maximumSize": "{int64}", "minimumDateTime": "{date-time}", "maximumDateTime": "{date-time}" } }}Expand
Delete a Scan Configuration
Auth
Path Params
| id | string |
DELETE /api/workflow/{id}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/workflow/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Set a Scan Configuration as default
Auth
Path Params
| id | string |
POST /api/workflow/setDefault/{id}
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/workflow/setDefault/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Deprecated Soon To Be Removed
Endpoints
Deprecated, soon to be removedDeprecated
Fetch MetaDefender Core Pools
Auth
GET /api/corepool
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/corepool' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | Deprecated | |
| entries | array[object] | ||
| id | string | ||
| name | string | ||
| mdCores | array[object] | ||
| id | string | ||
| url | string | ||
| ip | string | ||
| apiKey | string | ||
| timeout | string | ||
| userAgent | string | ||
| workflowRule | string | ||
| displayName | string | ||
| usedBy | array[object] | ||
| name | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "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}" } } ] } ]}Deprecated, soon to be removedDeprecated
Update an existing MetaDefender Core Pool
Auth
Request Body
| object | object | Deprecated | |
| id | string | minLength: 1 | |
| name | string | maxLength: 30 minLength: 3 |
PUT /api/corepool
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/corepool' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "name": "{string}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Deprecated, soon to be removedDeprecated
Add a new MetaDefender Core Pool
Auth
Request Body
| object | object | Deprecated | |
| name | string | maxLength: 30 minLength: 3 |
POST /api/corepool
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/corepool' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Deprecated, soon to be removedDeprecated
Get MetaDefender Core Pool by ID
Auth
Path Params
| corePoolId | string |
GET /api/corepool/{corePoolId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/corepool/%7BcorePoolId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | Deprecated | |
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| corePool | |||
| object | object | Deprecated | |
| id | string | ||
| name | string | ||
| mdCores | array[object] | ||
| id | string | ||
| url | string | ||
| ip | string | ||
| apiKey | string | ||
| timeout | string | ||
| userAgent | string | ||
| workflowRule | string | ||
| displayName | string | ||
| usedBy | array[object] | ||
| name | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "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}" } } ] }}Deprecated, soon to be removedDeprecated
Delete MetaDefender Core Pool
Auth
Path Params
| id | string |
DELETE /api/corepool/{id}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/corepool/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Deprecated, soon to be removedDeprecated
Fetch MetaDefender Core servers
Auth
Query String
| corePoolId | string |
GET /api/metadefendercore
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/metadefendercore' \ --header 'Authorization: Bearer {token}' \ --data corePoolId={corePoolId}Responses
200
| object | object | Deprecated | |
| entries | array[object] | ||
| id | string | ||
| url | string | ||
| ip | string | ||
| apiKey | string | ||
| timeout | string | ||
| userAgent | string | ||
| workflowRule | string | ||
| displayName | string |
Response
xxxxxxxxxx{ "entries": [ { "id": "{string}", "url": "{string}", "ip": "{string}", "apiKey": "{string}", "timeout": "{string}", "userAgent": "{string}", "workflowRule": "{string}", "displayName": "{string}" } ]}Deprecated, soon to be removedDeprecated
Update MetaDefender Core server
Auth
Request Body
| object | object | Deprecated | |
| id | string | ||
| url | string | minLength: 1 pattern: | |
| apiKey | string | ||
| timeout | string | ||
| userAgent | string | ||
| workflowRule | string | ||
| corePoolId | string |
PUT /api/metadefendercore
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/metadefendercore' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "userAgent": "{string}", "workflowRule": "{string}", "corePoolId": "{string}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Deprecated, soon to be removedDeprecated
Add a new MetaDefender Core Server
Auth
Request Body
| object | object | Deprecated | |
| id | string | ||
| url | string | minLength: 1 pattern: | |
| apiKey | string | ||
| timeout | string | ||
| userAgent | string | ||
| workflowRule | string | ||
| corePoolId | string |
POST /api/metadefendercore
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/metadefendercore' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "userAgent": "{string}", "workflowRule": "{string}", "corePoolId": "{string}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Deprecated, soon to be removedDeprecated
Get MetaDefender Core server by ID
Auth
Path Params
| metaDefenderId | string |
GET /api/metadefendercore/{metaDefenderId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/metadefendercore/%7BmetaDefenderId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | Deprecated | |
| id | string | ||
| url | string | ||
| ip | string | ||
| apiKey | string | ||
| timeout | string | ||
| userAgent | string | ||
| workflowRule | string | ||
| displayName | string |
Response
xxxxxxxxxx{ "id": "{string}", "url": "{string}", "ip": "{string}", "apiKey": "{string}", "timeout": "{string}", "userAgent": "{string}", "workflowRule": "{string}", "displayName": "{string}"}Deprecated, soon to be removedDeprecated
Delete MetaDefender Core server
Auth
Path Params
| metaDefenderId | string |
DELETE /api/metadefendercore/{metaDefenderId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/metadefendercore/%7BmetaDefenderId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}(Deprecated - use /workflow) Get Scan ConfigurationsDeprecated
Auth
GET /api/scanconfiguration
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scanconfiguration' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entries | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| name | string | ||
| userAgent | string | ||
| scanPool | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entries": [ { "id": "{string}", "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "type": "{integer}", "name": "{string}", "userAgent": "{string}", "scanPool": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] }, "failOverScanPoolId": "{string}", "failOverScanPool": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] } } ]}Expand
(Deprecated - use /workflow) Add a new Scan ConfigurationDeprecated
Auth
Request Body
| object | object | ||
| scanPoolId | string | minLength: 1 | |
| rules | array[string] | ||
| name | string | maxLength: 30 minLength: 3 | |
| userAgent | string | ||
| failOverScanPoolId | string |
POST /api/scanconfiguration
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/scanconfiguration' \ --header 'Authorization: Bearer {token}' \ --data '{ "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "name": "{string}", "userAgent": "{string}", "failOverScanPoolId": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| scanConfigurationId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "scanConfigurationId": "{string}"}(Deprecated - use /workflow) Update an existing Scan ConfigurationDeprecated
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| scanPoolId | string | ||
| rules | array[string] | ||
| name | string | maxLength: 30 minLength: 3 | |
| userAgent | string | ||
| failOverScanPoolId | string | ||
| failOverDisabled | boolean |
PATCH /api/scanconfiguration
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/scanconfiguration' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "name": "{string}", "userAgent": "{string}", "failOverScanPoolId": "{string}", "failOverDisabled": "{boolean}"}'Responses
200
| object | object | Deprecated | |
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}(Deprecated - use /workflow) Get Scan Configuration by IDDeprecated
Auth
Path Params
| id | string |
GET /api/scanconfiguration/{id}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scanconfiguration/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| entry | |||
| object | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| name | string | ||
| userAgent | string | ||
| scanPool | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "entry": { "id": "{string}", "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "type": "{integer}", "name": "{string}", "userAgent": "{string}", "scanPool": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] }, "failOverScanPoolId": "{string}", "failOverScanPool": { "id": "{string}", "name": "{string}", "scanPoolType": "{integer}", "isDefault": "{boolean}", "scanInstances": [ { "id": "{string}", "scanPoolId": "{string}", "url": "{string}", "apiKey": "{string}", "timeout": "{string}", "scanInstanceType": "{integer}" } ] } }}Expand
(Deprecated - use /workflow) Delete a Scan ConfigurationDeprecated
Auth
Path Params
| id | string |
DELETE /api/scanconfiguration/{id}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/scanconfiguration/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}(Deprecated - use /workflow) Set a Scan Configuration as defaultDeprecated
Auth
Path Params
| id | string |
POST /api/scanconfiguration/setDefault/{id}
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/scanconfiguration/setDefault/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}"}Deprecated, soon to be removedDeprecated
(Deprecated) Get an active scan by scan ID and file ID
Auth
Path Params
| scanId | string | ||
| activeFileId | string |
GET /api/scan/active/{scanId}/{activeFileId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scan/active/%7BscanId%7D/%7BactiveFileId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | |||
| object | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | |||
| object | object | ||
| pciDssComplianceViolationsCount | int64 | ||
| hipaaComplianceViolationsCount | int64 | ||
| gdprComplianceViolationsCount | int64 | ||
| malwareSecurityAlertsCount | int64 | ||
| vulnerabilitiesSecurityAlertsCount | int64 | ||
| piiSecurityAlertsCount | int64 | ||
| pciDssComplianceViolationsPercentageIncrease | int64 | ||
| hipaaComplianceViolationsPercentageIncrease | int64 | ||
| gdprComplianceViolationsPercentageIncrease | int64 | ||
| malwareSecurityAlertsPercentageIncrease | int64 | ||
| vulnerabilitiesSecurityAlertsPercentageIncrease | int64 | ||
| piiSecurityAlertsPercentageIncrease | int64 | ||
| highRiskAccounts | array[object] | ||
| id | string | ||
| displayName | string | ||
| blockedFilesCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] |
Expand
Response
xxxxxxxxxx{ "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]...}" ]}Expand
Deprecated, soon to be removedDeprecated
(Deprecated) Get Real-Time scan
Auth
Path Params
| storageId | string |
GET /api/scan/realtime/{storageId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scan/realtime/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | |||
| object | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | |||
| object | object | ||
| pciDssComplianceViolationsCount | int64 | ||
| hipaaComplianceViolationsCount | int64 | ||
| gdprComplianceViolationsCount | int64 | ||
| malwareSecurityAlertsCount | int64 | ||
| vulnerabilitiesSecurityAlertsCount | int64 | ||
| piiSecurityAlertsCount | int64 | ||
| pciDssComplianceViolationsPercentageIncrease | int64 | ||
| hipaaComplianceViolationsPercentageIncrease | int64 | ||
| gdprComplianceViolationsPercentageIncrease | int64 | ||
| malwareSecurityAlertsPercentageIncrease | int64 | ||
| vulnerabilitiesSecurityAlertsPercentageIncrease | int64 | ||
| piiSecurityAlertsPercentageIncrease | int64 | ||
| highRiskAccounts | array[object] | ||
| id | string | ||
| displayName | string | ||
| blockedFilesCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] | ||
| isRealTimeEnabled | boolean | ||
| handlingType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "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}"}Expand
Deprecated, soon to be removedDeprecated
(Deprecated) Fetch last completed scan
Auth
Path Params
| storageId | string |
GET /api/scan/last_completed/{storageId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scan/last_completed/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | |||
| object | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | |||
| object | object | ||
| pciDssComplianceViolationsCount | int64 | ||
| hipaaComplianceViolationsCount | int64 | ||
| gdprComplianceViolationsCount | int64 | ||
| malwareSecurityAlertsCount | int64 | ||
| vulnerabilitiesSecurityAlertsCount | int64 | ||
| piiSecurityAlertsCount | int64 | ||
| pciDssComplianceViolationsPercentageIncrease | int64 | ||
| hipaaComplianceViolationsPercentageIncrease | int64 | ||
| gdprComplianceViolationsPercentageIncrease | int64 | ||
| malwareSecurityAlertsPercentageIncrease | int64 | ||
| vulnerabilitiesSecurityAlertsPercentageIncrease | int64 | ||
| piiSecurityAlertsPercentageIncrease | int64 | ||
| highRiskAccounts | array[object] | ||
| id | string | ||
| displayName | string | ||
| blockedFilesCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] |
Expand
Response
xxxxxxxxxx{ "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]...}" ]}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add an Amazon S3 storage
Auth
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| serviceUrl | string | ||
| secretsManagerServiceUrl | string | ||
| kmsServiceUrl | string | ||
| accessKeyId | string | ||
| secretAccessKey | string | ||
| regionEndpoint | string | ||
| bucketName | string | minLength: 1 | |
| folderLocation | string | ||
| useIamRole | boolean | ||
| assumeRoleArn | string | pattern: | |
| useClientSideEncryption | boolean | ||
| secretName | string | ||
| storageVendorType | integer |
Enum: | |
| usePathStyleAddressing | boolean |
Expand
POST /api/storage/amazons3
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/amazons3' \ --header 'Authorization: Bearer {token}' \ --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}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update an Amazon S3 storage
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| serviceUrl | string | ||
| secretsManagerServiceUrl | string | ||
| kmsServiceUrl | string | ||
| accessKeyId | string | ||
| secretAccessKey | string | ||
| regionEndpoint | string | ||
| bucketName | string | minLength: 1 | |
| folderLocation | string | ||
| useIamRole | boolean | ||
| assumeRoleArn | string | pattern: | |
| useClientSideEncryption | boolean | ||
| secretName | string | ||
| storageVendorType | integer |
Enum: | |
| usePathStyleAddressing | boolean |
Expand
PATCH /api/storage/amazons3/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/amazons3/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --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}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add an One Drive storage
Auth
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| tenantId | string | maxLength: 36 minLength: 36 | |
| clientId | string | maxLength: 36 minLength: 36 | |
| clientSecret | string | maxLength: 50 minLength: 1 | |
| group | string |
POST /api/storage/onedrive
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/onedrive' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "tenantId": "{string}", "clientId": "{string}", "clientSecret": "{string}", "group": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update an One Drive storage
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| tenantId | string | maxLength: 36 minLength: 36 | |
| clientId | string | maxLength: 36 minLength: 36 | |
| clientSecret | string | maxLength: 50 minLength: 1 | |
| group | string |
PATCH /api/storage/onedrive/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/onedrive/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "tenantId": "{string}", "clientId": "{string}", "clientSecret": "{string}", "group": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add a Box storage
Auth
Request Body
| object | object | ||
| Credentials | file | ||
| UserName | string | ||
| FolderPath | string | ||
| GroupName | string | ||
| Name | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string |
POST /api/storage/box
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/box' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update a Box storage
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| Credentials | file | ||
| UserName | string | ||
| FolderPath | string | ||
| GroupName | string | ||
| Name | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string |
PATCH /api/storage/box/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/box/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add Dell Isilon/SMB Compatibile
Auth
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| storageVendorType | integer |
Enum: | |
| user | string | minLength: 1 | |
| password | string | minLength: 1 | |
| sharePath | string | minLength: 1 |
POST /api/storage/smb
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/smb' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "storageVendorType": "{integer}", "user": "{string}", "password": "{string}", "sharePath": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update a Dell Isilon/SMB Compatibile
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| storageVendorType | integer |
Enum: | |
| user | string | minLength: 1 | |
| password | string | minLength: 1 | |
| sharePath | string | minLength: 1 |
PATCH /api/storage/smb/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/smb/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "storageVendorType": "{integer}", "user": "{string}", "password": "{string}", "sharePath": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add an Azure Blob storage
Auth
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| tenantId | string | maxLength: 36 minLength: 36 | |
| storageAccount | string | maxLength: 24 minLength: 3 | |
| clientId | string | maxLength: 36 minLength: 36 | |
| clientSecret | string | maxLength: 50 minLength: 1 | |
| container | string | maxLength: 63 minLength: 0 | |
| cloudType | string | maxLength: 63 minLength: 0 |
POST /api/storage/azureblob
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/azureblob' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "tenantId": "{string}", "storageAccount": "{string}", "clientId": "{string}", "clientSecret": "{string}", "container": "{string}", "cloudType": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update an Azure Blob storage
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| tenantId | string | maxLength: 36 minLength: 36 | |
| storageAccount | string | maxLength: 24 minLength: 3 | |
| clientId | string | maxLength: 36 minLength: 36 | |
| clientSecret | string | maxLength: 50 minLength: 1 | |
| container | string | maxLength: 63 minLength: 0 | |
| cloudType | string | maxLength: 63 minLength: 0 |
PATCH /api/storage/azureblob/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/azureblob/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "tenantId": "{string}", "storageAccount": "{string}", "clientId": "{string}", "clientSecret": "{string}", "container": "{string}", "cloudType": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add an Alibaba Cloud storage
Auth
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| endpoint | string | minLength: 1 | |
| accessKeyId | string | ||
| accessKeySecret | string | ||
| bucketName | string | minLength: 1 | |
| folderLocation | string | ||
| useRamRole | boolean |
POST /api/storage/alibabacloud
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/alibabacloud' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "endpoint": "{string}", "accessKeyId": "{string}", "accessKeySecret": "{string}", "bucketName": "{string}", "folderLocation": "{string}", "useRamRole": "{boolean}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update an Alibaba Cloud storage
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| endpoint | string | minLength: 1 | |
| accessKeyId | string | ||
| accessKeySecret | string | ||
| bucketName | string | minLength: 1 | |
| folderLocation | string | ||
| useRamRole | boolean |
PATCH /api/storage/alibabacloud/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/alibabacloud/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "endpoint": "{string}", "accessKeyId": "{string}", "accessKeySecret": "{string}", "bucketName": "{string}", "folderLocation": "{string}", "useRamRole": "{boolean}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add a Google Cloud storage
Auth
Request Body
| object | object | ||
| Credentials | file | ||
| BucketName | string | ||
| FolderLocation | string | ||
| UseAdc | boolean | ||
| Name | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string |
POST /api/storage/googlecloud
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/googlecloud' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update a Google Cloud storage
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| Credentials | file | ||
| BucketName | string | ||
| FolderLocation | string | ||
| UseAdc | boolean | ||
| Name | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string |
PATCH /api/storage/googlecloud/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/googlecloud/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add an Azure Files storage
Auth
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| accountName | string | minLength: 1 | |
| accountKey | string | minLength: 1 | |
| shareName | string | minLength: 1 | |
| folderLocation | string |
POST /api/storage/azurefiles
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/azurefiles' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "accountName": "{string}", "accountKey": "{string}", "shareName": "{string}", "folderLocation": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update an Azure Files storage
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | maxLength: 60 minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| accountName | string | minLength: 1 | |
| accountKey | string | minLength: 1 | |
| shareName | string | minLength: 1 | |
| folderLocation | string |
PATCH /api/storage/azurefiles/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/azurefiles/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{ "name": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "accountName": "{string}", "accountKey": "{string}", "shareName": "{string}", "folderLocation": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Deprecated, soon to be removedDeprecated
(Deprecated - use /storage) Add an Mft storage
Auth
Request Body
| ServiceUrl | string | ||
| ApiKey | string | ||
| ScanUsers | string | ||
| Name | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string |
POST /api/storage/mft
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/mft' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "storageId": "{string}"}Deprecated, soon to be removedDeprecated
(Deprecated - use /storage/{storageId}) Update an Mft storage
Auth
Path Params
| storageId | string |
Request Body
| ServiceUrl | string | ||
| ApiKey | string | ||
| ScanUsers | string | ||
| Name | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string |
PATCH /api/storage/mft/{storageId}
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/storage/mft/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| storageCredentials | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| scanConfig | object | ||
| realTimeScanConfig | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| postActionsScanConfig | object | ||
| fileTaggingConfig | |||
| object | object | ||
| isTaggingPostActionEnabled | boolean | ||
| fileTags | array[object] | ||
| fileTagKey | object | ||
| defaultName | string | ||
| customName | string | ||
| customValues | array[object] | ||
| defaultName | string | ||
| customName | string | ||
| isEnabled | boolean | ||
| fileTagType | integer |
Enum: | |
| deepCdrConfig | object | ||
| isDeepCdrPostActionEnabled | boolean | ||
| deepCdrOriginalFileHandlingType | integer |
Enum: | |
| moveDeleteRemediationConfig | object | ||
| blockedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| blockedFileHandlingType | integer |
Enum: | |
| sanitizedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| sanitizedFileHandlingType | integer |
Enum: | |
| allowedFileRemediationConfig | object | ||
| isEnabled | boolean | ||
| moveRemediationStorageConfig | object | ||
| storageId | string | ||
| userId | string | ||
| keepFolderStructure | boolean | ||
| allowedFileHandlingType | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| blockingStrategy | integer |
Enum: | |
| workflowId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "updatedStorage": { "id": "{string}", "name": "{string}", "groupId": "{string}", "clientId": "{string}", "accountId": "{string}", "storageCredentials": "{string}", "source": "{string}", "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}" }}Expand
Delete scan schedulesDeprecated
Auth
Path Params
| storageId | string |
Request Body
| array | array[string] |
DELETE /api/storage/scan_schedule/{storageId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/storage/scan_schedule/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data '[ "{array[string]...}"]'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| success | |||
| RestResponse | RestResponse | ||
| error | |||
| RestResponse | RestResponse | ||
| areAllDeleted | boolean |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "success": "{RestResponse}", "error": "{RestResponse}", "areAllDeleted": "{boolean}"}