MetaDefender Storage Security API
4.6.0
Search this version
MetaDefender Storage Security API
About this REST API
Useful links
Authentication
GETGet Roles
POSTCreate Role
GETGet Role by ID
PUTUpdate Role
DELETEDelete Role
GETGet Permissions
POSTCreate Permission
DELETEDelete Permission
POSTAssign Permission to Role
DELETERemove Permission from Role
POSTAssign Role to User
PUTReplace User Roles
DELETERemove Role from User
POSTAssign Permission to User
DELETERemove Permission from User
POSTAdd an account
GETFetch all accounts
PATCHUpdate an account
DELETEDelete an account
GETFetch account by ID
GETFetch available storage units for an account
GETFetch the number of accounts
GETFetch account sources
GETFetch audit logs
GETExport configuration file
POSTImport configuration file
GETGet enabled modules
GETRetrieve external loggers
PUTUpdate external logger state
POSTAdd a new Syslog server configuration
PUTUpdate a Syslog server configuration
POSTAdd a new Kafka server configuration
PUTUpdate a Kafka server configuration
DELETEDelete external logger
PUTRescan a file on demand
GETEnumerate processed files
PUTRescan multiple files on demand
GETFetch processing results for a file
GETRetrieve archive scan results
POSTCancel a file in an ongoing scan
POSTAdd a group
GETFetch all groups
PATCHUpdate a group
DELETEDelete a group
GETFetch group by ID
GETFetch the number of groups
GETGet health status
GETFetch onboarding configuration
POSTFinish onboarding
POSTAccept Eula
GETGet Remediations by workflow id
GETGet Remediation by id
DELETEDelete Remediation
POSTAdd Remediation
PATCHUpdate Remediation
GETGet scans report
GETDownload PDF Report
GETGet scan by ID
POSTStart a scan
POSTStop a scan
DELETEDelete scans
GETFetch last completed scan
GETGet an active scan by scan ID
GETGet Real-Time scan by storage Id
GETGet Scan Instances
POSTAdd a new Scan Instance
PUTUpdate an existing Scan Instance
GETGet Scan Instance by ID
DELETEDelete a Scan Instance
POSTTest
GETGet Scan Pools
POSTAdd a new Scan Pool
PUTUpdate an existing Scan Pool
GETGet Scan Pool by ID
DELETEDelete a Scan Pool
GETGet all scan workflow snapshots by scan ID
PUTUpdate notifications configuration
GETGet notifications configuration
PATCHUpdate SMTP configuration
GETFetch SMTP configuration
POSTOnline license activation
POSTOffline license activation
GETGet license details
POSTDeactivate license
PUTUpdate retention configuration
GETFetch retention configuration
POSTGenerate encryption key
GETGet encryption key creation date
POSTUpdate SSL configuration
GETGet SSL configuration
POSTUpdate Single User Session
GETGet Single User Session
GETGet Telemetry configuration
POSTUpdate Telemetry configuration
GETGet Sso Configuration
PATCHUpdate Sso Configuration
GETFetch all storage units
GETFetch storage by ID
PATCHUpdate a storage
DELETEDelete a storage
GETFetch storage users
POSTAdd a storage
POSTAdd batch of storages
GETGet batch of add storages results
GETFetch all storage units by filters (storage type or status)
PUTAdd a scan schedule
PUTUpdate a scan schedule
GETFetch scan schedules
DELETEDelete scan schedules
GETRetrieve storage user name
GETRetrieve storage user name
GETFetch active users
POSTRegister a user
POSTCreate a user
POSTAuthenticate with a username and password
GETFetch current user information
POSTRefresh user token
POSTLogout
PUTUpdate user role
GETFetch users
DELETEDelete a user
PUTUpdate current user
POSTRequest password reset
POSTReset user password
GETGet User Permissions
GETFetch tours completed by a user
POSTMark a specific Tour as completed by a user
POSTFile event trigger of real time processing
POSTFile event trigger of real time processing by storage client ID
POSTFile event trigger of real time processing by storage client ID
POSTFile event trigger of real time processing for Box
POSTFile event trigger of real time processing for Box
POSTFile event trigger of real time processing for Box
POST{scanId}
POST{scanId}
GETGet Workflows
POSTAdd a new Workflow
PATCHUpdate an existing Workflow
GETGet Workflow by ID
DELETEDelete a Workflow
POSTSet a Workflow as default
POSTRefresh supported technologies for a Workflow and return updated Workflow
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.
Abac
Attribute-Based Access Control management endpoints
Endpoints
Get Roles
Retrieve all ABAC roles. Set includePermissions to true to include the full permission list for each role.
Auth
Query String
| includePermissions | boolean | Default: true |
GET /api/abac/roles
curl --get \
--url 'http://<MDSS_HOST>/api/abac/roles' \
--header 'Authorization: Bearer {token}' \
--data includePermissions=true
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| roles3 fields | array[object] | ||
| id | string | ||
| name | string | ||
| permissions3 fields | array[object] | ||
| id | string | ||
| action | string | ||
| resource | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"roles": [
{
"id": "{string}",
"name": "{string}",
"permissions": [
{
"id": "{string}",
"action": "{string}",
"resource": "{string}"
}
]
}
]
}
Create Role
Create a new ABAC role. Provide an optional templateRoleId to inherit all permissions from an existing role; any IDs in permissionIds are merged on top of the template.
Auth
Request Body
| object | object | ||
| name | string | maxLength: 100 minLength: 3 | |
| permissionIds | array[string] | ||
| templateRoleId | string |
POST /api/abac/roles
curl --request POST \
--url 'http://<MDSS_HOST>/api/abac/roles' \
--header 'Authorization: Bearer {token}' \
--data '{
"name": "{string}",
"permissionIds": [
"{array[string]...}"
],
"templateRoleId": "{string}"
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| role | |||
| object | object | ||
| id | string | ||
| name | string | ||
| permissions3 fields | array[object] | ||
| id | string | ||
| action | string | ||
| resource | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"role": {
"id": "{string}",
"name": "{string}",
"permissions": [
{
"id": "{string}",
"action": "{string}",
"resource": "{string}"
}
]
}
}
Get Role by ID
Retrieve a single role and its associated permissions by role ID.
Auth
Path Params
| roleId | string |
GET /api/abac/roles/{roleId}
curl --get \
--url 'http://<MDSS_HOST>/api/abac/roles/{roleId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| role | |||
| object | object | ||
| id | string | ||
| name | string | ||
| permissions3 fields | array[object] | ||
| id | string | ||
| action | string | ||
| resource | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"role": {
"id": "{string}",
"name": "{string}",
"permissions": [
{
"id": "{string}",
"action": "{string}",
"resource": "{string}"
}
]
}
}
Update Role
Replace an existing role's name and full permission set in a single operation. The supplied permissionIds become the role's complete permission list (previously assigned permissions not in the list are removed). Predefined system roles cannot be updated.
Auth
Path Params
| roleId | string |
Request Body
| object | object | ||
| name | string | maxLength: 100 minLength: 3 | |
| permissionIds | array[string] |
PUT /api/abac/roles/{roleId}
curl --request PUT \
--url 'http://<MDSS_HOST>/api/abac/roles/{roleId}' \
--header 'Authorization: Bearer {token}' \
--data '{
"name": "{string}",
"permissionIds": [
"{array[string]...}"
]
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Delete Role
Permanently delete a role. Predefined system roles cannot be deleted.
Auth
Path Params
| roleId | string |
DELETE /api/abac/roles/{roleId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/abac/roles/{roleId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Get Permissions
Retrieve all available ABAC permissions (action + resource pairs).
Auth
GET /api/abac/permissions
curl --get \
--url 'http://<MDSS_HOST>/api/abac/permissions' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| permissions3 fields | array[object] | ||
| id | string | ||
| action | string | ||
| resource | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"permissions": [
{
"id": "{string}",
"action": "{string}",
"resource": "{string}"
}
]
}
Create Permission
Create a new ABAC permission defined by an action and a resource.
Auth
Request Body
| object | object | ||
| action | string | minLength: 1 | |
| resource | string | minLength: 1 |
POST /api/abac/permissions
curl --request POST \
--url 'http://<MDSS_HOST>/api/abac/permissions' \
--header 'Authorization: Bearer {token}' \
--data '{
"action": "{string}",
"resource": "{string}"
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| permission | |||
| object | object | ||
| id | string | ||
| action | string | ||
| resource | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"permission": {
"id": "{string}",
"action": "{string}",
"resource": "{string}"
}
}
Delete Permission
Permanently delete a permission by ID. Predefined base permissions cannot be deleted.
Auth
Path Params
| permissionId | string |
DELETE /api/abac/permissions/{permissionId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/abac/permissions/{permissionId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Assign Permission to Role
Assign a permission to the specified role.
Auth
Path Params
| roleId | string |
Request Body
| object | object | ||
| permissionId | string | minLength: 1 |
POST /api/abac/roles/{roleId}/permissions
curl --request POST \
--url 'http://<MDSS_HOST>/api/abac/roles/{roleId}/permissions' \
--header 'Authorization: Bearer {token}' \
--data '{
"permissionId": "{string}"
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Remove Permission from Role
Remove a permission from the specified role. Permissions that were assigned to a predefined role during initialization cannot be removed.
Auth
Path Params
| roleId | string | ||
| permissionId | string |
DELETE /api/abac/roles/{roleId}/permissions/{permissionId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/abac/roles/{roleId}/permissions/{permissionId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Assign Role to User
Assign a role to a user, optionally with an expiry date after which the assignment is no longer valid.
Auth
Path Params
| userId | string |
Request Body
| object | object | ||
| roleId | string | minLength: 1 | |
| expiresAt | date-time |
POST /api/abac/users/{userId}/roles
curl --request POST \
--url 'http://<MDSS_HOST>/api/abac/users/{userId}/roles' \
--header 'Authorization: Bearer {token}' \
--data '{
"roleId": "{string}",
"expiresAt": "{date-time}"
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| roleBindingId | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"roleBindingId": "{string}"
}
Replace User Roles
Atomically replace all role assignments for a user with the provided set of role IDs. All existing role bindings are removed and new ones are created in a single transaction.
Auth
Path Params
| userId | string |
Request Body
| object | object | ||
| roleIds | array[string] |
PUT /api/abac/users/{userId}/roles
curl --request PUT \
--url 'http://<MDSS_HOST>/api/abac/users/{userId}/roles' \
--header 'Authorization: Bearer {token}' \
--data '{
"roleIds": [
"{array[string]...}"
]
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Remove Role from User
Remove a role binding from a user using the role binding ID.
Auth
Path Params
| userId | string | ||
| roleBindingId | string |
DELETE /api/abac/users/{userId}/roles/{roleBindingId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/abac/users/{userId}/roles/{roleBindingId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Assign Permission to User
Assign a permission directly to a user, optionally with an expiry date.
Auth
Path Params
| userId | string |
Request Body
| object | object | ||
| permissionId | string | minLength: 1 | |
| expiresAt | date-time |
POST /api/abac/users/{userId}/permissions
curl --request POST \
--url 'http://<MDSS_HOST>/api/abac/users/{userId}/permissions' \
--header 'Authorization: Bearer {token}' \
--data '{
"permissionId": "{string}",
"expiresAt": "{date-time}"
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| userPermissionId | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"userPermissionId": "{string}"
}
Remove Permission from User
Remove a directly assigned permission from a user using the user permission ID.
Auth
Path Params
| userId | string | ||
| userPermissionId | string |
DELETE /api/abac/users/{userId}/permissions/{userPermissionId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/abac/users/{userId}/permissions/{userPermissionId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Add an account
Add a new storage account to the system
Auth
Query String
| Name | string | display name for the account | |
| Description | string | description of the account purpose or scope | |
| Credentials | string | access credentials for the storage service | |
| ProtocolType | type of protocol (0 = SMB, 1 = S3, etc.) | ||
| VendorType | vendor type of storage (0 = AmazonS3, 1 = OneDrive, etc.) | ||
| AutoDiscovery | boolean | if true, enables automatic storage detection | |
| GroupId | string | id of the group account storages should be added to by default | |
| StorageIds | array | id's of specific storage units under this account |
Request Body
| object | object | ||
| CredentialsFile | file |
POST /api/account
curl --request POST \
--url 'http://<MDSS_HOST>/api/account' \
--header 'Authorization: Bearer {token}' \
--data Name={Name} \
--data Description={Description} \
--data Credentials={Credentials} \
--data ProtocolType={ProtocolType} \
--data 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: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"account": {
"id": "{string}",
"name": "{string}",
"description": "{string}",
"credentials": "{string}",
"protocolType": "{integer}",
"vendorType": "{integer}",
"autoDiscovery": "{boolean}",
"autodiscoveryDestinationGroupId": "{string}"
}
}
Fetch all accounts
Retrieve a list of all configured accounts
Auth
GET /api/account
curl --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 | ||
| accounts9 fields | array[object] | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages12 fields | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType4 fields | 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 | ||
| vendorType | int32 |
Response
{
"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}",
"vendorType": "{int32}"
}
]
}
Update an account
Update an existing account's configuration
Auth
Query String
| AccountId | string | id of the account to update | |
| Name | string | display name for the account | |
| Description | string | description of the account purpose or scope | |
| Credentials | string | access credentials for the storage service | |
| ProtocolType | type of protocol (0 = SMB, 1 = S3, etc.) | ||
| VendorType | vendor type of storage (0 = AmazonS3, 1 = OneDrive, etc.) | ||
| AutoDiscovery | boolean | if true, enables automatic storage detection | |
| GroupId | string | id of the group account storages should be added to by default |
Request Body
| object | object | ||
| CredentialsFile | file |
PATCH /api/account
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/account' \
--header 'Authorization: Bearer {token}' \
--data AccountId={AccountId} \
--data Name={Name} \
--data Description={Description} \
--data Credentials={Credentials} \
--data ProtocolType={ProtocolType} \
--data 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
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"accountId": "{string}"
}
Delete an account
Permanently delete an account and its storage references
Auth
Path Params
| accountId | string | id of the account to delete |
DELETE /api/account/{accountId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/account/{accountId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| accountId | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"accountId": "{string}"
}
Fetch account by ID
Retrieve a single account's details by ID
Auth
Path Params
| accountId | string | id of the account to get |
GET /api/account/{accountId}
curl --get \
--url 'http://<MDSS_HOST>/api/account/{accountId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| account9 fields | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages12 fields | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType4 fields | 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 | ||
| vendorType | int32 |
Response
{
"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}",
"vendorType": "{int32}"
}
}
Fetch available storage units for an account
List all storage units linked to a particular account
Auth
Path Params
| accountId | string | ID of the account |
GET /api/account/{accountId}/storages
curl --get \
--url 'http://<MDSS_HOST>/api/account/{accountId}/storages' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| autodiscoverySource | string | ||
| autodiscoverySourceUrl | string | ||
| protocolType | int32 | ||
| vendorType | int32 |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"entries": [
{
"autodiscoverySource": "{string}",
"autodiscoverySourceUrl": "{string}"
}
],
"protocolType": "{int32}",
"vendorType": "{int32}"
}
Fetch the number of accounts
Get the total number of accounts in the system
Auth
GET /api/account/count
curl --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 | ||
| count | int64 |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"accountCount": {
"count": "{int64}"
}
}
Fetch account sources
Fetch account sources
Auth
Path Params
| accountId | string |
Query String
| filter | string |
GET /api/account/{accountId}/sources
curl --get \
--url 'http://<MDSS_HOST>/api/account/{accountId}/sources' \
--header 'Authorization: Bearer {token}' \
--data filter={filter}
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[string] |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"entries": [
"{array[string]...}"
]
}
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}
curl --get \
--url 'http://<MDSS_HOST>/api/audit/{startIndex}/{count}' \
--header 'Authorization: Bearer {token}' \
--data logType={logType} \
--data categoryType={categoryType} \
--data logLevel={logLevel} \
--data searchText={searchText}
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries8 fields | 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 |
Response
{
"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 | ||
| exportNotifications | boolean | ||
| exportRetention | boolean | ||
| exportUsers | boolean | ||
| password | string |
GET /api/configuration/export
curl --get \
--url 'http://<MDSS_HOST>/api/configuration/export' \
--header 'Authorization: Bearer {token}' \
--data exportLicense={exportLicense} \
--data exportSmtp={exportSmtp} \
--data exportNotifications={exportNotifications} \
--data exportRetention={exportRetention} \
--data exportUsers={exportUsers} \
--data password={password}
Responses
200
| file | file |
Response
{
"schema": "{file}"
}
Import configuration file
Auth
Request Body
| object | object | ||
| ConfigurationFile | file | ||
| password | string |
POST /api/configuration/import
curl --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 | ||
| areNotificationsImported | boolean | ||
| hasNotificationsPartialFailure | boolean | ||
| activationDto | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| newLocalUserId | string | ||
| areUsersImported | boolean |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"areSmtpSettingsImported": "{boolean}",
"isLicenseImported": "{boolean}",
"isRetentionImported": "{boolean}",
"areNotificationsImported": "{boolean}",
"hasNotificationsPartialFailure": "{boolean}",
"activationDto": {
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
},
"newLocalUserId": "{string}",
"areUsersImported": "{boolean}"
}
Get enabled modules
Auth
GET /api/configuration/enabledModules
curl --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
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"enabledModules": [
"{array[integer]...}"
]
}
External Logger
Manage external loggers
Retrieve external loggers
Auth
GET /api/externallogger
curl --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 | ||
| entries4 fields | array[object] | ||
| id | string | ||
| isEnabled | boolean | ||
| loggerType | integer |
Enum: | |
| connectionSettings | |||
| object | object | ||
| $type | string |
Response
{
"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
curl --request PUT \
--url 'http://<MDSS_HOST>/api/externallogger/status' \
--header 'Authorization: Bearer {token}' \
--data '{
"id": "{string}",
"isEnabled": "{boolean}"
}'
Responses
200
| file | file |
Response
{
"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 |
POST /api/externallogger/udpSyslog
curl --request POST \
--url 'http://<MDSS_HOST>/api/externallogger/udpSyslog' \
--header 'Authorization: Bearer {token}' \
--data '{
"isEnabled": "{boolean}",
"serverAddress": "{string}",
"port": "{int32}",
"loggerType": "{integer}",
"facility": "{integer}",
"format": "{integer}",
"$type": "{string}"
}'
Responses
200
| file | file |
Response
{
"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 |
PUT /api/externallogger/udpSyslog
curl --request PUT \
--url 'http://<MDSS_HOST>/api/externallogger/udpSyslog' \
--header 'Authorization: Bearer {token}' \
--data '{
"isEnabled": "{boolean}",
"serverAddress": "{string}",
"port": "{int32}",
"loggerType": "{integer}",
"facility": "{integer}",
"format": "{integer}",
"$type": "{string}",
"id": "{string}"
}'
Responses
200
| file | file |
Response
{
"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 |
POST /api/externallogger/kafka
curl --request POST \
--url 'http://<MDSS_HOST>/api/externallogger/kafka' \
--header 'Authorization: Bearer {token}' \
--data '{
"isEnabled": "{boolean}",
"serverAddressWithPortList": "{string}",
"loggerType": "{integer}",
"topic": "{string}",
"configuration": "{string}",
"$type": "{string}"
}'
Responses
200
| file | file |
Response
{
"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 |
PUT /api/externallogger/kafka
curl --request PUT \
--url 'http://<MDSS_HOST>/api/externallogger/kafka' \
--header 'Authorization: Bearer {token}' \
--data '{
"isEnabled": "{boolean}",
"serverAddressWithPortList": "{string}",
"loggerType": "{integer}",
"topic": "{string}",
"configuration": "{string}",
"$type": "{string}",
"id": "{string}"
}'
Responses
200
| file | file |
Response
{
"schema": "{file}"
}
Delete external logger
Auth
Path Params
| id | string |
DELETE /api/externallogger/{id}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/externallogger/{id}' \
--header 'Authorization: Bearer {token}'
Responses
200
| file | file |
Response
{
"schema": "{file}"
}
File
Retrieve processed files information
Rescan 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 | ID of the file to rescan | |
| fileIds | array[string] | IDs of the files to rescan | |
| scanId | string | scan ID associated with the file minLength: 1 | |
| storageProtocolType | int32 | protocol used by the storage (e.g., SMB, S3) | |
| passwords | array[string] | optional passwords for encrypted file scanning | |
| workflowId | string | workflow ID to be used for the on-demand scan minLength: 1 |
PUT /api/file
curl --request PUT \
--url 'http://<MDSS_HOST>/api/file' \
--header 'Authorization: Bearer {token}' \
--data '{
"fileId": "{string}",
"fileIds": [
"{array[string]...}"
],
"scanId": "{string}",
"storageProtocolType": "{int32}",
"passwords": [
"{array[string]...}"
],
"workflowId": "{string}"
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Enumerate processed files
Auth
Query String
| StartIndex | integer | starting position for pagination (0-based index) maximum: 2147483647 minimum: 0 | |
| Count | integer | maximum: 10000 minimum: 1 | |
| StartDate | string | filter files by scan date | |
| EndDate | string | filter files by scan date | |
| Search | string | text filter | |
| ScanType | array | scan type such as (on-demand, scheduled, real time) Enum: | |
| StorageId | array | filter based on a list of possible storage id | |
| ScanId | array | filter based on a list of possible scan id | |
| ScanWorkflowSnapshotId | array | filter based on a list of possible scan workflow snapshot id | |
| ProcessingState | array | Enum: | |
| Result | array | filter by scan result (0 = Clean, 1 = Blocked, 2 = Processing) Enum: | |
| ScanAllResultI | array | filter by MD Core scan result (0 = NoThreatDetected, 1 = Infected, 2 = Suspicious, etc.) Enum: | |
| ScanResultICount | array | the number of engine results that are not "No threat detected" | |
| SandboxVerdict | array | filter by Sandbox verdict (0 = NoThreat, 1 = Malicious, 2 = Suspicious) Enum: | |
| VulnerabilityCount | array | the number of vulnerabilities detected | |
| HasVulnerabilities | boolean | filter by presence of vulnerabilities | |
| DlpDetection | boolean | DLP detection | |
| HasBlockedFileVersions | boolean | filter by presence of blocked file versions | |
| Remediations | array | filter by remediation performed on the file Enum: | |
| SkippedScan | boolean | filter by whether the scan was skipped | |
| SortBy | array | Enum: | |
| SortOrder | array | Enum: | |
| Expand | array | Possible values for expand: workflow_snapshot |
GET /api/file
curl --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 SandboxVerdict={SandboxVerdict} \
--data VulnerabilityCount={VulnerabilityCount} \
--data HasVulnerabilities={HasVulnerabilities} \
--data DlpDetection={DlpDetection} \
--data HasBlockedFileVersions={HasBlockedFileVersions} \
--data Remediations={Remediations} \
--data SkippedScan={SkippedScan} \
--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 | ||
| fileOwner4 fields | object | ||
| userId | string | ||
| fullName | string | ||
| userName | string | ||
| emailAddress | string | ||
| size | int64 | ||
| fileTypeCategory | |||
| integer | integer |
Enum: | |
| extension | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageName | string | ||
| storageLocation | string | ||
| scanName | string | ||
| progress | |||
| object | object | ||
| upload | integer | ||
| scan | integer | ||
| scanResult | |||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails7 fields | 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 | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups3 fields | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals3 fields | array[object] | ||
| originType | string | ||
| signalReadable | string | ||
| strength | number | ||
| errorCategory | string | ||
| errorCode | int32 | ||
| errorDetails | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | |||
| object | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| 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 | ||
| dependencies | |||
| object | 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 | ||
| vulnerabilities5 fields | 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 | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines5 fields | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | 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 | ||
| coreEngines5 fields | 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 | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| cdrObjectState | |||
| integer | integer |
Enum: | |
| fileWasReplaced | boolean | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions10 fields | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| cdrObjectState | |||
| integer | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| remediationId | string | ||
| tenantId | string | ||
| lastUpdated | date-time | ||
| metaDefenderCoreUrl | string | ||
| discoveryStartedDaySec | int64 | ||
| objectStorageMetadata | string | ||
| scanWorkflowSnapshotId | string | ||
| scanWorkflowSnapshot | |||
| object | object | ||
| id | string | ||
| scanId | string | ||
| workflow17 fields | object | ||
| id | string | ||
| scanPoolId | string | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | int32 | ||
| 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 | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters5 fields | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations6 fields | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances6 fields | 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 | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| workflowStatistics12 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| realTimeStartDate | date-time | ||
| versions | array[object] | ||
| hasBlockedVersions | boolean | ||
| versionsCount | int32 | ||
| objectType | integer |
Enum: | |
| skippedScan | boolean | ||
| $type | string | ||
| filterCount | int64 | ||
| totalCount | int64 |
Response
{
"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}",
"fileTypeCategory": "{integer}",
"extension": "{string}"
}
],
"filterCount": "{int64}",
"totalCount": "{int64}"
}
Rescan multiple files on demand
This request is used to rescan and update existing files from a scan based on a filter.
Auth
Request Body
| object | object | ||
| scanId | string | scan ID associated with the file minLength: 1 | |
| workflowId | string | workflow ID to use when re-scanning minLength: 1 | |
| passwords | array[string] | optional passwords for encrypted file scanning | |
| filterParameters | Filters to select files to be re-scanned | ||
| object | object | ||
| expand | array[string] | Possible values for expand: workflow_snapshot | |
| startDate | date-time | filter files by scan date minLength: 1 | |
| endDate | date-time | filter files by scan date minLength: 1 | |
| search | string | text filter | |
| scanType | array[integer] | scan type such as (on-demand, scheduled, real time) Enum: | |
| storageId | array[string] | filter based on a list of possible storage id | |
| scanId | array[string] | filter based on a list of possible scan id | |
| scanWorkflowSnapshotId | array[string] | filter based on a list of possible scan workflow snapshot id | |
| processingState | array[integer] | Enum: | |
| result | array[integer] | filter by scan result (0 = Clean, 1 = Blocked, 2 = Processing) Enum: | |
| scanAllResultI | array[integer] | filter by MD Core scan result (0 = NoThreatDetected, 1 = Infected, 2 = Suspicious, etc.) Enum: | |
| scanResultICount | array[integer] | the number of engine results that are not "No threat detected" | |
| sandboxVerdict | array[integer] | filter by Sandbox verdict (0 = NoThreat, 1 = Malicious, 2 = Suspicious) Enum: | |
| vulnerabilityCount | array[integer] | the number of vulnerabilities detected | |
| hasVulnerabilities | boolean | filter by presence of vulnerabilities | |
| dlpDetection | boolean | DLP detection | |
| hasBlockedFileVersions | boolean | filter by presence of blocked file versions | |
| remediations | array[integer] | filter by remediation performed on the file Enum: | |
| skippedScan | boolean | filter by whether the scan was skipped | |
| sortBy | array[integer] | Enum: | |
| sortOrder | array[integer] | Enum: | |
| storageProtocolType | int32 | storage protocol type to use when re-scanning |
PUT /api/file/rescan
curl --request PUT \
--url 'http://<MDSS_HOST>/api/file/rescan' \
--header 'Authorization: Bearer {token}' \
--data '{
"scanId": "{string}",
"workflowId": "{string}",
"passwords": [
"{array[string]...}"
],
"filterParameters": {
"expand": [
"{array[string]...}"
],
"startDate": "{date-time}",
"endDate": "{date-time}",
"search": "{string}",
"scanType": [
"{array[integer]...}"
],
"storageId": [
"{array[string]...}"
],
"scanId": [
"{array[string]...}"
],
"scanWorkflowSnapshotId": [
"{array[string]...}"
],
"processingState": [
"{array[integer]...}"
],
"result": [
"{array[integer]...}"
],
"scanAllResultI": [
"{array[integer]...}"
],
"scanResultICount": [
"{array[integer]...}"
],
"sandboxVerdict": [
"{array[integer]...}"
],
"vulnerabilityCount": [
"{array[integer]...}"
],
"hasVulnerabilities": "{boolean}",
"dlpDetection": "{boolean}",
"hasBlockedFileVersions": "{boolean}",
"remediations": [
"{array[integer]...}"
],
"skippedScan": "{boolean}",
"sortBy": [
"{array[integer]...}"
],
"sortOrder": [
"{array[integer]...}"
]
},
"storageProtocolType": "{int32}"
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Fetch processing results for a file
File processing is done asynchronously and each analysis request is tracked by a file ID. Because processing a file is a potentially time-consuming operation, scheduling a file for processing and retrieving the results needs to be done using two separate API calls.
This request needs to be made multiple times until the analysis is complete. Analysis completion can be tracked using the processingState and the progress values from the response..
Auth
Path Params
| fileId | string |
Query String
| expand | array | Possible values for expand: workflow_snapshot |
GET /api/file/{fileId}
curl --get \
--url 'http://<MDSS_HOST>/api/file/{fileId}' \
--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 | integer | ||
| scan | integer | ||
| scanResult | Deprecated | ||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails7 fields | 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 | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups3 fields | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals3 fields | array[object] | ||
| originType | string | ||
| signalReadable | string | ||
| strength | number | ||
| errorCategory | string | ||
| errorCode | int32 | ||
| errorDetails | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | |||
| object | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| 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 | ||
| dependencies | |||
| object | 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 | ||
| vulnerabilities5 fields | 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 | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines5 fields | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | 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 | ||
| coreEngines5 fields | 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 | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| cdrObjectState | |||
| integer | integer |
Enum: | |
| fileWasReplaced | boolean | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions10 fields | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| cdrObjectState | |||
| integer | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| remediationId | string | ||
| 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 | ||
| fileOwner4 fields | object | ||
| userId | string | ||
| fullName | string | ||
| userName | string | ||
| emailAddress | string | ||
| size | int64 | ||
| fileTypeCategory | |||
| integer | integer |
Enum: | |
| extension | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageName | string | ||
| storageLocation | string | ||
| scanName | string | ||
| progress | |||
| object | object | ||
| upload | integer | ||
| scan | integer | ||
| scanResult | |||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails7 fields | 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 | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups3 fields | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals3 fields | array[object] | ||
| originType | string | ||
| signalReadable | string | ||
| strength | number | ||
| errorCategory | string | ||
| errorCode | int32 | ||
| errorDetails | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | |||
| object | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| 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 | ||
| dependencies | |||
| object | 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 | ||
| vulnerabilities5 fields | 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 | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines5 fields | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | 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 | ||
| coreEngines5 fields | 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 | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| cdrObjectState | |||
| integer | integer |
Enum: | |
| fileWasReplaced | boolean | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions10 fields | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| cdrObjectState | |||
| integer | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| remediationId | string | ||
| tenantId | string | ||
| lastUpdated | date-time | ||
| metaDefenderCoreUrl | string | ||
| discoveryStartedDaySec | int64 | ||
| objectStorageMetadata | string | ||
| scanWorkflowSnapshotId | string | ||
| scanWorkflowSnapshot | |||
| object | object | ||
| id | string | ||
| scanId | string | ||
| workflow17 fields | object | ||
| id | string | ||
| scanPoolId | string | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | int32 | ||
| 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 | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters5 fields | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations6 fields | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances6 fields | 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 | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| workflowStatistics12 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| realTimeStartDate | date-time | ||
| versions | array[object] | ||
| hasBlockedVersions | boolean | ||
| versionsCount | int32 | ||
| objectType | integer |
Enum: | |
| skippedScan | boolean | ||
| $type | string |
Response
›
›
{![]()
…![]()
}
Retrieve archive scan results
Retrieve the archive scan results using either the scanResultId or the parentId
Auth
Query String
| scanResultId | string | ||
| parentId | string | ||
| start | integer | Default: 0 | |
| count | integer | Default: 1000 |
GET /api/file/archive
curl --get \
--url 'http://<MDSS_HOST>/api/file/archive' \
--header 'Authorization: Bearer {token}' \
--data scanResultId={scanResultId} \
--data parentId={parentId} \
--data start={start} \
--data count=1000
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| archiveScanResults14 fields | array[object] | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails7 fields | 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 | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups3 fields | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals3 fields | array[object] | ||
| originType | string | ||
| signalReadable | string | ||
| strength | number | ||
| errorCategory | string | ||
| errorCode | int32 | ||
| errorDetails | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | |||
| object | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| 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 | ||
| dependencies | |||
| object | 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 | ||
| vulnerabilities5 fields | 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 | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines5 fields | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string |
Response
›
›
{![]()
…![]()
}
Cancel a file in an ongoing scan
Auth
Request Body
| object | object | ||
| fileIds | array[string] |
POST /api/file/cancel
curl --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 | integer | ||
| scan | integer | ||
| scanResult | Deprecated | ||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails7 fields | 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 | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups3 fields | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals3 fields | array[object] | ||
| originType | string | ||
| signalReadable | string | ||
| strength | number | ||
| errorCategory | string | ||
| errorCode | int32 | ||
| errorDetails | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | |||
| object | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| 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 | ||
| dependencies | |||
| object | 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 | ||
| vulnerabilities5 fields | 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 | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines5 fields | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | 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 | ||
| coreEngines5 fields | 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 | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| cdrObjectState | |||
| integer | integer |
Enum: | |
| fileWasReplaced | boolean | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions10 fields | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| cdrObjectState | |||
| integer | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| remediationId | string | ||
| 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 | ||
| fileOwner4 fields | object | ||
| userId | string | ||
| fullName | string | ||
| userName | string | ||
| emailAddress | string | ||
| size | int64 | ||
| fileTypeCategory | |||
| integer | integer |
Enum: | |
| extension | string | ||
| storageType | |||
| object | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageName | string | ||
| storageLocation | string | ||
| scanName | string | ||
| progress | |||
| object | object | ||
| upload | integer | ||
| scan | integer | ||
| scanResult | |||
| object | object | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails7 fields | 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 | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups3 fields | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals3 fields | array[object] | ||
| originType | string | ||
| signalReadable | string | ||
| strength | number | ||
| errorCategory | string | ||
| errorCode | int32 | ||
| errorDetails | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | |||
| object | 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 | ||
| allowed4 fields | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked4 fields | 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 | |||
| 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 | ||
| dependencies | |||
| object | 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 | ||
| vulnerabilities5 fields | 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 | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines5 fields | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | 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 | ||
| coreEngines5 fields | 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 | ||
| sanitizationDetails | |||
| object | object | ||
| failureCategory | string | ||
| details | string | ||
| cdrObjectState | |||
| integer | integer |
Enum: | |
| fileWasReplaced | boolean | ||
| postActionFailedInformation | array[object] | ||
| objectActionType | integer |
Enum: | |
| exception | |||
| object | object | ||
| exceptionDetails | string | ||
| exceptionMessage | string | ||
| objectRemediationActions10 fields | array[object] | ||
| objectActionType | integer |
Enum: | |
| objectActionState | integer |
Enum: | |
| cdrObjectState | |||
| integer | integer |
Enum: | |
| exceptions | array[string] | ||
| id | string | ||
| fileId | string | ||
| fileScanCompletedTime | date-time | ||
| remediationId | string | ||
| tenantId | string | ||
| lastUpdated | date-time | ||
| metaDefenderCoreUrl | string | ||
| discoveryStartedDaySec | int64 | ||
| objectStorageMetadata | string | ||
| scanWorkflowSnapshotId | string | ||
| scanWorkflowSnapshot | |||
| object | object | ||
| id | string | ||
| scanId | string | ||
| workflow17 fields | object | ||
| id | string | ||
| scanPoolId | string | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | int32 | ||
| 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 | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters5 fields | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations6 fields | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances6 fields | 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 | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| workflowStatistics12 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| realTimeStartDate | date-time | ||
| versions | array[object] | ||
| hasBlockedVersions | boolean | ||
| versionsCount | int32 | ||
| objectType | integer |
Enum: | |
| skippedScan | boolean | ||
| $type | string |
Response
›
›
{![]()
…![]()
}
Group
Manage your groups
Add a group
Auth
Request Body
| object | object | ||
| name | string | group name minLength: 1 | |
| description | string | description of the group | |
| storageIds | array[string] | associated storages |
POST /api/group
curl --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 | ||
| storages12 fields | array[object] | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 |
Response
{
"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}",
"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 all groups
Auth
GET /api/group
curl --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 | ||
| groups4 fields | array[object] | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages12 fields | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType4 fields | 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 |
Response
{
"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}"
}
]
}
]
}
Update a group
Auth
Request Body
| object | object | ||
| name | string | group name | |
| description | string | description of the group | |
| groupId | string | group id to update minLength: 1 |
PATCH /api/group
curl --request PATCH \
--url 'http://<MDSS_HOST>/api/group' \
--header 'Authorization: Bearer {token}' \
--data '{
"name": "{string}",
"description": "{string}",
"groupId": "{string}"
}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| updatedGroup | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages12 fields | array[object] | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 |
Response
{
"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}",
"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}"
}
]
}
}
Delete a group
Auth
Path Params
| groupId | string |
DELETE /api/group/{groupId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/group/{groupId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {}
}
Fetch group by ID
Auth
Path Params
| groupId | string |
GET /api/group/{groupId}
curl --get \
--url 'http://<MDSS_HOST>/api/group/{groupId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| group4 fields | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages12 fields | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType4 fields | 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 |
Response
{
"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}"
}
]
}
}
Fetch the number of groups
Auth
GET /api/group/count
curl --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
{
"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 | whether to include extra details Default: false |
GET /api/health
curl --get \
--url 'http://<MDSS_HOST>/api/health' \
--data verbose={verbose}
Responses
200
| object | object | ||
| apiStatus | string |
Response
{
"apiStatus": "{string}"
}
Onboarding
Manage onboarding
Fetch onboarding configuration
Auth
Query String
| newConfigSetup | boolean | ||
| newDefaultWorkflow | boolean |
GET /api/onboarding
curl --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
{
"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
curl --request POST \
--url 'http://<MDSS_HOST>/api/onboarding' \
--header 'Authorization: Bearer {token}'
Responses
200
| file | file |
Response
{
"schema": "{file}"
}
Accept Eula
Auth
POST /api/onboarding/eula
curl --request POST \
--url 'http://<MDSS_HOST>/api/onboarding/eula' \
--header 'Authorization: Bearer {token}'
Responses
200
| file | file |
Response
{
"schema": "{file}"
}
Remediations
Remediations information
Get Remediations by workflow id
Auth
Path Params
| id | string |
GET /api/remediations/workflow/{id}
curl --get \
--url 'http://<MDSS_HOST>/api/remediations/workflow/{id}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries6 fields | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
Response
{
"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}
curl --get \
--url 'http://<MDSS_HOST>/api/remediations/{id}' \
--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: |
Response
{
"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}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/remediations/{id}' \
--header 'Authorization: Bearer {token}'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
{
"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
curl --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
{
"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
curl --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
{
"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: | |
| realTimeHandlingType | |||
| startDate | string | ||
| endDate | string | ||
| sortBy | array | Enum: | |
| sortOrder | array | Enum: | |
| startIndex | integer | ||
| count | integer | ||
| workflowId | string |
GET /api/report
curl --get \
--url 'http://<MDSS_HOST>/api/report' \
--header 'Authorization: Bearer {token}' \
--data storageId={storageId} \
--data name={name} \
--data scanTypesFilter={scanTypesFilter} \
--data scanStatesFilter={scanStatesFilter} \
--data realTimeHandlingType={realTimeHandlingType} \
--data startDate={startDate} \
--data endDate={endDate} \
--data sortBy={sortBy} \
--data sortOrder={sortOrder} \
--data startIndex={startIndex} \
--data count={count} \
--data workflowId={workflowId}
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: | |
| scanStatusDto18 fields | object | ||
| pendingFilesCount | int64 | ||
| pendingFilesSize | int64 | ||
| allowedFilesCount | int64 | ||
| allowedFilesSize | int64 | ||
| blockedFilesCount | int64 | ||
| blockedFilesSize | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| totalFilesSize | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedSize | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| processedFilesSize | int64 | ||
| canceledFilesCount | int64 | ||
| canceledFilesSize | int64 | ||
| scanStatsDto7 fields | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| filesBlockedBySandboxCount | int64 | ||
| scannedFilesCount | int64 | ||
| skippedFilesScanCount | int64 | ||
| scanFilesDistribution | |||
| object | object | ||
| documentsEncryptedFilesCount | int64 | ||
| executablesFilesCount | int64 | ||
| audioVideoFilesCount | int64 | ||
| openSSlEncryptedFilesCount | int64 | ||
| pdfFilesCount | int64 | ||
| graphicalFilesCount | int64 | ||
| diskImageFilesCount | int64 | ||
| textFilesCount | int64 | ||
| mailFilesCount | int64 | ||
| applicationFilesCount | int64 | ||
| documentsFilesCount | int64 | ||
| otherFilesCount | int64 | ||
| archivesFilesCount | int64 | ||
| realTimeStartDate | date-time | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| scanPartition | string | ||
| workflowId | string | WorkflowId required if ScanConfigurationId is null minLength: 1 | |
| scanConfigurationId | string | This property is obsolete and will be removed in the future. Use WorkflowId instead. | |
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos13 fields | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow17 fields | object | ||
| id | string | ||
| scanPoolId | string | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | int32 | ||
| 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 | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters5 fields | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations6 fields | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances6 fields | 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 | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| workflowStatistics12 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| realTimeStartDate | date-time | ||
| storageId | string | ||
| $type | string | ||
| totalCount | int64 |
Response
›
⌄
⌄
⌄
⌄
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"entries": [
{
"result": "{integer}",
"responseKey": "{string}",
"responseMessage": "{string}",
"responseMessageParams": {},
"id": "{string}",
"name": "{string}",
"startTime": "{date-time}",
"stopTime": "{date-time}",
"scanType": "{string}",
"scanningState": "{integer}",
"scanStatusDto": {
"pendingFilesCount": "{int64}",
"pendingFilesSize": "{int64}",
"allowedFilesCount": "{int64}",
"allowedFilesSize": "{int64}",
"blockedFilesCount": "{int64}",
"blockedFilesSize": "{int64}",
"sanitizedFilesCount": "{int64}",
"failedSanitizedFilesCount": "{int64}",
"remediatedFilesCount": "{int64}",
"totalFilesCount": "{int64}",
"totalFilesSize": "{int64}",
"processingFailedCount": "{int64}",
"processingFailedSize": "{int64}",
"processingFailedRemediationCount": "{int64}",
"processedFilesCount": "{int64}",
"processedFilesSize": "{int64}",
"canceledFilesCount": "{int64}",
"canceledFilesSize": "{int64}"
Download PDF Report
Auth
Path Params
| scanId | string |
Query String
| TypeOfReport | integer | Enum: | |
| StartIndex | integer | starting position for pagination (0-based index) maximum: 2147483647 minimum: 0 | |
| Count | integer | maximum: 10000 minimum: 1 | |
| StartDate | string | filter files by scan date | |
| EndDate | string | filter files by scan date | |
| Search | string | text filter | |
| ScanType | array | scan type such as (on-demand, scheduled, real time) Enum: | |
| StorageId | array | filter based on a list of possible storage id | |
| ScanId | array | filter based on a list of possible scan id | |
| ScanWorkflowSnapshotId | array | filter based on a list of possible scan workflow snapshot id | |
| ProcessingState | array | Enum: | |
| Result | array | filter by scan result (0 = Clean, 1 = Blocked, 2 = Processing) Enum: | |
| ScanAllResultI | array | filter by MD Core scan result (0 = NoThreatDetected, 1 = Infected, 2 = Suspicious, etc.) Enum: | |
| ScanResultICount | array | the number of engine results that are not "No threat detected" | |
| SandboxVerdict | array | filter by Sandbox verdict (0 = NoThreat, 1 = Malicious, 2 = Suspicious) Enum: | |
| VulnerabilityCount | array | the number of vulnerabilities detected | |
| HasVulnerabilities | boolean | filter by presence of vulnerabilities | |
| DlpDetection | boolean | DLP detection | |
| HasBlockedFileVersions | boolean | filter by presence of blocked file versions | |
| Remediations | array | filter by remediation performed on the file Enum: | |
| SkippedScan | boolean | filter by whether the scan was skipped | |
| SortBy | array | Enum: | |
| SortOrder | array | Enum: | |
| Expand | array | Possible values for expand: workflow_snapshot |
GET /api/report/download/{scanId}
curl --get \
--url 'http://<MDSS_HOST>/api/report/download/{scanId}' \
--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 SandboxVerdict={SandboxVerdict} \
--data VulnerabilityCount={VulnerabilityCount} \
--data HasVulnerabilities={HasVulnerabilities} \
--data DlpDetection={DlpDetection} \
--data HasBlockedFileVersions={HasBlockedFileVersions} \
--data Remediations={Remediations} \
--data SkippedScan={SkippedScan} \
--data SortBy={SortBy} \
--data SortOrder={SortOrder} \
--data Expand={Expand}
Responses
200
| file | file |
Response
{
"schema": "{file}"
}
Get scan by ID
Auth
Path Params
| scanId | string |
GET /api/scan/{scanId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/{scanId}' \
--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: | |
| scanStatusDto18 fields | object | ||
| pendingFilesCount | int64 | ||
| pendingFilesSize | int64 | ||
| allowedFilesCount | int64 | ||
| allowedFilesSize | int64 | ||
| blockedFilesCount | int64 | ||
| blockedFilesSize | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| totalFilesSize | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedSize | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| processedFilesSize | int64 | ||
| canceledFilesCount | int64 | ||
| canceledFilesSize | int64 | ||
| scanStatsDto7 fields | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| filesBlockedBySandboxCount | int64 | ||
| scannedFilesCount | int64 | ||
| skippedFilesScanCount | int64 | ||
| scanFilesDistribution | |||
| object | object | ||
| documentsEncryptedFilesCount | int64 | ||
| executablesFilesCount | int64 | ||
| audioVideoFilesCount | int64 | ||
| openSSlEncryptedFilesCount | int64 | ||
| pdfFilesCount | int64 | ||
| graphicalFilesCount | int64 | ||
| diskImageFilesCount | int64 | ||
| textFilesCount | int64 | ||
| mailFilesCount | int64 | ||
| applicationFilesCount | int64 | ||
| documentsFilesCount | int64 | ||
| otherFilesCount | int64 | ||
| archivesFilesCount | int64 | ||
| realTimeStartDate | date-time | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| scanPartition | string | ||
| workflowId | string | WorkflowId required if ScanConfigurationId is null minLength: 1 | |
| scanConfigurationId | string | This property is obsolete and will be removed in the future. Use WorkflowId instead. | |
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos13 fields | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow17 fields | object | ||
| id | string | ||
| scanPoolId | string | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | int32 | ||
| 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 | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters5 fields | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations6 fields | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances6 fields | 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 | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| workflowStatistics12 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| realTimeStartDate | date-time | ||
| storageId | string | ||
| $type | string |
Response
›
›
{![]()
…![]()
}
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, Google Cloud, Alibaba Cloud and Oracle Native: 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 OPSWAT MFT Storage: The desired Folder Path when integrating with user For NFS / SMB / SFTP / FTP / SharePoint OnPrem: Only the folder path beyond your configured storage root (do not include the base path set during integration) Provide the absolute folder path in the following format "{"Folder":"PATH_TO_SCAN"}
Auth
Request Body
| object | object | ||
| storageId | string | This property is obsolete and will be removed in the future. Use StorageIds instead. Deprecated | |
| name | string | user-defined name for the scan pattern: | |
| folder | string | This property is obsolete and will be removed in the future. Use ScanPartition instead. Deprecated | |
| scanPartition | string | partiton of storage where the scan will run | |
| priority | int32 | priority such as (low, medium, high) | |
| storageIds | array[string] | id's of storages to be scanned | |
| workflowId | string | associated workflow to be executed minLength: 1 | |
| mdssBaseUrl | string | base URL for MDSS, if not provided will use Request.Host | |
| scanConfigDto | |||
| object | object | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: |
POST /api/scan/start
curl --request POST \
--url 'http://<MDSS_HOST>/api/scan/start' \
--header 'Authorization: Bearer {token}' \
--data '{
"storageId": "{string}",
"name": "{string}",
"folder": "{string}",
"scanPartition": "{string}",
"priority": "{int32}",
"storageIds": [
"{array[string]...}"
],
"workflowId": "{string}",
"mdssBaseUrl": "{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
{
"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}
curl --request POST \
--url 'http://<MDSS_HOST>/api/scan/stop/{scanId}' \
--header 'Authorization: Bearer {token}'
Responses
200
| file | file |
Response
{
"schema": "{file}"
}
Delete scans
Auth
Path Params
| storageId | string |
Query String
| forceDeleteRtp | boolean |
Request Body
| array | array[string] |
DELETE /api/scan/{storageId}
curl --request DELETE \
--url 'http://<MDSS_HOST>/api/scan/{storageId}' \
--header 'Authorization: Bearer {token}' \
--data forceDeleteRtp={forceDeleteRtp} \
--data '[
"{array[string]...}"
]'
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| deletedScans18 fields | 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 | ||
| scanPartition | string | ||
| priority | integer |
Enum: | |
| additionalProperties | string | ||
| tenantId | string | ||
| errors | array[string] |
Response
{
"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}",
"scanPartition": "{string}",
"priority": "{integer}",
"additionalProperties": "{string}",
"tenantId": "{string}",
"errors": [
"{array[string]...}"
]
}
]
}
Fetch last completed scan
Auth
Path Params
| storageId | string |
GET /api/scan/last_completed/{storageId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/last_completed/{storageId}' \
--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: | |
| scanStatusDto18 fields | object | ||
| pendingFilesCount | int64 | ||
| pendingFilesSize | int64 | ||
| allowedFilesCount | int64 | ||
| allowedFilesSize | int64 | ||
| blockedFilesCount | int64 | ||
| blockedFilesSize | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| totalFilesSize | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedSize | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| processedFilesSize | int64 | ||
| canceledFilesCount | int64 | ||
| canceledFilesSize | int64 | ||
| scanStatsDto7 fields | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| filesBlockedBySandboxCount | int64 | ||
| scannedFilesCount | int64 | ||
| skippedFilesScanCount | int64 | ||
| scanFilesDistribution | |||
| object | object | ||
| documentsEncryptedFilesCount | int64 | ||
| executablesFilesCount | int64 | ||
| audioVideoFilesCount | int64 | ||
| openSSlEncryptedFilesCount | int64 | ||
| pdfFilesCount | int64 | ||
| graphicalFilesCount | int64 | ||
| diskImageFilesCount | int64 | ||
| textFilesCount | int64 | ||
| mailFilesCount | int64 | ||
| applicationFilesCount | int64 | ||
| documentsFilesCount | int64 | ||
| otherFilesCount | int64 | ||
| archivesFilesCount | int64 | ||
| realTimeStartDate | date-time | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| scanPartition | string | ||
| workflowId | string | WorkflowId required if ScanConfigurationId is null minLength: 1 | |
| scanConfigurationId | string | This property is obsolete and will be removed in the future. Use WorkflowId instead. | |
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos13 fields | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow17 fields | object | ||
| id | string | ||
| scanPoolId | string | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | int32 | ||
| 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 | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters5 fields | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations6 fields | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances6 fields | 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 | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| workflowStatistics12 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| realTimeStartDate | date-time | ||
| storageId | string | ||
| $type | string |
Response
›
›
{![]()
…![]()
}
Get an active scan by scan ID
Auth
Path Params
| scanId | string |
GET /api/scan/active/{scanId}
curl --get \
--url 'http://<MDSS_HOST>/api/scan/active/{scanId}' \
--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: | |
| scanStatusDto18 fields | object | ||
| pendingFilesCount | int64 | ||
| pendingFilesSize | int64 | ||
| allowedFilesCount | int64 | ||
| allowedFilesSize | int64 | ||
| blockedFilesCount | int64 | ||
| blockedFilesSize | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| totalFilesSize | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedSize | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| processedFilesSize | int64 | ||
| canceledFilesCount | int64 | ||
| canceledFilesSize | int64 | ||
| scanStatsDto7 fields | object | ||
| infectedFilesCount | int64 | ||
| filesWithVulnerabilitiesCount | int64 | ||
| filesWithSensitiveDataCount | int64 | ||
| filesBlockedBySandboxCount | int64 | ||
| scannedFilesCount | int64 | ||
| skippedFilesScanCount | int64 | ||
| scanFilesDistribution | |||
| object | object | ||
| documentsEncryptedFilesCount | int64 | ||
| executablesFilesCount | int64 | ||
| audioVideoFilesCount | int64 | ||
| openSSlEncryptedFilesCount | int64 | ||
| pdfFilesCount | int64 | ||
| graphicalFilesCount | int64 | ||
| diskImageFilesCount | int64 | ||
| textFilesCount | int64 | ||
| mailFilesCount | int64 | ||
| applicationFilesCount | int64 | ||
| documentsFilesCount | int64 | ||
| otherFilesCount | int64 | ||
| archivesFilesCount | int64 | ||
| realTimeStartDate | date-time | ||
| scanSequenceDto | |||
| object | object | ||
| previousScanId | string | ||
| nextScanId | string | ||
| scanPartition | string | ||
| workflowId | string | WorkflowId required if ScanConfigurationId is null minLength: 1 | |
| scanConfigurationId | string | This property is obsolete and will be removed in the future. Use WorkflowId instead. | |
| errors | array[string] | ||
| priority | integer |
Enum: | |
| scanWorkflowSnapshotDtos13 fields | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow17 fields | object | ||
| id | string | ||
| scanPoolId | string | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | int32 | ||
| 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 | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters5 fields | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations6 fields | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances6 fields | 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 | ||
| scanInstances6 fields | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances6 fields | 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 | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| workflowStatistics12 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | 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 | ||
| destinationStorageInformation12 fields | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType4 fields | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
|