MetaDefender Storage Security API
4.3.0
Search this version
MetaDefender Storage Security API
About this REST API
Useful links
Authentication
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
GETconnector
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
GETRetrieve archive scan results
GETFetch processing results for a file
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 Teemetry 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
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.
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
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
Fetch all accounts
Retrieve a list of all configured accounts
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| accounts | array[object] | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string | ||
| credentials | string | ||
| autoDiscovery | boolean | ||
| groupId | string | ||
| protocolType | int32 | ||
| vendorType | int32 |
Response
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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| accountId | string |
Response
Delete an account
Permanently delete an account and its storage references
Auth
Path Params
| accountId | string | id of the account to delete |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| accountId | string |
Response
Fetch account by ID
Retrieve a single account's details by ID
Auth
Path Params
| accountId | string | id of the account to get |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| account | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string | ||
| credentials | string | ||
| autoDiscovery | boolean | ||
| groupId | string | ||
| protocolType | int32 | ||
| vendorType | int32 |
Response
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
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
Fetch the number of accounts
Get the total number of accounts in the system
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| accountCount | object | ||
| count | int64 |
Response
Fetch account sources
Fetch account sources
Auth
Path Params
| accountId | string |
Query String
| filter | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[string] |
Response
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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| logLevel | integer |
Enum: | |
| details | string | ||
| logType | |||
| integer | integer |
Enum: | |
| userId | string | ||
| category | integer |
Enum: | |
| timeStamp | date-time | ||
| userName | string | ||
| filterCount | int64 | ||
| totalCount | int64 |
Response
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 | ||
| password | string |
GET
Responses
200
| file | file |
Response
Import configuration file
Auth
Request Body
| object | object | ||
| ConfigurationFile | file | ||
| password | string |
POST
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 |
Response
Get enabled modules
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| enabledModules | array[integer] |
Response
Connector
Endpoints
connector
Auth
Query String
| sharePath | string | ||
| clientId | string |
GET
Responses
200
| file | file |
Response
External Logger
Manage external loggers
Retrieve external loggers
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| isEnabled | boolean | ||
| loggerType | integer |
Enum: | |
| connectionSettings | |||
| object | object | ||
| $type | string |
Response
Update external logger state
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| isEnabled | boolean |
PUT
Responses
200
| file | file |
Response
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
Responses
200
| file | file |
Response
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
Responses
200
| file | file |
Response
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
Responses
200
| file | file |
Response
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
Responses
200
| file | file |
Response
Delete external logger
Auth
Path Params
| id | string |
DELETE
Responses
200
| file | file |
Response
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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| scanId | string | ||
| name | string | ||
| path | string | ||
| hash | string | ||
| fileOwner | object | ||
| 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 | ||
| scanDetails | array[object] | ||
| engineName | string | ||
| threatFound | string | ||
| scanResultI | int32 | ||
| defTime | string | ||
| scanTime | number | ||
| engId | string | ||
| waitTime | number | ||
| dataId | string | ||
| scanAllResultI | int32 | ||
| scanAllResultA | string | ||
| startTime | string | ||
| totalTime | number | ||
| totalAvs | int32 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals | 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 | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| licenseStatus | string | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| step | int32 | ||
| vulnerabilityCount | int32 | ||
| sha256 | string | ||
| severity | integer |
Enum: | |
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| resultTemplateHash | string | ||
| vulnerabilityInfo | |||
| object | object | ||
| vulnerabilityInfoResult | |||
| object | object | ||
| code | int64 | ||
| hash | string | ||
| method | int64 | ||
| timeStamp | string | ||
| timing | int64 | ||
| detectedProduct | |||
| object | object | ||
| hasVulnerability | boolean | ||
| isCurrent | boolean | ||
| product | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| remediationLink | string | ||
| severity | string | ||
| sigName | string | ||
| signature | int64 | ||
| vendor | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| version | string | ||
| versionData | |||
| object | object | ||
| countBehind | int64 | ||
| feedId | int64 | ||
| version | string | ||
| vulnerabilities | array[object] | ||
| description | string | ||
| details | |||
| object | object | ||
| cpe | string | ||
| cve | string | ||
| cvss | |||
| object | object | ||
| accessComplexity | string | ||
| accessVector | string | ||
| authentication | string | ||
| availabilityImpact | string | ||
| confidentialityImpact | string | ||
| generatedOnEpoch | string | ||
| integrityImpact | string | ||
| score | string | ||
| source | string | ||
| cvss3 | |||
| object | object | ||
| attackComplexity | string | ||
| attackVector | string | ||
| availabilityImpact | string | ||
| baseScore | string | ||
| baseSeverity | string | ||
| confidentialityImpact | string | ||
| exploitabilityScore | string | ||
| impactScore | string | ||
| integrityImpact | string | ||
| privilegesRequired | string | ||
| scope | string | ||
| userInteraction | string | ||
| vectorString | string | ||
| cwe | string | ||
| lastModifiedEpoch | string | ||
| publishedEpoch | string | ||
| references | array[string] | ||
| severity | string | ||
| severityIndex | int32 | ||
| staticId | int64 | ||
| sessionCookie | string | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines | 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 | ||
| coreEngines | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | |||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| 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 | ||
| objectRemediationActions | 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 | ||
| workflow | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| versions | array[object] | ||
| hasBlockedVersions | boolean | ||
| versionsCount | int32 | ||
| objectType | integer |
Enum: | |
| skippedScan | boolean | ||
| $type | string | ||
| filterCount | int64 | ||
| totalCount | int64 |
Response
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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Retrieve archive scan results
Retrieve the archive scan results using either the scanResultId or the parentId
Auth
Path Params
| fileId | string |
Query String
| expand | array | Possible values for expand: workflow_snapshot |
GET
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 | ||
| scanDetails | array[object] | ||
| engineName | string | ||
| threatFound | string | ||
| scanResultI | int32 | ||
| defTime | string | ||
| scanTime | number | ||
| engId | string | ||
| waitTime | number | ||
| dataId | string | ||
| scanAllResultI | int32 | ||
| scanAllResultA | string | ||
| startTime | string | ||
| totalTime | number | ||
| totalAvs | int32 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals | 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 | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| licenseStatus | string | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| step | int32 | ||
| vulnerabilityCount | int32 | ||
| sha256 | string | ||
| severity | integer |
Enum: | |
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| resultTemplateHash | string | ||
| vulnerabilityInfo | |||
| object | object | ||
| vulnerabilityInfoResult | |||
| object | object | ||
| code | int64 | ||
| hash | string | ||
| method | int64 | ||
| timeStamp | string | ||
| timing | int64 | ||
| detectedProduct | |||
| object | object | ||
| hasVulnerability | boolean | ||
| isCurrent | boolean | ||
| product | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| remediationLink | string | ||
| severity | string | ||
| sigName | string | ||
| signature | int64 | ||
| vendor | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| version | string | ||
| versionData | |||
| object | object | ||
| countBehind | int64 | ||
| feedId | int64 | ||
| version | string | ||
| vulnerabilities | array[object] | ||
| description | string | ||
| details | |||
| object | object | ||
| cpe | string | ||
| cve | string | ||
| cvss | |||
| object | object | ||
| accessComplexity | string | ||
| accessVector | string | ||
| authentication | string | ||
| availabilityImpact | string | ||
| confidentialityImpact | string | ||
| generatedOnEpoch | string | ||
| integrityImpact | string | ||
| score | string | ||
| source | string | ||
| cvss3 | |||
| object | object | ||
| attackComplexity | string | ||
| attackVector | string | ||
| availabilityImpact | string | ||
| baseScore | string | ||
| baseSeverity | string | ||
| confidentialityImpact | string | ||
| exploitabilityScore | string | ||
| impactScore | string | ||
| integrityImpact | string | ||
| privilegesRequired | string | ||
| scope | string | ||
| userInteraction | string | ||
| vectorString | string | ||
| cwe | string | ||
| lastModifiedEpoch | string | ||
| publishedEpoch | string | ||
| references | array[string] | ||
| severity | string | ||
| severityIndex | int32 | ||
| staticId | int64 | ||
| sessionCookie | string | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines | 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 | ||
| coreEngines | array[object] | Deprecated | |
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | Deprecated | ||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| 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 | ||
| objectRemediationActions | 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 | ||
| fileOwner | 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 | ||
| scanDetails | array[object] | ||
| engineName | string | ||
| threatFound | string | ||
| scanResultI | int32 | ||
| defTime | string | ||
| scanTime | number | ||
| engId | string | ||
| waitTime | number | ||
| dataId | string | ||
| scanAllResultI | int32 | ||
| scanAllResultA | string | ||
| startTime | string | ||
| totalTime | number | ||
| totalAvs | int32 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals | 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 | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| licenseStatus | string | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| step | int32 | ||
| vulnerabilityCount | int32 | ||
| sha256 | string | ||
| severity | integer |
Enum: | |
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| resultTemplateHash | string | ||
| vulnerabilityInfo | |||
| object | object | ||
| vulnerabilityInfoResult | |||
| object | object | ||
| code | int64 | ||
| hash | string | ||
| method | int64 | ||
| timeStamp | string | ||
| timing | int64 | ||
| detectedProduct | |||
| object | object | ||
| hasVulnerability | boolean | ||
| isCurrent | boolean | ||
| product | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| remediationLink | string | ||
| severity | string | ||
| sigName | string | ||
| signature | int64 | ||
| vendor | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| version | string | ||
| versionData | |||
| object | object | ||
| countBehind | int64 | ||
| feedId | int64 | ||
| version | string | ||
| vulnerabilities | array[object] | ||
| description | string | ||
| details | |||
| object | object | ||
| cpe | string | ||
| cve | string | ||
| cvss | |||
| object | object | ||
| accessComplexity | string | ||
| accessVector | string | ||
| authentication | string | ||
| availabilityImpact | string | ||
| confidentialityImpact | string | ||
| generatedOnEpoch | string | ||
| integrityImpact | string | ||
| score | string | ||
| source | string | ||
| cvss3 | |||
| object | object | ||
| attackComplexity | string | ||
| attackVector | string | ||
| availabilityImpact | string | ||
| baseScore | string | ||
| baseSeverity | string | ||
| confidentialityImpact | string | ||
| exploitabilityScore | string | ||
| impactScore | string | ||
| integrityImpact | string | ||
| privilegesRequired | string | ||
| scope | string | ||
| userInteraction | string | ||
| vectorString | string | ||
| cwe | string | ||
| lastModifiedEpoch | string | ||
| publishedEpoch | string | ||
| references | array[string] | ||
| severity | string | ||
| severityIndex | int32 | ||
| staticId | int64 | ||
| sessionCookie | string | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines | 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 | ||
| coreEngines | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | |||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| 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 | ||
| objectRemediationActions | 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 | ||
| workflow | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| versions | array[object] | ||
| hasBlockedVersions | boolean | ||
| versionsCount | int32 | ||
| objectType | integer |
Enum: | |
| skippedScan | boolean | ||
| $type | string |
Response
Fetch processing results for a file
File processing is done asynchronously and each analysis request is tracked by a file ID. Because processing a file is a potentially time-consuming operation, scheduling a file for processing and retrieving the results needs to be done using two separate API calls.
This request needs to be made multiple times until the analysis is complete. Analysis completion can be tracked using the processingState and the progress values from the response..
Auth
Query String
| scanResultId | string | ||
| parentId | string | ||
| start | integer | Default: 0 | |
| count | integer | Default: 1000 |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| archiveScanResults | array[object] | ||
| extractedFiles | |||
| object | object | ||
| dataId | string | ||
| scanResultI | int32 | ||
| detectedBy | int32 | ||
| filesExtractedCount | int32 | ||
| scanResults | |||
| object | object | ||
| scanDetails | array[object] | ||
| engineName | string | ||
| threatFound | string | ||
| scanResultI | int32 | ||
| defTime | string | ||
| scanTime | number | ||
| engId | string | ||
| waitTime | number | ||
| dataId | string | ||
| scanAllResultI | int32 | ||
| scanAllResultA | string | ||
| startTime | string | ||
| totalTime | number | ||
| totalAvs | int32 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals | 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 | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| licenseStatus | string | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| step | int32 | ||
| vulnerabilityCount | int32 | ||
| sha256 | string | ||
| severity | integer |
Enum: | |
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| resultTemplateHash | string | ||
| vulnerabilityInfo | |||
| object | object | ||
| vulnerabilityInfoResult | |||
| object | object | ||
| code | int64 | ||
| hash | string | ||
| method | int64 | ||
| timeStamp | string | ||
| timing | int64 | ||
| detectedProduct | |||
| object | object | ||
| hasVulnerability | boolean | ||
| isCurrent | boolean | ||
| product | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| remediationLink | string | ||
| severity | string | ||
| sigName | string | ||
| signature | int64 | ||
| vendor | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| version | string | ||
| versionData | |||
| object | object | ||
| countBehind | int64 | ||
| feedId | int64 | ||
| version | string | ||
| vulnerabilities | array[object] | ||
| description | string | ||
| details | |||
| object | object | ||
| cpe | string | ||
| cve | string | ||
| cvss | |||
| object | object | ||
| accessComplexity | string | ||
| accessVector | string | ||
| authentication | string | ||
| availabilityImpact | string | ||
| confidentialityImpact | string | ||
| generatedOnEpoch | string | ||
| integrityImpact | string | ||
| score | string | ||
| source | string | ||
| cvss3 | |||
| object | object | ||
| attackComplexity | string | ||
| attackVector | string | ||
| availabilityImpact | string | ||
| baseScore | string | ||
| baseSeverity | string | ||
| confidentialityImpact | string | ||
| exploitabilityScore | string | ||
| impactScore | string | ||
| integrityImpact | string | ||
| privilegesRequired | string | ||
| scope | string | ||
| userInteraction | string | ||
| vectorString | string | ||
| cwe | string | ||
| lastModifiedEpoch | string | ||
| publishedEpoch | string | ||
| references | array[string] | ||
| severity | string | ||
| severityIndex | int32 | ||
| staticId | int64 | ||
| sessionCookie | string | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines | 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
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 | ||
| scanDetails | array[object] | ||
| engineName | string | ||
| threatFound | string | ||
| scanResultI | int32 | ||
| defTime | string | ||
| scanTime | number | ||
| engId | string | ||
| waitTime | number | ||
| dataId | string | ||
| scanAllResultI | int32 | ||
| scanAllResultA | string | ||
| startTime | string | ||
| totalTime | number | ||
| totalAvs | int32 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals | 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 | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| licenseStatus | string | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| step | int32 | ||
| vulnerabilityCount | int32 | ||
| sha256 | string | ||
| severity | integer |
Enum: | |
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| resultTemplateHash | string | ||
| vulnerabilityInfo | |||
| object | object | ||
| vulnerabilityInfoResult | |||
| object | object | ||
| code | int64 | ||
| hash | string | ||
| method | int64 | ||
| timeStamp | string | ||
| timing | int64 | ||
| detectedProduct | |||
| object | object | ||
| hasVulnerability | boolean | ||
| isCurrent | boolean | ||
| product | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| remediationLink | string | ||
| severity | string | ||
| sigName | string | ||
| signature | int64 | ||
| vendor | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| version | string | ||
| versionData | |||
| object | object | ||
| countBehind | int64 | ||
| feedId | int64 | ||
| version | string | ||
| vulnerabilities | array[object] | ||
| description | string | ||
| details | |||
| object | object | ||
| cpe | string | ||
| cve | string | ||
| cvss | |||
| object | object | ||
| accessComplexity | string | ||
| accessVector | string | ||
| authentication | string | ||
| availabilityImpact | string | ||
| confidentialityImpact | string | ||
| generatedOnEpoch | string | ||
| integrityImpact | string | ||
| score | string | ||
| source | string | ||
| cvss3 | |||
| object | object | ||
| attackComplexity | string | ||
| attackVector | string | ||
| availabilityImpact | string | ||
| baseScore | string | ||
| baseSeverity | string | ||
| confidentialityImpact | string | ||
| exploitabilityScore | string | ||
| impactScore | string | ||
| integrityImpact | string | ||
| privilegesRequired | string | ||
| scope | string | ||
| userInteraction | string | ||
| vectorString | string | ||
| cwe | string | ||
| lastModifiedEpoch | string | ||
| publishedEpoch | string | ||
| references | array[string] | ||
| severity | string | ||
| severityIndex | int32 | ||
| staticId | int64 | ||
| sessionCookie | string | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines | 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 | ||
| coreEngines | array[object] | Deprecated | |
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | Deprecated | ||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| 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 | ||
| objectRemediationActions | 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 | ||
| fileOwner | 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 | ||
| scanDetails | array[object] | ||
| engineName | string | ||
| threatFound | string | ||
| scanResultI | int32 | ||
| defTime | string | ||
| scanTime | number | ||
| engId | string | ||
| waitTime | number | ||
| dataId | string | ||
| scanAllResultI | int32 | ||
| scanAllResultA | string | ||
| startTime | string | ||
| totalTime | number | ||
| totalAvs | int32 | ||
| totalDetections | int32 | ||
| progressPercentage | int32 | ||
| fileInfo | |||
| object | object | ||
| fileSize | int64 | ||
| uploadTimestamp | string | ||
| md5 | string | ||
| sha1 | string | ||
| sha256 | string | ||
| fileTypeCategory | string | ||
| fileTypeDescription | string | ||
| fileTypeExtension | string | ||
| displayName | string | ||
| fileTypeId | string | ||
| fileScanInfo | |||
| object | object | ||
| finalVerdict | |||
| object | object | ||
| blocked | boolean | ||
| verdict | string | ||
| confidence | number | ||
| threatLevel | number | ||
| overviewReport | |||
| object | object | ||
| analysisState | string | ||
| signalGroups | array[object] | ||
| description | string | ||
| verdict | string | ||
| signals | 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 | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| arch | string | ||
| osName | string | ||
| osVersion | string | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| licenseStatus | string | ||
| licensingPackageCounts | |||
| object | object | ||
| allowed | int32 | ||
| blocked | int32 | ||
| unknown | int32 | ||
| unsupported | int32 | ||
| step | int32 | ||
| vulnerabilityCount | int32 | ||
| sha256 | string | ||
| severity | integer |
Enum: | |
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| packages | |||
| object | object | ||
| authors | string | ||
| releaseDate | date-time | ||
| ecosystem | string | ||
| group | string | ||
| archive | boolean | ||
| executable | boolean | ||
| uid | string | ||
| licenses | |||
| object | object | ||
| allowed | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| blocked | array[object] | ||
| id | string | ||
| url | string | ||
| category | string | ||
| usageRestriction | |||
| object | object | ||
| permissions | array[string] | ||
| conditions | array[string] | ||
| limitations | array[string] | ||
| packageName | string | ||
| packageVersion | string | ||
| target | string | ||
| hashes | array[object] | ||
| sha256 | string | ||
| fileName | string | ||
| vulnerabilities | array[object] | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependencies | array[object] | ||
| ecosystem | string | ||
| group | string | ||
| packageName | string | ||
| packageVersion | string | ||
| vulnerabilities | |||
| object | object | ||
| id | string | ||
| severity | integer |
Enum: | |
| source | string | ||
| fixedVersions | string | ||
| cwes | array[string] | ||
| vulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| dependenciesPackageCount | int32 | ||
| dependenciesVulnerabilityTotal | int32 | ||
| dependenciesVulnerabilityCounts | |||
| object | object | ||
| critical | int32 | ||
| high | int32 | ||
| medium | int32 | ||
| low | int32 | ||
| unknown | int32 | ||
| resultTemplateHash | string | ||
| vulnerabilityInfo | |||
| object | object | ||
| vulnerabilityInfoResult | |||
| object | object | ||
| code | int64 | ||
| hash | string | ||
| method | int64 | ||
| timeStamp | string | ||
| timing | int64 | ||
| detectedProduct | |||
| object | object | ||
| hasVulnerability | boolean | ||
| isCurrent | boolean | ||
| product | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| remediationLink | string | ||
| severity | string | ||
| sigName | string | ||
| signature | int64 | ||
| vendor | |||
| object | object | ||
| id | int64 | ||
| name | string | ||
| version | string | ||
| versionData | |||
| object | object | ||
| countBehind | int64 | ||
| feedId | int64 | ||
| version | string | ||
| vulnerabilities | array[object] | ||
| description | string | ||
| details | |||
| object | object | ||
| cpe | string | ||
| cve | string | ||
| cvss | |||
| object | object | ||
| accessComplexity | string | ||
| accessVector | string | ||
| authentication | string | ||
| availabilityImpact | string | ||
| confidentialityImpact | string | ||
| generatedOnEpoch | string | ||
| integrityImpact | string | ||
| score | string | ||
| source | string | ||
| cvss3 | |||
| object | object | ||
| attackComplexity | string | ||
| attackVector | string | ||
| availabilityImpact | string | ||
| baseScore | string | ||
| baseSeverity | string | ||
| confidentialityImpact | string | ||
| exploitabilityScore | string | ||
| impactScore | string | ||
| integrityImpact | string | ||
| privilegesRequired | string | ||
| scope | string | ||
| userInteraction | string | ||
| vectorString | string | ||
| cwe | string | ||
| lastModifiedEpoch | string | ||
| publishedEpoch | string | ||
| references | array[string] | ||
| severity | string | ||
| severityIndex | int32 | ||
| staticId | int64 | ||
| sessionCookie | string | ||
| fileTypeInfo | |||
| object | object | ||
| fileInfoExtended | |||
| object | object | ||
| extensions | string | ||
| groupId | string | ||
| typeId | string | ||
| scanInstanceUrl | string | ||
| scanWorkflowSnapshotId | string | ||
| coreEngines | 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 | ||
| coreEngines | array[object] | ||
| engineId | string | ||
| engineName | string | ||
| engineVersion | string | ||
| dbVersion | string | ||
| definitionTime | string | ||
| remediation | |||
| object | object | ||
| isTagged | boolean | ||
| isDeleted | boolean | ||
| isMoved | boolean | ||
| isCopied | boolean | ||
| deepCdr | |||
| object | object | ||
| 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 | ||
| objectRemediationActions | 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 | ||
| workflow | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| 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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| group | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string |
Response
Fetch all groups
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| groups | array[object] | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Response
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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| updatedGroup | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string |
Response
Delete a group
Auth
Path Params
| groupId | string |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Fetch group by ID
Auth
Path Params
| groupId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| group | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| storages | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Response
Fetch the number of groups
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| groupCount | object | ||
| count | int64 |
Response
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
Responses
200
| object | object | ||
| apiStatus | string |
Response
Onboarding
Manage onboarding
Fetch onboarding configuration
Auth
Query String
| newConfigSetup | boolean | ||
| newDefaultWorkflow | boolean |
GET
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
Finish onboarding
Auth
POST
Responses
200
| file | file |
Response
Accept Eula
Auth
POST
Responses
200
| file | file |
Response
Remediations
Remediations information
Get Remediations by workflow id
Auth
Path Params
| id | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
Response
Get Remediation by id
Auth
Path Params
| id | string |
GET
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
Delete Remediation
Auth
Path Params
| id | string |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Add Remediation
Auth
Request Body
| object | object | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Update Remediation
Auth
Request Body
| object | object | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | |||
| integer | integer |
Enum: | |
| handlingType | |||
| integer | integer |
Enum: |
PATCH
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | 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 | ||
| 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: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| storageId | string | ||
| $type | string | ||
| totalCount | int64 |
Response
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
Responses
200
| file | file |
Response
Get scan by ID
Auth
Path Params
| scanId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | 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 | ||
| 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: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| 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
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scanId | string | ||
| scanIds | array[string] |
Response
Stop a scan
Auth
Path Params
| scanId | string |
POST
Responses
200
| file | file |
Response
Delete scans
Auth
Path Params
| storageId | string |
Query String
| forceDeleteRtp | boolean |
Request Body
| array | array[string] |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| deletedScans | array[object] | ||
| id | string | ||
| storageId | string | ||
| workflowId | string | ||
| scanScheduleId | string | ||
| executionId | string | ||
| name | string | ||
| userId | string | ||
| scanConfigDto | object | ||
| realTimeScanConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| startDate | date-time | ||
| handlingType | integer |
Enum: | |
| discoveryState | integer |
Enum: | |
| scanningState | integer |
Enum: | |
| scanType | integer |
Enum: | |
| startTime | date-time | ||
| stopTime | date-time | ||
| scanPartition | string | ||
| priority | integer |
Enum: | |
| additionalProperties | string | ||
| tenantId | string | ||
| errors | array[string] |
Response
Fetch last completed scan
Auth
Path Params
| storageId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | 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 | ||
| 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: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| storageId | string | ||
| $type | string |
Response
Get an active scan by scan ID
Auth
Path Params
| scanId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | 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 | ||
| 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: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| storageId | string | ||
| $type | string | ||
| serviceName | string | ||
| storageName | string | ||
| currentProcessingFilePath | string | ||
| currentProcessingFileProgress | string | ||
| discoveryState | integer |
Enum: | |
| statusMessages | array[object] | ||
| message | string | ||
| severity | integer |
Enum: |
Response
Get Real-Time scan by storage Id
Auth
Path Params
| storageId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scan | |||
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| id | string | ||
| name | string | ||
| startTime | date-time | ||
| stopTime | date-time | ||
| scanType | string | ||
| scanningState | integer |
Enum: | |
| scanStatusDto | object | ||
| pendingFilesCount | int64 | ||
| allowedFilesCount | int64 | ||
| blockedFilesCount | int64 | ||
| sanitizedFilesCount | int64 | ||
| failedSanitizedFilesCount | int64 | ||
| remediatedFilesCount | int64 | ||
| totalFilesCount | int64 | ||
| processingFailedCount | int64 | ||
| processingFailedRemediationCount | int64 | ||
| processedFilesCount | int64 | ||
| scanStatsDto | 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 | ||
| 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: | |
| scanWorkflowSnapshotDtos | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string | ||
| storageId | string | ||
| $type | string | ||
| isRealTimeEnabled | boolean | ||
| handlingType | integer |
Enum: |
Response
Scan Instance
List, add, update and delete Scan Instances
Get Scan Instances
Auth
Query String
| scanPoolId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Response
Add a new Scan Instance
Auth
Request Body
| object | object | ||
| scanPoolId | string | minLength: 1 | |
| url | string | minLength: 1 pattern: | |
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scanInstanceId | string |
Response
Update an existing Scan Instance
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| url | string | pattern: | |
| apiKey | string | ||
| timeout | string |
PUT
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Get Scan Instance by ID
Auth
Path Params
| id | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entry | |||
| object | object | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Response
Delete a Scan Instance
Auth
Path Params
| id | string |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Test
Auth
Request Body
| object | object | ||
| url | string | minLength: 1 | |
| rules | array[string] | ||
| apiKey | string | ||
| userAgent | string | ||
| isCloudInstance | boolean |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Scan Pool
List, add, update and delete Scan Pools
Get Scan Pools
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Response
Add a new Scan Pool
Auth
Request Body
| object | object | ||
| name | string | maxLength: 30 minLength: 3 | |
| scanPoolType | integer |
Enum: |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scanPoolId | string |
Response
Update an existing Scan Pool
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| name | string | maxLength: 30 minLength: 3 |
PUT
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Get Scan Pool by ID
Auth
Path Params
| id | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entry | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: |
Response
Delete a Scan Pool
Auth
Path Params
| id | string |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Scan Workflow Snapshot
List scan workflow snapshots
Get all scan workflow snapshots by scan ID
Auth
Path Params
| scanId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| scanWorkflowSnapshots | array[object] | ||
| id | string | ||
| scanId | string | ||
| workflow | object | ||
| id | string | ||
| scanPoolId | string | ||
| 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string | ||
| startTimestamp | int64 | ||
| stopTimestamp | int64 | ||
| scanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| storage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| workflowStatistics | object | ||
| taggingStatistics | |||
| object | object | ||
| total | int64 | ||
| keepAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| keepSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| movedAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedSanitizedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| movedBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| copyBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| destinationStorageInformation | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string | ||
| deleteAllowedStatistics | |||
| object | object | ||
| total | int64 | ||
| deleteBlockedStatistics | |||
| object | object | ||
| total | int64 | ||
| lastCalculatedStatisticsTime | date-time | ||
| account | |||
| object | object | ||
| id | string | ||
| name | string | ||
| description | string | ||
| credentials | string | ||
| protocolType | integer |
Enum: | |
| vendorType | |||
| integer | integer |
Enum: | |
| autoDiscovery | boolean | ||
| autodiscoveryDestinationGroupId | string |
Response
Settings
List or update your settings
Endpoints
Update notifications configuration
Auth
Request Body
| object | object | ||
| emailNotificationsConfig | |||
| object | object | ||
| generatedReportNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| userRequestNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| blockedFileNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| webhookNotificationsConfig | |||
| object | object | ||
| scanCompletedNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| fileScannedNotificationConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| notificationScope | integer |
Enum: | |
| destinationAddress | string | ||
| headers | object | ||
| * | string | ||
| requestType | |||
| integer | integer |
Enum: | |
| rabbitMqNotificationsConfig | |||
| object | object | ||
| fileScannedNotificationConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| notificationScope | integer |
Enum: | |
| rabbitMqUrl | string | ||
| headers | object | ||
| * | string |
PUT
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| newNotificationsConfig | |||
| object | object | ||
| id | string | ||
| emailNotificationsConfig | object | ||
| userRequestNotificationsConfig | object | ||
| isEnabled | boolean | ||
| generatedReportNotificationsConfig | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| blockedFileNotificationsConfig | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| webhookNotificationsConfig | object | ||
| scanCompletedNotificationsConfig | object | ||
| isEnabled | boolean | ||
| fileScannedNotificationConfig | object | ||
| isEnabled | boolean | ||
| notificationScope | integer |
Enum: | |
| destinationAddress | string | ||
| headers | object | ||
| * | string | ||
| requestType | integer |
Enum: | |
| rabbitMqNotificationsConfig | object | ||
| fileScannedNotificationConfig | object | ||
| isEnabled | boolean | ||
| notificationScope | integer |
Enum: | |
| rabbitMqUrl | string | ||
| headers | object | ||
| * | string | ||
| initialNotificationsConfig | |||
| object | object | ||
| id | string | ||
| emailNotificationsConfig | object | ||
| userRequestNotificationsConfig | object | ||
| isEnabled | boolean | ||
| generatedReportNotificationsConfig | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| blockedFileNotificationsConfig | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| webhookNotificationsConfig | object | ||
| scanCompletedNotificationsConfig | object | ||
| isEnabled | boolean | ||
| fileScannedNotificationConfig | object | ||
| isEnabled | boolean | ||
| notificationScope | integer |
Enum: | |
| destinationAddress | string | ||
| headers | object | ||
| * | string | ||
| requestType | integer |
Enum: | |
| rabbitMqNotificationsConfig | object | ||
| fileScannedNotificationConfig | object | ||
| isEnabled | boolean | ||
| notificationScope | integer |
Enum: | |
| rabbitMqUrl | string | ||
| headers | object | ||
| * | string | ||
| typeResults | array[object] | ||
| type | integer |
Enum: | |
| status | integer |
Enum: | |
| errorKey | string | ||
| errorMessage | string |
Response
Get notifications configuration
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| emailNotificationsConfig | |||
| object | object | ||
| generatedReportNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| userRequestNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| blockedFileNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| recipientsType | integer |
Enum: | |
| webhookNotificationsConfig | |||
| object | object | ||
| scanCompletedNotificationsConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| fileScannedNotificationConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| notificationScope | integer |
Enum: | |
| destinationAddress | string | ||
| headers | object | ||
| * | string | ||
| requestType | |||
| integer | integer |
Enum: | |
| rabbitMqNotificationsConfig | |||
| object | object | ||
| fileScannedNotificationConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| notificationScope | integer |
Enum: | |
| rabbitMqUrl | string | ||
| headers | object | ||
| * | string |
Response
Update SMTP configuration
Auth
Request Body
| object | object | ||
| host | string | ||
| port | int32 | ||
| baseUrl | string | ||
| senderAddress | string | ||
| senderName | string | maxLength: 320 | |
| domain | string | ||
| username | string | ||
| password | string | ||
| secureSocketOption | |||
| integer | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean |
PATCH
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| newSmtpConfig | |||
| object | object | ||
| host | string | ||
| baseUrl | string | ||
| port | int32 | ||
| senderAddress | string | ||
| senderName | string | ||
| domain | string | ||
| username | string | ||
| secureSocketOption | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean | ||
| oldSmtpConfig | |||
| object | object | ||
| host | string | ||
| baseUrl | string | ||
| port | int32 | ||
| senderAddress | string | ||
| senderName | string | ||
| domain | string | ||
| username | string | ||
| secureSocketOption | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean |
Response
Fetch SMTP configuration
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| host | string | ||
| port | int32 | ||
| baseUrl | string | ||
| senderAddress | string | ||
| senderName | string | ||
| domain | string | ||
| username | string | ||
| secureSocketOption | integer |
Enum: | |
| ignoreCertWarnings | boolean | ||
| isSmtpEnabled | boolean |
Response
Online license activation
Auth
Request Body
| object | object | ||
| key | string | minLength: 1 |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Offline license activation
Auth
Request Body
| object | object | ||
| LicenseContent | file |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Get license details
Auth
GET
Responses
200
| object | object | ||
| apiStatus | string |
Response
Deactivate license
Auth
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Update retention configuration
Auth
Request Body
| object | object | ||
| retentionAuditDays | int32 | maximum: 50000 minimum: 1 | |
| reportRetention | object | ||
| isEnabled | boolean | ||
| retentionDays | int32 | maximum: 50000 minimum: 1 | |
| rtpHistoryRetention | object | ||
| isEnabled | boolean | ||
| retentionDays | int32 | maximum: 50000 minimum: 1 |
PUT
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Fetch retention configuration
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| retentionAuditDays | int32 | ||
| reportRetentionConfiguration | |||
| object | object | ||
| isEnabled | boolean | ||
| retentionDays | int32 | ||
| rtpHistoryRetentionConfiguration | |||
| object | object | ||
| isEnabled | boolean | ||
| retentionDays | int32 |
Response
Generate encryption key
Generate a new encryption key, replacing the old one if it exists.
Auth
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Get encryption key creation date
Get the creation date of the encryption key.
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| creationDate | date-time |
Response
Update SSL configuration
Update SSL configuration of MDSS by uploading a certificate and a key to enable SSL.
Auth
Request Body
| object | object | ||
| SslCertificate | file | ||
| SslKey | file | ||
| IsEnabled | boolean |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Get SSL configuration
Get current SSL configuration status.
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| creationDate | date-time |
Response
Update Single User Session
Update Simultaneous Sessions allowed for a Single User.
Auth
Request Body
| object | object | ||
| isSingleUserSession | boolean |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Get Single User Session
Get Simultaneous Sessions allowed for a Single User.
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| creationDate | date-time |
Response
Get Teemetry configuration.
Get MDSS Open Telemetry configuration.
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| telemetryConfig | object | ||
| isEnabled | boolean | ||
| sendTelemetryToOpswat | boolean | ||
| autoInstrumentation | boolean | ||
| optelCollectors | array[object] | ||
| metricEndpoint | object | ||
| endpointUrl | string | ||
| endpointApiKey | string | ||
| protocol | integer |
Enum: | |
| traceEndpoint | object | ||
| endpointUrl | string | ||
| endpointApiKey | string | ||
| protocol | integer |
Enum: | |
| isOpswatCollector | boolean |
Response
Update Telemetry configuration.
Update MDSS Open Telemetry configuration.
Auth
Request Body
| object | object | ||
| telemetryConfig | object | ||
| isEnabled | boolean | ||
| sendTelemetryToOpswat | boolean | ||
| autoInstrumentation | boolean | ||
| optelCollectors | array[object] | ||
| metricEndpoint | object | ||
| endpointUrl | string | ||
| endpointApiKey | string | ||
| protocol | integer |
Enum: | |
| traceEndpoint | object | ||
| endpointUrl | string | ||
| endpointApiKey | string | ||
| protocol | integer |
Enum: | |
| isOpswatCollector | boolean | ||
| userInfo | |||
| object | object | ||
| userId | string | ||
| userName | string |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Sso
Sso Authentication and Sso configuration update
Get Sso Configuration
Allows retrieval of the current SSO configuration.
Auth
GET
Responses
200
| object | object | ||
| isEnabled | boolean | ||
| ssoProvider | integer |
Enum: | |
| ssoType | integer |
Enum: | |
| baseUrl | string | ||
| clientId | string | ||
| clientSecret | string | ||
| authority | string | ||
| identityProviderCertificate | string | ||
| identityProviderIssuer | string | ||
| loginUrl | string | ||
| logoutUrl | string | ||
| administratorRoleName | string | ||
| readonlyRoleName | string |
Response
Update Sso Configuration
Allows updating the current Sso Configuration.
Auth
Request Body
| object | object | ||
| clientId | string | maxLength: 255 | |
| clientSecret | string | maxLength: 255 | |
| authority | string | maxLength: 255 | |
| baseUrl | string | maxLength: 255 | |
| identityProviderIssuer | string | maxLength: 255 | |
| identityProviderLoginUrl | string | maxLength: 255 | |
| identityProviderLogoutUrl | string | maxLength: 255 | |
| identityProviderCertificate | object | ||
| content | string | ||
| isEnabled | boolean | ||
| ssoType | int32 | ||
| ssoProvider | int32 | ||
| administratorRoleName | string | maxLength: 63 | |
| readonlyRoleName | string | maxLength: 63 |
PATCH
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| clientId | string | ||
| authority | string | ||
| baseUrl | string | ||
| isEnabled | boolean | ||
| ssoType | integer |
Enum: | |
| ssoProvider | integer |
Enum: | |
| identityProviderIssuer | string | ||
| identityProviderLoginUrl | string | ||
| identityProviderLogoutUrl | string | ||
| administratorRoleName | string | ||
| readonlyRoleName | string | ||
| ssoConfig | |||
| object | object | ||
| isEnabled | boolean | ||
| ssoProvider | integer |
Enum: | |
| ssoType | integer |
Enum: | |
| baseUrl | string | ||
| clientId | string | ||
| clientSecret | string | ||
| authority | string | ||
| identityProviderCertificate | string | ||
| identityProviderIssuer | string | ||
| loginUrl | string | ||
| logoutUrl | string | ||
| administratorRoleName | string | ||
| readonlyRoleName | string |
Response
Storage
Manage your storage units
Endpoints
Fetch all storage units
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Response
Fetch storage by ID
Auth
Path Params
| storageId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| storage | |||
| object | object | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Response
Update a storage
Note! The following are templates for what is expected in the Credentials, CredentialsFile and Source fields. Please provide the correct values for your storage integration instead of null/false
Alibaba Cloud storage units:
Credentials: "{"Endpoint":null,"AccessKeyId":null,"AccessKeySecret":null,"UseRamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Amazon S3 / S3 Compatible storage units:
Credentials: "{"ServiceUrl":null,"AccessKeyId":null,"SecretAccessKey":null,"RegionEndpoint":null,"AssumeRoleArn":null,"UseIamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Azure Blob storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null,"StorageAccount":null}"
Source: "{"Container":null}"
Azure Files storage units:
Credentials: "{"AccountName":null,"AccountKey":null,"ShareName":null}"
Source: "{"FolderLocation":null}"
Box storage units:
CredentialsFile: upload the credentials file
Source: "{"FolderLocation":null}"
Dell Isilon / SMB Compatible storage units:
Credentials: "{"User":null,"Password":null,"Server":null}"
Source: "{"SharePath":null}"
Google Cloud storage units:
CredentialsFile: upload the credentials file
Credentials: "{"UseAdc":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Graph storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null}"
Source: "{"Group":null}"
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| Name | string | ||
| StorageVendorType | string | ||
| StorageProtocolType | string | ||
| CredentialsFile | file | ||
| Credentials | string | ||
| Source | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string | ||
| TransferMetadataAndChecksum | boolean |
PATCH
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| updatedStorage | |||
| object | object | ||
| id | string | ||
| name | string | ||
| groupId | string | ||
| clientId | string | ||
| accountId | string | ||
| source | string | ||
| storageFunctionality | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | integer |
Enum: | |
| workflowId | string | ||
| lastUpdated | date-time | ||
| tenantId | string |
Response
Delete a storage
Auth
Path Params
| storageId | string |
Query String
| forceDelete | boolean | Default: false |
DELETE
Responses
200
| file | file |
Response
Fetch storage users
Auth
Path Params
| storageId | string |
Query String
| filter | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| fullName | string |
Response
Add a storage
Note! The following are templates for what is expected in the Credentials, CredentialsFile and Source fields. Please provide the correct values for your storage integration instead of null/false
Alibaba Cloud storage units:
Credentials: "{"Endpoint":null,"AccessKeyId":null,"AccessKeySecret":null,"UseRamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Amazon S3 / S3 Compatible storage units:
Credentials: "{"ServiceUrl":null,"AccessKeyId":null,"SecretAccessKey":null,"RegionEndpoint":null,"AssumeRoleArn":null,"UseIamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Azure Blob storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null,"StorageAccount":null}"
Source: "{"Container":null}"
Azure Files storage units:
Credentials: "{"AccountName":null,"AccountKey":null,"ShareName":null}"
Source: "{"FolderLocation":null}"
Box storage units:
CredentialsFile: upload the credentials file
Source: "{"FolderLocation":null}"
Dell Isilon / SMB Compatible storage units:
Credentials: "{"User":null,"Password":null,"Server":null}"
Source: "{"SharePath":null}"
Google Cloud storage units:
CredentialsFile: upload the credentials file
Credentials: "{"UseAdc":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Graph storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null}"
Source: "{"Group":null}"
Auth
Request Body
| object | object | ||
| Name | string | ||
| StorageVendorType | string | ||
| StorageProtocolType | string | ||
| CredentialsFile | file | ||
| Credentials | string | ||
| Source | string | ||
| GroupId | string | ||
| AccountId | string | ||
| WorkflowId | string | ||
| TransferMetadataAndChecksum | boolean |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| storageId | string |
Response
Add batch of storages
Note! The following are templates for what is expected in the Credentials, CredentialsFile and Source fields. Please provide the correct values for your storage integration instead of null/false
Alibaba Cloud storage units:
Credentials: "{"Endpoint":null,"AccessKeyId":null,"AccessKeySecret":null,"UseRamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Amazon S3 / S3 Compatible storage units:
Credentials: "{"ServiceUrl":null,"AccessKeyId":null,"SecretAccessKey":null,"RegionEndpoint":null,"AssumeRoleArn":null,"UseIamRole":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Azure Blob storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null,"StorageAccount":null}"
Source: "{"Container":null}"
Azure Files storage units:
Credentials: "{"AccountName":null,"AccountKey":null,"ShareName":null}"
Source: "{"FolderLocation":null}"
Box storage units:
CredentialsFile: upload the credentials file
Source: "{"FolderLocation":null}"
Dell Isilon / SMB Compatible storage units:
Credentials: "{"User":null,"Password":null,"Server":null}"
Source: "{"SharePath":null}"
Google Cloud storage units:
CredentialsFile: upload the credentials file
Credentials: "{"UseAdc":false}"
Source: "{"BucketName":null,"FolderLocation":null}"
Graph storage units:
Credentials: "{"TenantId":null,"ClientId":null,"ClientSecret":null}"
Source: "{"Group":null}"
Auth
Request Body
| object | object | ||
| addStorageParametersList | array[object] | ||
| name | string | maxLength: 60 minLength: 3 pattern: | |
| storageVendorType | integer |
Enum: | |
| storageProtocolType | integer |
Enum: | |
| credentialsFile | file | ||
| credentials | string | ||
| source | string | minLength: 1 | |
| groupId | string | ||
| accountId | string | ||
| workflowId | string | ||
| transferMetadataAndChecksum | boolean |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| storageId | string |
Response
Get batch of add storages results
Auth
Query String
| token | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| addStorageResultInfos | array | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| source | string | ||
| name | string | ||
| vendorType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| isCompleted | boolean |
Response
Fetch all storage units by filters (storage type or status)
Auth
Path Params
| startIndex | string | ||
| count | string |
Query String
| sortingOrder | string | ||
| search | string | ||
| storageType | integer | ||
| storageStatus | integer |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| groupId | string | ||
| accountId | string | ||
| name | string | ||
| storageClientId | string | ||
| storageType | object | ||
| name | string | ||
| categoryType | integer |
Enum: | |
| protocolType | integer |
Enum: | |
| vendorType | integer |
Enum: | |
| storageStatus | object | ||
| message | string | ||
| statusType | int32 | ||
| scansInProgress | boolean | ||
| isRtpInProgress | boolean | ||
| isScheduledScanInProgress | boolean | ||
| storageFunctionality | string | ||
| $type | string |
Response
Add a scan schedule
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | minLength: 1 pattern: | |
| workflowId | string | minLength: 1 | |
| recurrencePattern | object | ||
| type | string | ||
| minutelyRecurrence | |||
| object | object | ||
| everyNumberOfMinutes | int32 | maximum: 60 minimum: 5 | |
| hourlyRecurrence | |||
| object | object | ||
| everyNumberOfHours | int32 | maximum: 24 minimum: 1 | |
| dailyRecurrence | |||
| object | object | ||
| everyNumberOfDays | int32 | maximum: 365 minimum: 1 | |
| weeklyRecurrence | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrence | |||
| object | object | ||
| everyNumberOfMonths | int32 | maximum: 12 minimum: 1 | |
| dayOfMonth | int32 | maximum: 30 minimum: 1 | |
| startDate | date-time | ||
| timeToStart | date-time | ||
| avoidConcurrentScheduleRuns | boolean | ||
| scanPartition | string | ||
| priority | int32 | ||
| $type | string |
PUT
Responses
200
| file | file |
Response
Update a scan schedule
Auth
Path Params
| storageId | string |
Request Body
| object | object | ||
| name | string | minLength: 1 pattern: | |
| workflowId | string | minLength: 1 | |
| recurrencePattern | object | ||
| type | string | ||
| minutelyRecurrence | |||
| object | object | ||
| everyNumberOfMinutes | int32 | maximum: 60 minimum: 5 | |
| hourlyRecurrence | |||
| object | object | ||
| everyNumberOfHours | int32 | maximum: 24 minimum: 1 | |
| dailyRecurrence | |||
| object | object | ||
| everyNumberOfDays | int32 | maximum: 365 minimum: 1 | |
| weeklyRecurrence | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrence | |||
| object | object | ||
| everyNumberOfMonths | int32 | maximum: 12 minimum: 1 | |
| dayOfMonth | int32 | maximum: 30 minimum: 1 | |
| startDate | date-time | ||
| timeToStart | date-time | ||
| avoidConcurrentScheduleRuns | boolean | ||
| scanPartition | string | ||
| priority | int32 | ||
| $type | string | ||
| id | string |
PUT
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Fetch scan schedules
Auth
Path Params
| sortDirection | integer | Enum: | |
| startIndex | integer | maximum: 2147483647 minimum: 0 | |
| count | integer | maximum: 2147483647 minimum: 1 |
Query String
| name | string | pattern: | |
| user | string | pattern: | |
| type | string | ||
| storageId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[object] | ||
| id | string | ||
| name | 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. | |
| type | string | ||
| scanPartition | string | ||
| createdAt | date-time | ||
| lastScanTime | date-time | ||
| nextScanTime | date-time | ||
| recurrencePatternDto | |||
| object | object | ||
| type | integer |
Enum: | |
| minutelyRecurrence | |||
| object | object | ||
| everyNumberOfMinutes | int32 | ||
| hourlyRecurrence | |||
| object | object | ||
| everyNumberOfHours | int32 | ||
| dailyRecurrence | |||
| object | object | ||
| everyNumberOfDays | int32 | ||
| weeklyRecurrence | |||
| object | object | ||
| daysOfWeek | array[integer] | Enum: | |
| everyNumberOfWeeks | int32 | ||
| monthlyRecurrence | |||
| object | object | ||
| everyNumberOfMonths | int32 | ||
| dayOfMonth | int32 | ||
| startDate | date-time | ||
| timeToStart | date-time | ||
| avoidConcurrentScheduleRuns | boolean | ||
| createdBy | string | ||
| priority | integer |
Enum: | |
| storageId | string | ||
| totalCount | int64 |
Response
Delete scan schedules
Auth
Request Body
| array | array[string] |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| areAllDeleted | boolean |
Response
Retrieve storage user name
Auth
Path Params
| storageId | string |
Query String
| userId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| userName | string |
Response
Retrieve storage user name
Auth
Path Params
| storageId | string | ||
| userId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| userName | string |
Response
User
Create, list and update user accounts
Endpoints
Fetch active users
Auth
Path Params
| startIndex | string | ||
| count | string |
Query String
| searchTerm | string | pattern: | |
| orderType | |||
| orderBy | |||
| searchText | string | pattern: |
GET
Responses
200
| object | object | ||
| entries | array[object] | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| tenantId | string | ||
| ssoUserId | string | ||
| totalCount | int64 |
Response
Register a user
Auth
Request Body
| object | object | ||
| fullName | string | minLength: 1 | |
| userName | string | minLength: 1 | |
| password | string | ||
| string | minLength: 1 | ||
| ssoUserId | string |
POST
Responses
200
| file | file |
Response
Create a user
Auth
Request Body
| object | object | ||
| fullName | string | minLength: 1 | |
| userName | string | minLength: 1 | |
| password | string | ||
| string | minLength: 1 | ||
| ssoUserId | string | ||
| role | integer |
Enum: |
POST
Responses
200
| file | file |
Response
Authenticate with a username and password
Authenticate with a username and password to obtain a JWT token,Most of the APIs require authentication in the form of providing a JWT token. Call this API in order to receive a token but please note that it's only valid for an hour so it should be periodically refreshed.
Auth
Request Body
| object | object | ||
| userName | string | login name of the user minLength: 1 | |
| password | string | password minLength: 1 |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| fullName | string | ||
| string | |||
| userName | string | ||
| role | |||
| integer | integer |
Enum: | |
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| tenantId | string | ||
| ssoUserId | string | ||
| userId | string |
Response
Fetch current user information
Retrieve information about the currently authenticated user.
Auth
GET
Responses
200
| object | object | ||
| username | string | ||
| string | |||
| authProvider | string | ||
| role | string | ||
| id | string |
Response
Refresh user token
Refresh an expired accessToken using a valid refreshToken
Auth
POST
Responses
200
| file | file |
Response
Logout
Auth
POST
Responses
200
| file | file |
Response
Update user role
Auth
Request Body
| object | object | ||
| userId | string | minLength: 1 | |
| role | integer |
Enum: |
PUT
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| tenantId | string | ||
| ssoUserId | string |
Response
Fetch users
Auth
Query String
| startIndex | integer | maximum: 2147483647 minimum: 0 | |
| count | integer | maximum: 2147483647 minimum: 1 | |
| orderType | |||
| orderBy | |||
| searchText | string | pattern: |
GET
Responses
200
| object | object | ||
| entries | array[object] | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| tenantId | string | ||
| ssoUserId | string | ||
| totalCount | int64 |
Response
Delete a user
Auth
Path Params
| userId | string |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| tenantId | string | ||
| ssoUserId | string |
Response
Update current user
Auth
Request Body
| object | object | ||
| userId | string | ||
| role | integer |
Enum: | |
| userName | string | ||
| fullName | string | ||
| currentPassword | string | ||
| newPassword | string | ||
| string |
PUT
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| tenantId | string | ||
| ssoUserId | string |
Response
Request password reset
Auth
Request Body
| object | object | ||
| userInput | string | minLength: 1 |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Reset user password
Auth
Request Body
| object | object | ||
| newPassword | string | minLength: 12 | |
| newPasswordConfirmation | string | minLength: 12 | |
| secureToken | string |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| user | |||
| object | object | ||
| id | string | ||
| userName | string | ||
| fullName | string | ||
| string | |||
| role | integer |
Enum: | |
| tenantId | string | ||
| ssoUserId | string |
Response
User Tour
Finalize and list user tours
Fetch tours completed by a user
Auth
Path Params
| userId | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| userId | string | ||
| userTours | array[object] | ||
| tourType | integer |
Enum: | |
| finalizedDate | date-time |
Response
Mark a specific Tour as completed by a user
Auth
Request Body
| object | object | ||
| userId | string | minLength: 1 | |
| userTourType | integer |
Enum: |
POST
Responses
200
| file | file |
Response
Webhook
Endpoints
File event trigger of real time processing
This endpoint takes the parameters and tries to find the file in the specified storage and applies the workflow for the specified file
Auth
Request Body
| object | object | ||
| metadata | string | minLength: 1 | |
| storageClientId | string | minLength: 1 | |
| scanId | string |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| correlationId | string |
400
404
Response
File event trigger of real time processing by storage client ID
This endpoint takes the parameter and tries to find the file in the specified storage and applies the workflow for the specified file
Auth
Path Params
| storageClientId | string |
Request Body
| No request body |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| correlationId | string |
400
404
Response
File event trigger of real time processing by storage client ID
This endpoint takes the parameter and tries to find the file in the specified storage and applies the workflow for the specified file
Auth
Path Params
| storageClientId | string | ||
| scanId | string |
Request Body
| No request body |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| correlationId | string |
400
404
Response
File event trigger of real time processing for Box
This endpoint takes the parameter and tries to find the file in the specified Box storage and applies the workflow for the specified file
Auth
Path Params
| storageClientId | string |
Request Body
| No request body |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| correlationId | string |
400
404
Response
File event trigger of real time processing for Box
This endpoint takes the parameter and tries to find the file in the specified Box storage and applies the workflow for the specified file
Auth
Path Params
| storageClientId | string | ||
| scanId | string |
Request Body
| No request body |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| correlationId | string |
400
404
Response
File event trigger of real time processing for Box
This endpoint takes the parameter and tries to find the file in the specified Box storage and applies the workflow for the specified file
Auth
Path Params
| storageClientId | string | ||
| scanId | string | ||
| tenantId | string |
Request Body
| No request body |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| correlationId | string |
400
404
Response
{scanId}
Auth
Path Params
| storageClientId | string | ||
| scanId | string |
Query String
| validationToken | string |
Request Body
| No request body |
POST
Responses
200
| file | file |
Response
{scanId}
Auth
Path Params
| storageClientId | string | ||
| scanId | string | ||
| tenantId | string |
Query String
| validationToken | string |
Request Body
| No request body |
POST
Responses
200
| file | file |
Response
Workflow
List, add, update and delete Workflows
Get Workflows
Auth
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entries | array[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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string |
Response
Add a new Workflow
Auth
Request Body
| object | object | ||
| scanPoolId | string | ||
| rules | array[string] | ||
| name | string | maxLength: 60 minLength: 3 | |
| userAgent | string | ||
| failOverScanPoolId | string | ||
| filters | |||
| object | object | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | integer |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| workflowId | string |
Response
Update an existing Workflow
Auth
Request Body
| object | object | ||
| id | string | minLength: 1 | |
| scanPoolId | string | ||
| scanProcessFlow | |||
| integer | integer |
Enum: | |
| rules | array[string] | ||
| name | string | maxLength: 60 minLength: 3 | |
| userAgent | string | ||
| failOverScanPoolId | string | ||
| failOverDisabled | boolean | ||
| filters | |||
| object | object | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| isIdentityScanningEnabled | boolean | ||
| scanIntervalDays | integer |
PATCH
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Get Workflow by ID
Auth
Path Params
| id | string |
GET
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| entry | |||
| object | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string |
Response
Delete a Workflow
Auth
Path Params
| id | string |
DELETE
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Set a Workflow as default
Auth
Path Params
| id | string |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string |
Response
Refresh supported technologies for a Workflow and return updated Workflow
Auth
Request Body
| object | object | ||
| workflowId | string |
POST
Responses
200
| object | object | ||
| result | integer |
Enum: | |
| responseKey | string | ||
| responseMessage | string | ||
| responseMessageParams | object | ||
| * | string | ||
| workflowDto | |||
| object | 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 | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| failOverScanPoolId | string | ||
| failOverScanPool | |||
| object | object | ||
| id | string | ||
| name | string | ||
| scanPoolType | integer |
Enum: | |
| isDefault | boolean | ||
| scanInstances | array[object] | ||
| id | string | ||
| scanPoolId | string | ||
| url | string | ||
| apiKey | string | ||
| timeout | string | ||
| scanInstanceType | integer |
Enum: | |
| filters | object | ||
| id | string | ||
| minimumSize | int64 | ||
| maximumSize | int64 | ||
| minimumDateTime | date-time | ||
| maximumDateTime | date-time | ||
| fileDefinition | |||
| object | object | ||
| blockingStrategy | integer |
Enum: | |
| configurableBlockingStrategy | object | ||
| shouldTreatFilesWithSensitiveDataAsBlocked | boolean | ||
| shouldTreatFilesWithVulnerabilitiesAsBlocked | boolean | ||
| remediations | array[object] | ||
| id | string | ||
| workflowId | string | ||
| isEnabled | boolean | ||
| configuration | string | ||
| type | integer |
Enum: | |
| handlingType | integer |
Enum: | |
| tenantId | string |
Response