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 Storage Security 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 Storage Security 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 Storage Security 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 | ||
| accounts | array[object] | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string | ||
| credentials | string | ||
| autoDiscovery | boolean | ||
| groupId | string | ||
| protocolType | int32 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}" }, "scansInProgress": "{boolean}", "isRtpInProgress": "{boolean}", "isScheduledScanInProgress": "{boolean}", "storageFunctionality": "{string}", "$type": "{string}" } ], "credentials": "{string}", "autoDiscovery": "{boolean}", "groupId": "{string}", "protocolType": "{int32}" } ]}Add an account
Auth
Query String
| Name | string | ||
| Description | string | ||
| Credentials | string | ||
| ProtocolType | |||
| VendorType | |||
| 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 VendorType={VendorType} \ --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 | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| autoDiscovery | boolean | ||
| groupId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "account": { "id": "{string}", "name": "{string}", "description": "{string}", "credentials": "{string}", "protocolType": "{integer}", "autoDiscovery": "{boolean}", "groupId": "{string}" }}Update an account
Auth
Query String
| AccountId | string | ||
| Name | string | ||
| Description | string | ||
| Credentials | string | ||
| ProtocolType | |||
| VendorType | |||
| 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 VendorType={VendorType} \ --data AutoDiscovery={AutoDiscovery} \ --data GroupId={GroupId} \ --form 'file=@{file}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| accountId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "accountId": "{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 | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string | ||
| credentials | string | ||
| autoDiscovery | boolean | ||
| groupId | string | ||
| protocolType | int32 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}" }, "scansInProgress": "{boolean}", "isRtpInProgress": "{boolean}", "isScheduledScanInProgress": "{boolean}", "storageFunctionality": "{string}", "$type": "{string}" } ], "credentials": "{string}", "autoDiscovery": "{boolean}", "groupId": "{string}", "protocolType": "{int32}" }}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 | ||
| accountId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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 | ||
| entries | array[object] | ||
| bucketName | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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 | ||
| accountCount | |||
| object | object | ||
| count | int64 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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 | ||
| entries | array[object] | ||
| id | string | ||
| logLevel | integer |
Enum: | |
| details | string | ||
| logType | |||
| integer | 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": {}, "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
Export the current configuration settings to an archive. The file will be encrypted using the provided password.
Auth
Query String
| exportLicense | boolean | ||
| exportSmtp | boolean | ||
| exportEmailNotifications | boolean | ||
| exportRetention | boolean | ||
| password | string |
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} \ --data password={password}Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Import configuration file
Auth
Request Body
| object | object | ||
| ConfigurationFile | file | ||
| password | string |
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 | ||
| areSmtpSettingsImported | boolean | ||
| isLicenseImported | boolean | ||
| isRetentionImported | boolean | ||
| activationDto | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "areSmtpSettingsImported": "{boolean}", "isLicenseImported": "{boolean}", "isRetentionImported": "{boolean}", "activationDto": { "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {} }}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 | ||
| enabledModules | array[integer] |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}"}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 | ||
| entries | array[object] | ||
| id | string | ||
| isEnabled | boolean | ||
| loggerType | integer |
Enum: | |
| connectionSettings | |||
| object | object | ||
| $type | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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
Enumerate processed files
Auth
Query String
| startIndex | integer | maximum: 2147483647 minimum: 0 | |
| count | integer | maximum: 10000 minimum: 1 | |
| startDate | string | ||
| endDate | string | ||
| search | string | ||
| scanType | array | Enum: | |
| storageId | array | ||
| scanId | array | ||
| scanWorkflowSnapshotId | array | ||
| processingState | array | Enum: | |
| result | array | Enum: | |
| scanAllResultI | array | Enum: | |
| scanResultICount | array | ||
| vulnerabilityCount | array | ||
| hasVulnerabilities | boolean | ||
| dlpDetection | boolean | ||
| remediations | array | Enum: | |
| sortBy | array | Enum: | |
| sortOrder | array | Enum: | |
| expand | array |
Expand
GET /api/file
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/file' \ --header 'Authorization: Bearer {token}' \ --data startIndex={startIndex} \ --data count={count} \ --data startDate={startDate} \ --data endDate={endDate} \ --data search={search} \ --data scanType={scanType} \ --data storageId={storageId} \ --data scanId={scanId} \ --data scanWorkflowSnapshotId={scanWorkflowSnapshotId} \ --data processingState={processingState} \ --data result={result} \ --data scanAllResultI={scanAllResultI} \ --data scanResultICount={scanResultICount} \ --data vulnerabilityCount={vulnerabilityCount} \ --data hasVulnerabilities={hasVulnerabilities} \ --data dlpDetection={dlpDetection} \ --data remediations={remediations} \ --data sortBy={sortBy} \ --data sortOrder={sortOrder} \ --data expand={expand}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| 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 | ||
| 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 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| originalFilePath | string | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| 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 | object | ||
| osName | string | ||
| osVersion | string | ||
| scanMode | string | ||
| steps | |||
| object | object | ||
| command | string | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | 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 | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| 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 | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| 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 | ||
| isOriginalVersionOfSanitizedFile | boolean | ||
| hasSanitizedFileBeenMoved | boolean | ||
| hasSanitizedFileBeenCopied | boolean | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| tenantId | string | ||
| lastUpdated | date-time | ||
| metaDefenderCoreUrl | string | ||
| discoveryStartedDaySec | int64 | ||
| objectStorageMetadata | string | ||
| scanWorkflowSnapshotId | string | ||
| scanWorkflowSnapshot | |||
| object | object | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| filterCount | int64 | ||
| totalCount | int64 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [ { "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}"}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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Retrieve archive scan results
Retrieve the archive scan results using either the scanResultId or the parentId
Auth
Path Params
| fileId | string |
Query String
| expand | array | Possible values for expand: workflow_snapshot |
GET /api/file/{fileId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/file/%7BfileId%7D' \ --header 'Authorization: Bearer {token}' \ --data expand={expand}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | Deprecated | |
| scanId | string | Deprecated | |
| name | string | Deprecated | |
| path | string | Deprecated | |
| hash | string | Deprecated | |
| fileOwner | Deprecated | ||
| object | object | ||
| userId | string | ||
| fullName | string | ||
| userName | string | ||
| emailAddress | string | ||
| size | int64 | Deprecated | |
| storageType | Deprecated | ||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageName | string | Deprecated | |
| storageLocation | string | Deprecated | |
| scanName | string | Deprecated | |
| progress | Deprecated | ||
| object | object | ||
| upload | int32 | ||
| scan | int32 | ||
| scanResult | Deprecated | ||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| 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 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| originalFilePath | string | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| 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 | object | ||
| osName | string | ||
| osVersion | string | ||
| scanMode | string | ||
| steps | |||
| object | object | ||
| command | string | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | 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 | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| 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 | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| 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 | Deprecated | ||
| integer | integer |
Enum: | |
| exception | Deprecated | ||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| created | date-time | Deprecated | |
| lastModified | date-time | Deprecated | |
| discoveryStarted | date-time | Deprecated | |
| fileProcessingDetails | Deprecated | ||
| object | object | ||
| streamingStartedTime | date-time | ||
| streamingCompletedTime | date-time | ||
| streamingTimeSpanMs | int64 | ||
| scanCompletedTime | date-time | ||
| processingTimeSpanMs | int64 | ||
| coreEngines | array[object] | Deprecated | |
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | Deprecated | ||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| isSanitized | boolean | ||
| isOriginalVersionOfSanitizedFile | boolean | ||
| hasSanitizedFileBeenMoved | boolean | ||
| hasSanitizedFileBeenCopied | boolean | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| tenantId | string | ||
| lastUpdated | date-time | ||
| metaDefenderCoreUrl | string | Deprecated | |
| discoveryStartedDaySec | int64 | Deprecated | |
| fileDto | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| 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 | ||
| 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 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| originalFilePath | string | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| 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 | object | ||
| osName | string | ||
| osVersion | string | ||
| scanMode | string | ||
| steps | |||
| object | object | ||
| command | string | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | 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 | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| 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 | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| 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 | ||
| isOriginalVersionOfSanitizedFile | boolean | ||
| hasSanitizedFileBeenMoved | boolean | ||
| hasSanitizedFileBeenCopied | boolean | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| tenantId | string | ||
| lastUpdated | date-time | ||
| metaDefenderCoreUrl | string | ||
| discoveryStartedDaySec | int64 | ||
| objectStorageMetadata | string | ||
| scanWorkflowSnapshotId | string | ||
| scanWorkflowSnapshot | |||
| object | object | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "id": "{string}", "scanId": "{string}", "name": "{string}", "path": "{string}", "hash": "{string}", "fileOwner": {...}, "size": "{int64}", "storageType": {...}, "storageName": "{string}", "storageLocation": "{string}", "scanName": "{string}", "progress": {...}, "scanResult": {...}, "processingState": "{integer}", "exception": {...}, "created": "{date-time}", "lastModified": "{date-time}", "discoveryStarted": "{date-time}", "fileProcessingDetails": {...}, "coreEngines": [...], "remediation": {...}, "metaDefenderCoreUrl": "{string}", "discoveryStartedDaySec": "{int64}", "fileDto": {...}}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
Query String
| scanResultId | string | ||
| parentId | string | ||
| start | integer | ||
| count | integer | Default: 1000 |
GET /api/file/archive
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/file/archive' \ --header 'Authorization: Bearer {token}' \ --data scanResultId={scanResultId} \ --data parentId={parentId} \ --data start={start} \ --data count=1000Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| archiveScanResults | array[object] | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| 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 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| originalFilePath | string | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| 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 | object | ||
| osName | string | ||
| osVersion | string | ||
| scanMode | string | ||
| steps | |||
| object | object | ||
| command | string | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | 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 | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| 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 | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| 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 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "archiveScanResults": [...]}Cancel a file in an ongoing scan
Auth
Request Body
| object | object | ||
| fileIds | array[string] |
POST /api/file/cancel
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/file/cancel' \ --header 'Authorization: Bearer {token}' \ --data '{ "fileIds": [ "{array[string]...}" ]}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | Deprecated | |
| scanId | string | Deprecated | |
| name | string | Deprecated | |
| path | string | Deprecated | |
| hash | string | Deprecated | |
| fileOwner | Deprecated | ||
| object | object | ||
| userId | string | ||
| fullName | string | ||
| userName | string | ||
| emailAddress | string | ||
| size | int64 | Deprecated | |
| storageType | Deprecated | ||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageName | string | Deprecated | |
| storageLocation | string | Deprecated | |
| scanName | string | Deprecated | |
| progress | Deprecated | ||
| object | object | ||
| upload | int32 | ||
| scan | int32 | ||
| scanResult | Deprecated | ||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| 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 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| originalFilePath | string | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| 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 | object | ||
| osName | string | ||
| osVersion | string | ||
| scanMode | string | ||
| steps | |||
| object | object | ||
| command | string | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | 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 | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| 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 | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| 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 | Deprecated | ||
| integer | integer |
Enum: | |
| exception | Deprecated | ||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| created | date-time | Deprecated | |
| lastModified | date-time | Deprecated | |
| discoveryStarted | date-time | Deprecated | |
| fileProcessingDetails | Deprecated | ||
| object | object | ||
| streamingStartedTime | date-time | ||
| streamingCompletedTime | date-time | ||
| streamingTimeSpanMs | int64 | ||
| scanCompletedTime | date-time | ||
| processingTimeSpanMs | int64 | ||
| coreEngines | array[object] | Deprecated | |
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | Deprecated | ||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| isSanitized | boolean | ||
| isOriginalVersionOfSanitizedFile | boolean | ||
| hasSanitizedFileBeenMoved | boolean | ||
| hasSanitizedFileBeenCopied | boolean | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| tenantId | string | ||
| lastUpdated | date-time | ||
| metaDefenderCoreUrl | string | Deprecated | |
| discoveryStartedDaySec | int64 | Deprecated | |
| fileDto | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| 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 | ||
| 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 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| originalFilePath | string | ||
| processInfo | |||
| object | object | ||
| postProcessing | |||
| object | object | ||
| actionsRan | string | ||
| actionsFailed | string | ||
| convertedTo | string | ||
| copyMoveDestination | string | ||
| convertedDestination | string | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| progressPercentage | int32 | ||
| userAgent | string | ||
| profile | string | ||
| result | string | ||
| blockedReason | string | ||
| fileTypeSkippedScan | boolean | ||
| processingTime | number | ||
| queueTime | number | ||
| resultI | integer |
Enum: | |
| 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 | object | ||
| osName | string | ||
| osVersion | string | ||
| scanMode | string | ||
| steps | |||
| object | object | ||
| command | string | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | 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 | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| 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 | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| 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 | ||
| isOriginalVersionOfSanitizedFile | boolean | ||
| hasSanitizedFileBeenMoved | boolean | ||
| hasSanitizedFileBeenCopied | boolean | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| tenantId | string | ||
| lastUpdated | date-time | ||
| metaDefenderCoreUrl | string | ||
| discoveryStartedDaySec | int64 | ||
| objectStorageMetadata | string | ||
| scanWorkflowSnapshotId | string | ||
| scanWorkflowSnapshot | |||
| object | object | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "id": "{string}", "scanId": "{string}", "name": "{string}", "path": "{string}", "hash": "{string}", "fileOwner": {...}, "size": "{int64}", "storageType": {...}, "storageName": "{string}", "storageLocation": "{string}", "scanName": "{string}", "progress": {...}, "scanResult": {...}, "processingState": "{integer}", "exception": {...}, "created": "{date-time}", "lastModified": "{date-time}", "discoveryStarted": "{date-time}", "fileProcessingDetails": {...}, "coreEngines": [...], "remediation": {...}, "metaDefenderCoreUrl": "{string}", "discoveryStartedDaySec": "{int64}", "fileDto": {...}}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 | ||
| groups | array[object] | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}" }, "scansInProgress": "{boolean}", "isRtpInProgress": "{boolean}", "isScheduledScanInProgress": "{boolean}", "storageFunctionality": "{string}", "$type": "{string}" } ] } ]}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 | ||
| group | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "group": { "id": "{string}", "name": "{string}", "description": "{string}", "storages": [ { "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}" }, "workflowId": "{string}", "lastUpdated": "{date-time}", "tenantId": "{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 | ||
| updatedGroup | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "updatedGroup": { "id": "{string}", "name": "{string}", "description": "{string}", "storages": [ { "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}" }, "workflowId": "{string}", "lastUpdated": "{date-time}", "tenantId": "{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 | ||
| group | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}" }, "scansInProgress": "{boolean}", "isRtpInProgress": "{boolean}", "isScheduledScanInProgress": "{boolean}", "storageFunctionality": "{string}", "$type": "{string}" } ] }}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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 | ||
| groupCount | object | ||
| count | int64 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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 | ||
| newDefaultWorkflow | boolean |
GET /api/onboarding
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/onboarding' \ --data newConfigSetup={newConfigSetup} \ --data newDefaultWorkflow={newDefaultWorkflow}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| hasUserConfigured | boolean | ||
| hasStorageConfigured | boolean | ||
| hasScanInstanceConfigured | boolean | ||
| isOnboardingDone | boolean | ||
| isEulaAgreed | boolean | ||
| isCloudType | boolean |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}"}Remediations
Remediations information
Get Remediations by workflow id
Auth
Path Params
| id | string |
GET /api/remediations/workflow/{id}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/remediations/workflow/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [ { "id": "{string}", "workflowId": "{string}", "isEnabled": "{boolean}", "configuration": "{string}", "type": "{integer}", "handlingType": "{integer}" } ]}Get Remediation by id
Auth
Path Params
| id | string |
GET /api/remediations/{id}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/remediations/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entry | |||
| object | object | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entry": { "id": "{string}", "workflowId": "{string}", "isEnabled": "{boolean}", "configuration": "{string}", "type": "{integer}", "handlingType": "{integer}" }}Delete Remediation
Auth
Path Params
| id | string |
DELETE /api/remediations/{id}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/remediations/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Add Remediation
Auth
Request Body
| object | object | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
POST /api/remediations
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/remediations' \ --header 'Authorization: Bearer {token}' \ --data '{ "workflowId": "{string}", "isEnabled": "{boolean}", "configuration": "{string}", "type": "{integer}", "handlingType": "{integer}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Update Remediation
Auth
Request Body
| object | object | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | |||
| integer | integer |
Enum: | |
| handlingType | |||
| integer | integer |
Enum: |
PATCH /api/remediations
xxxxxxxxxxcurl --request PATCH \ --url 'http://<MDSS_HOST>/api/remediations' \ --header 'Authorization: Bearer {token}' \ --data '{ "id": "{string}", "workflowId": "{string}", "isEnabled": "{boolean}", "configuration": "{string}", "type": "{integer}", "handlingType": "{integer}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Report
Generate reports
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 | ||
| entries | array | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| totalCount | int64 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [...], "totalCount": "{int64}"}Download PDF Report
Auth
Path Params
| scanId | string |
Query String
| typeOfReport | integer | Enum: | |
| startIndex | integer | maximum: 2147483647 minimum: 0 | |
| count | integer | maximum: 10000 minimum: 1 | |
| startDate | string | ||
| endDate | string | ||
| search | string | ||
| scanType | array | Enum: | |
| storageId | array | ||
| scanId | array | ||
| scanWorkflowSnapshotId | array | ||
| processingState | array | Enum: | |
| result | array | Enum: | |
| scanAllResultI | array | Enum: | |
| scanResultICount | array | ||
| vulnerabilityCount | array | ||
| hasVulnerabilities | boolean | ||
| dlpDetection | boolean | ||
| remediations | array | Enum: | |
| sortBy | array | Enum: | |
| sortOrder | array | Enum: | |
| expand | array |
Expand
GET /api/report/download/{scanId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/report/download/%7BscanId%7D' \ --header 'Authorization: Bearer {token}' \ --data typeOfReport={typeOfReport} \ --data startIndex={startIndex} \ --data count={count} \ --data startDate={startDate} \ --data endDate={endDate} \ --data search={search} \ --data scanType={scanType} \ --data storageId={storageId} \ --data scanId={scanId} \ --data scanWorkflowSnapshotId={scanWorkflowSnapshotId} \ --data processingState={processingState} \ --data result={result} \ --data scanAllResultI={scanAllResultI} \ --data scanResultICount={scanResultICount} \ --data vulnerabilityCount={vulnerabilityCount} \ --data hasVulnerabilities={hasVulnerabilities} \ --data dlpDetection={dlpDetection} \ --data remediations={remediations} \ --data sortBy={sortBy} \ --data sortOrder={sortOrder} \ --data expand={expand}Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}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 | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "scan": {...}}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 NFS / SMB / SFTP: Only the folder path beyond your configured storage root (do not include the base path set during integration)
Auth
Request Body
| object | object | ||
| storageId | string | Deprecated | |
| name | string | pattern: | |
| folder | string | ||
| priority | int32 | ||
| storageIds | array[string] | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| scanConfigDto | |||
| object | object | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: |
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}", "priority": "{int32}", "storageIds": [ "{array[string]...}" ], "workflowId": "{string}", "scanConfigurationId": "{string}", "scanConfigDto": { "realTimeScanConfig": { "isEnabled": "{boolean}", "startDate": "{date-time}", "handlingType": "{integer}" } }}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scanId | string | ||
| scanIds | array[string] |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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 | ||
| nextScheduledScan | |||
| object | object | ||
| id | string | ||
| name | string | ||
| storageId | string | ||
| userId | string | ||
| createdAt | date-time | ||
| nextScanTime | date-time | ||
| lastScanTime | date-time | ||
| workflowId | string | ||
| recurrencePattern | object | ||
| type | integer |
Enum: | |
| hourlyRecurrence | |||
| object | object | ||
| everyNumberOfHours | int32 | ||
| dailyRecurrence | |||
| object | object | ||
| everyNumberOfDays | int32 | ||
| weeklyRecurrence | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrence | |||
| object | object | ||
| everyNumberOfMonths | int32 | ||
| dayOfMonth | int32 | ||
| startDate | date-time | ||
| timeToStart | date-time | ||
| priority | integer |
Enum: | |
| additionalProperties | string | ||
| scheduledScansCount | int32 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "nextScheduledScan": { "id": "{string}", "name": "{string}", "storageId": "{string}", "userId": "{string}", "createdAt": "{date-time}", "nextScanTime": "{date-time}", "lastScanTime": "{date-time}", "workflowId": "{string}", "recurrencePattern": { "type": "{integer}", "hourlyRecurrence": { "everyNumberOfHours": "{int32}" }, "dailyRecurrence": { "everyNumberOfDays": "{int32}" }, "weeklyRecurrence": { "daysOfWeek": [ "{array[integer]...}" ], "everyNumberOfWeeks": "{int32}" }, "monthlyRecurrence": { "everyNumberOfMonths": "{int32}", "dayOfMonth": "{int32}" }, "startDate": "{date-time}", "timeToStart": "{date-time}" }, "priority": "{integer}", "additionalProperties": "{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 | ||
| deletedScans | array[object] | ||
| id | string | ||
| storageId | string | ||
| workflowId | string | ||
| scanScheduleId | string | ||
| executionId | string | ||
| name | string | ||
| userId | string | ||
| scanConfigDto | object | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| discoveryState | integer |
Enum: | |
| scanningState | integer |
Enum: | |
| scanType | integer |
Enum: | |
| startTime | date-time | ||
| stopTime | date-time | ||
| priority | integer |
Enum: | |
| additionalProperties | string | ||
| tenantId | string | ||
| errors | array[string] |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "deletedScans": [ { "id": "{string}", "storageId": "{string}", "workflowId": "{string}", "scanScheduleId": "{string}", "executionId": "{string}", "name": "{string}", "userId": "{string}", "scanConfigDto": { "realTimeScanConfig": { "isEnabled": "{boolean}", "startDate": "{date-time}", "handlingType": "{integer}" } }, "discoveryState": "{integer}", "scanningState": "{integer}", "scanType": "{integer}", "startTime": "{date-time}", "stopTime": "{date-time}", "priority": "{integer}", "additionalProperties": "{string}", "tenantId": "{string}", "errors": [ "{array[string]...}" ] } ]}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 | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "scan": {...}}Get an active scan by scan ID
Auth
Path Params
| scanId | string |
GET /api/scan/active/{scanId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/scan/active/%7BscanId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| serviceName | string | ||
| storageName | string | ||
| currentProcessingFilePath | string | ||
| currentProcessingFileProgress | string | ||
| discoveryState | integer |
Enum: | |
| statusMessages | array[object] | ||
| message | string | ||
| severity | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "scan": { "serviceName": "{string}", "storageName": "{string}", "currentProcessingFilePath": "{string}", "currentProcessingFileProgress": "{string}", "discoveryState": "{integer}", "statusMessages": [ { "message": "{string}", "severity": "{integer}" } ] }}Get Real-Time scan by storage Id
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 | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| workflowId | string | minLength: 1 | |
| scanConfigurationId | string | ||
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| isRealTimeEnabled | boolean | ||
| handlingType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "scan": { "isRealTimeEnabled": "{boolean}", "handlingType": "{integer}" }}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 | ||
| 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": {}, "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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 | ||
| scanInstanceId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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 | ||
| 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": {}, "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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 | ||
| 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": {}, "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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 | ||
| scanPoolId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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 | ||
| 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: |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 | ||
| scanWorkflowSnapshots | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| 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: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "scanWorkflowSnapshots": [...]}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 | ||
| 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": {}, "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 | ||
| 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": {}, "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 | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| host | string | ||
| port | int32 | ||
| baseUrl | string | ||
| senderAddress | string | ||
| senderName | string | ||
| domain | string | ||
| username | string | ||
| secureSocketOption | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "host": "{string}", "port": "{int32}", "baseUrl": "{string}", "senderAddress": "{string}", "senderName": "{string}", "domain": "{string}", "username": "{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 | ||
| newSmtpConfig | |||
| object | object | ||
| host | string | ||
| baseUrl | string | ||
| port | int32 | ||
| senderAddress | string | ||
| senderName | string | ||
| domain | string | ||
| username | string | ||
| secureSocketOption | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean | ||
| oldSmtpConfig | |||
| object | object | ||
| host | string | ||
| baseUrl | string | ||
| port | int32 | ||
| senderAddress | string | ||
| senderName | string | ||
| domain | string | ||
| username | string | ||
| secureSocketOption | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "newSmtpConfig": { "host": "{string}", "baseUrl": "{string}", "port": "{int32}", "senderAddress": "{string}", "senderName": "{string}", "domain": "{string}", "username": "{string}", "secureSocketOption": "{integer}", "ignoreCertWarnings": "{boolean}", "isSmtpEnabled": "{boolean}" }, "oldSmtpConfig": { "host": "{string}", "baseUrl": "{string}", "port": "{int32}", "senderAddress": "{string}", "senderName": "{string}", "domain": "{string}", "username": "{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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 | ||
| 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": {}, "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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Generate encryption key
Generate a new encryption key, replacing the old one if it exists.
Auth
POST /api/settings/encryption/generate
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/settings/encryption/generate' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Get encryption key creation date
Get the creation date of the encryption key.
Auth
GET /api/settings/encryption/creation-date
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/settings/encryption/creation-date' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| creationDate | date-time |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "creationDate": "{date-time}"}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 | ||
| 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 |
Response
xxxxxxxxxx{ "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 | ||
| 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 | ||
| 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": {}, "clientId": "{string}", "authority": "{string}", "baseUrl": "{string}", "isEnabled": "{boolean}", "ssoType": "{integer}", "ssoProvider": "{integer}", "identityProviderIssuer": "{string}", "identityProviderLoginUrl": "{string}", "identityProviderLogoutUrl": "{string}", "administratorRoleName": "{string}", "readonlyRoleName": "{string}", "ssoConfig": { "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 | ||
| entries | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}" }, "scansInProgress": "{boolean}", "isRtpInProgress": "{boolean}", "isScheduledScanInProgress": "{boolean}", "storageFunctionality": "{string}", "$type": "{string}" } ]}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 | ||
| storage | |||
| object | object | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}" }, "scansInProgress": "{boolean}", "isRtpInProgress": "{boolean}", "isScheduledScanInProgress": "{boolean}", "storageFunctionality": "{string}", "$type": "{string}" }}Delete a storage
Auth
Path Params
| storageId | string |
Query String
| forceDelete | boolean |
DELETE /api/storage/{storageId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D' \ --header 'Authorization: Bearer {token}' \ --data forceDelete={forceDelete}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}"
Graph 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 | ||
| TransferMetadataAndChecksum | boolean |
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 | ||
| 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: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}" }, "workflowId": "{string}", "lastUpdated": "{date-time}", "tenantId": "{string}" }}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 | ||
| entries | array[object] | ||
| id | string | ||
| fullName | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}"
Graph 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 | ||
| TransferMetadataAndChecksum | boolean |
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 | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "storageId": "{string}"}Add batch of storages
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}"
Graph storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null}"
Source: "{"Group":null}"
Auth
Request Body
| object | object | ||
| addStorageParametersList | array[object] | ||
| name | string | maxLength: 60 minLength: 3 pattern: | |
| storageVendorType | integer |
Enum: | |
| storageProtocolType | integer |
Enum: | |
| credentialsFile | file | ||
| credentials | string | ||
| source | string | minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| transferMetadataAndChecksum | boolean |
Expand
POST /api/storage/batch
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/storage/batch' \ --header 'Authorization: Bearer {token}' \ --data '{ "addStorageParametersList": [ { "name": "{string}", "storageVendorType": "{integer}", "storageProtocolType": "{integer}", "credentialsFile": "{file}", "credentials": "{string}", "source": "{string}", "groupId": "{string}", "accountId": "{string}", "workflowId": "{string}", "transferMetadataAndChecksum": "{boolean}" } ]}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| storageId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "storageId": "{string}"}Get batch of add storages results
Auth
Query String
| token | string |
GET /api/storage/results
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/storage/results' \ --header 'Authorization: Bearer {token}' \ --data token={token}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| addStorageResultInfos | array | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| source | string | ||
| name | string | ||
| vendorType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| isCompleted | boolean |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "addStorageResultInfos": [ { "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "storageStatus": { "message": "{string}", "statusType": "{int32}" }, "source": "{string}", "name": "{string}", "vendorType": "{integer}", "protocolType": "{integer}" } ], "isCompleted": "{boolean}"}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 | ||
| entries | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "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}" }, "scansInProgress": "{boolean}", "isRtpInProgress": "{boolean}", "isScheduledScanInProgress": "{boolean}", "storageFunctionality": "{string}", "$type": "{string}" } ]}Add a scan schedule
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | minLength: 1 pattern: | |
| workflowId | string | minLength: 1 | |
| 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 | ||
| priority | int32 | ||
| $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}", "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}" }, "priority": "{int32}", "$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 pattern: | |
| workflowId | string | minLength: 1 | |
| 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 | ||
| priority | int32 | ||
| $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}", "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}" }, "priority": "{int32}", "$type": "{string}", "id": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Fetch scan schedules
Auth
Path Params
| storageId | string | ||
| sortDirection | integer | Enum: | |
| startIndex | integer | maximum: 2147483647 minimum: 0 | |
| count | integer | maximum: 2147483647 minimum: 1 |
Query String
| name | string | pattern: | |
| user | string | pattern: | |
| 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 | ||
| 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 | ||
| type | integer |
Enum: | |
| hourlyRecurrence | |||
| object | object | ||
| everyNumberOfHours | int32 | ||
| dailyRecurrence | |||
| object | object | ||
| everyNumberOfDays | int32 | ||
| weeklyRecurrence | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrence | |||
| object | object | ||
| everyNumberOfMonths | int32 | ||
| dayOfMonth | int32 | ||
| startDate | date-time | ||
| timeToStart | date-time | ||
| createdBy | string | ||
| priority | integer |
Enum: | |
| totalCount | int64 |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [ { "id": "{string}", "name": "{string}", "workflowId": "{string}", "scanConfigurationId": "{string}", "type": "{string}", "createdAt": "{date-time}", "lastScanTime": "{date-time}", "nextScanTime": "{date-time}", "recurrencePatternDto": { "type": "{integer}", "hourlyRecurrence": { "everyNumberOfHours": "{int32}" }, "dailyRecurrence": { "everyNumberOfDays": "{int32}" }, "weeklyRecurrence": { "daysOfWeek": [ "{array[integer]...}" ], "everyNumberOfWeeks": "{int32}" }, "monthlyRecurrence": { "everyNumberOfMonths": "{int32}", "dayOfMonth": "{int32}" }, "startDate": "{date-time}", "timeToStart": "{date-time}" }, "createdBy": "{string}", "priority": "{integer}" } ], "totalCount": "{int64}"}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 | ||
| areAllDeleted | boolean |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "areAllDeleted": "{boolean}"}Retrieve storage user name
Auth
Path Params
| storageId | string |
Query String
| userId | string |
GET /api/storage/{storageId}/user
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/storage/%7BstorageId%7D/user' \ --header 'Authorization: Bearer {token}' \ --data userId={userId}Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| userName | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "userName": "{string}"}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 | ||
| userName | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "userName": "{string}"}User
Create, list and update user accounts
Fetch active users
Auth
Path Params
| startIndex | string | ||
| count | string |
Query String
| searchTerm | string | pattern: | |
| orderType | |||
| orderBy | |||
| searchText | string | pattern: |
GET /api/user/active/{startIndex}/{count}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/user/active/%7BstartIndex%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}' \ --data searchTerm={searchTerm} \ --data orderType={orderType} \ --data orderBy={orderBy} \ --data searchText={searchText}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 | ||
| string | minLength: 1 | ||
| ssoUserId | string |
POST /api/user/register
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/user/register' \ --data '{ "fullName": "{string}", "userName": "{string}", "password": "{string}", "email": "{string}", "ssoUserId": "{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 | ||
| string | minLength: 1 | ||
| ssoUserId | string | ||
| 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}", "ssoUserId": "{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 | ||
| fullName | string | ||
| string | |||
| userName | string | ||
| role | |||
| integer | integer |
Enum: | |
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| userId | string | ||
| accessToken | string | ||
| accessTokenExpiryTime | date-time | ||
| refreshToken | string | ||
| refreshTokenExpiryTime | date-time |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "fullName": "{string}", "email": "{string}", "userName": "{string}", "role": "{integer}", "user": { "id": "{string}", "userName": "{string}", "fullName": "{string}", "email": "{string}", "role": "{integer}" }, "userId": "{string}", "accessToken": "{string}", "accessTokenExpiryTime": "{date-time}", "refreshToken": "{string}", "refreshTokenExpiryTime": "{date-time}"}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 | ||
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "user": { "id": "{string}", "userName": "{string}", "fullName": "{string}", "email": "{string}", "role": "{integer}" }}Fetch users
Auth
Query String
| startIndex | integer | maximum: 2147483647 minimum: 0 | |
| count | integer | maximum: 2147483647 minimum: 1 | |
| orderType | |||
| orderBy | |||
| searchText | string | pattern: |
GET /api/user/requests
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/user/requests' \ --header 'Authorization: Bearer {token}' \ --data startIndex={startIndex} \ --data count={count} \ --data orderType={orderType} \ --data orderBy={orderBy} \ --data searchText={searchText}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 | ||
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "user": { "id": "{string}", "userName": "{string}", "fullName": "{string}", "email": "{string}", "role": "{integer}" }}Update current user
Auth
Request Body
| object | object | ||
| userId | string | ||
| role | integer |
Enum: | |
| userName | string | ||
| fullName | string | ||
| currentPassword | string | ||
| newPassword | string | ||
| string | |||
| accountSecurity | |||
| object | object | ||
| incrementalDelay | string | ||
| failedLoginDate | date-time |
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}", "accountSecurity": { "incrementalDelay": "{string}", "failedLoginDate": "{date-time}" }}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "user": { "id": "{string}", "userName": "{string}", "fullName": "{string}", "email": "{string}", "role": "{integer}" }}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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}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 | ||
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "user": { "id": "{string}", "userName": "{string}", "fullName": "{string}", "email": "{string}", "role": "{integer}" }}User Tour
Finalize and list user tours
Fetch tours completed by a user
Auth
Path Params
| userId | string |
GET /api/usertour/{userId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/usertour/%7BuserId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| userId | string | ||
| userTours | array[object] | ||
| tourType | integer |
Enum: | |
| finalizedDate | date-time |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "userId": "{string}", "userTours": [ { "tourType": "{integer}", "finalizedDate": "{date-time}" } ]}Mark a specific Tour as completed by a user
Auth
Request Body
| object | object | ||
| userId | string | minLength: 1 | |
| userTourType | integer |
Enum: |
POST /api/usertour/finalizeUserTour
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/usertour/finalizeUserTour' \ --header 'Authorization: Bearer {token}' \ --data '{ "userId": "{string}", "userTourType": "{integer}"}'Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}File event trigger of real time processing
This endpoint takes the parameters and tries to find the file in the specified storage and applies the workflow 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 | ||
| correlationId | string |
400
404
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "correlationId": "{string}"}File 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 workflow 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 | ||
| correlationId | string |
400
404
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "correlationId": "{string}"}File event trigger of real time processing for Box
This endpoint takes the parameter and tries to find the file in the specified Box storage and applies the workflow for the specified file
Auth
Path Params
| storageClientId | string |
Request Body
| No request body |
POST /api/webhook/realtime/public/{storageClientId}
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/webhook/realtime/public/%7BstorageClientId%7D'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| correlationId | string |
400
404
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "correlationId": "{string}"}{scanId}
Auth
Path Params
| storageClientId | string | ||
| scanId | string |
Query String
| validationToken | string |
Request Body
| No request body |
POST /api/webhook/realtime/graph/{storageClientId}/{scanId}
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/webhook/realtime/graph/%7BstorageClientId%7D/%7BscanId%7D' \ --data validationToken={validationToken}Responses
200
| file | file |
Response
xxxxxxxxxx{ "schema": "{file}"}Workflow
List, add, update and delete Workflows
Get Workflows
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 | ||
| entries | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entries": [ { "id": "{string}", "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "type": "{integer}", "workflowSupportedTechnologies": { "dlp": { "status": "{integer}" }, "deepCdr": { "status": "{integer}" }, "sandBox": { "status": "{integer}" }, "metascan": { "status": "{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": { "id": "{string}", "minimumSize": "{int64}", "maximumSize": "{int64}", "minimumDateTime": "{date-time}", "maximumDateTime": "{date-time}" }, "fileDefinition": { "blockingStrategy": "{integer}", "configurableBlockingStrategy": { "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}", "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}" } }, "remediations": [ { "id": "{string}", "workflowId": "{string}", "isEnabled": "{boolean}", "configuration": "{string}", "type": "{integer}", "handlingType": "{integer}" } ] } ]}Expand
Add a new Workflow
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 | ||
| workflowId | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "workflowId": "{string}"}Update an existing Workflow
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 | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean |
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}" }, "fileDefinition": { "blockingStrategy": "{integer}", "configurableBlockingStrategy": { "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}", "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}" } }}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Get Workflow 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 | ||
| entry | |||
| object | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "entry": { "id": "{string}", "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "type": "{integer}", "workflowSupportedTechnologies": { "dlp": { "status": "{integer}" }, "deepCdr": { "status": "{integer}" }, "sandBox": { "status": "{integer}" }, "metascan": { "status": "{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": { "id": "{string}", "minimumSize": "{int64}", "maximumSize": "{int64}", "minimumDateTime": "{date-time}", "maximumDateTime": "{date-time}" }, "fileDefinition": { "blockingStrategy": "{integer}", "configurableBlockingStrategy": { "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}", "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}" } }, "remediations": [ { "id": "{string}", "workflowId": "{string}", "isEnabled": "{boolean}", "configuration": "{string}", "type": "{integer}", "handlingType": "{integer}" } ] }}Expand
Delete a Workflow
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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Set a Workflow 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 |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}Refresh supported technologies for a Workflow and return updated Workflow
Auth
Request Body
| object | object | ||
| workflowId | string |
POST /api/workflow/enabledTechnologies
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/workflow/enabledTechnologies' \ --header 'Authorization: Bearer {token}' \ --data '{ "workflowId": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| workflowDto | |||
| object | object | ||
| id | string | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| type | integer |
Enum: | |
| workflowSupportedTechnologies | |||
| object | object | ||
| dlp | object | ||
| status | integer |
Enum: | |
| deepCdr | object | ||
| status | integer |
Enum: | |
| sandBox | object | ||
| status | integer |
Enum: | |
| metascan | object | ||
| status | 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 | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
Expand
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "workflowDto": { "id": "{string}", "scanPoolId": "{string}", "rules": [ "{array[string]...}" ], "type": "{integer}", "workflowSupportedTechnologies": { "dlp": { "status": "{integer}" }, "deepCdr": { "status": "{integer}" }, "sandBox": { "status": "{integer}" }, "metascan": { "status": "{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": { "id": "{string}", "minimumSize": "{int64}", "maximumSize": "{int64}", "minimumDateTime": "{date-time}", "maximumDateTime": "{date-time}" }, "fileDefinition": { "blockingStrategy": "{integer}", "configurableBlockingStrategy": { "shouldTreatFilesWithSensitiveDataAsBlocked": "{boolean}", "shouldTreatFilesWithVulnerabilitiesAsBlocked": "{boolean}" } }, "remediations": [ { "id": "{string}", "workflowId": "{string}", "isEnabled": "{boolean}", "configuration": "{string}", "type": "{integer}", "handlingType": "{integer}" } ] }}Expand
tenant
Auth
GET /api/tenant
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/tenant' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| tenants | array[object] | ||
| id | string | ||
| customerName | string | ||
| createdAt | date-time | ||
| lastUpdated | date-time |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "tenants": [ { "id": "{string}", "customerName": "{string}", "createdAt": "{date-time}", "lastUpdated": "{date-time}" } ]}tenant
Auth
Request Body
| object | object | ||
| customerName | string | minLength: 1 pattern: |
POST /api/tenant
xxxxxxxxxxcurl --request POST \ --url 'http://<MDSS_HOST>/api/tenant' \ --header 'Authorization: Bearer {token}' \ --data '{ "customerName": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| tenant | |||
| object | object | ||
| id | string | ||
| customerName | string | ||
| createdAt | date-time | ||
| lastUpdated | date-time |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "tenant": { "id": "{string}", "customerName": "{string}", "createdAt": "{date-time}", "lastUpdated": "{date-time}" }}{tenantId}
Auth
Path Params
| tenantId | string |
GET /api/tenant/{tenantId}
xxxxxxxxxxcurl --get \ --url 'http://<MDSS_HOST>/api/tenant/%7BtenantId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| tenant | |||
| object | object | ||
| id | string | ||
| customerName | string | ||
| createdAt | date-time | ||
| lastUpdated | date-time |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "tenant": { "id": "{string}", "customerName": "{string}", "createdAt": "{date-time}", "lastUpdated": "{date-time}" }}{tenantId}
Auth
Path Params
| tenantId | string |
Request Body
| object | object | ||
| customerName | string | minLength: 1 pattern: |
PUT /api/tenant/{tenantId}
xxxxxxxxxxcurl --request PUT \ --url 'http://<MDSS_HOST>/api/tenant/%7BtenantId%7D' \ --header 'Authorization: Bearer {token}' \ --data '{ "customerName": "{string}"}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| tenant | |||
| object | object | ||
| id | string | ||
| customerName | string | ||
| createdAt | date-time | ||
| lastUpdated | date-time |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "tenant": { "id": "{string}", "customerName": "{string}", "createdAt": "{date-time}", "lastUpdated": "{date-time}" }}{tenantId}
Auth
Path Params
| tenantId | string |
DELETE /api/tenant/{tenantId}
xxxxxxxxxxcurl --request DELETE \ --url 'http://<MDSS_HOST>/api/tenant/%7BtenantId%7D' \ --header 'Authorization: Bearer {token}'Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| tenant | |||
| object | object | ||
| id | string | ||
| customerName | string | ||
| createdAt | date-time | ||
| lastUpdated | date-time |
Response
xxxxxxxxxx{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}, "tenant": { "id": "{string}", "customerName": "{string}", "createdAt": "{date-time}", "lastUpdated": "{date-time}" }}
