MetaDefender Storage Security API v1

/api/account/{accountId}

/api/account/{accountId}/storages

/api/account/count

Fetch all accounts

Auth

GET /api/account

 --url 'http://<MDSS_HOST>/api/account' \
 
Copy

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageStatus	object
message	string
statusType	int32
scansInProgress	boolean
isRtpInProgress	boolean
isScheduledScanInProgress	boolean
storageFunctionality	string
$type	string
credentials	string
autoDiscovery	boolean
groupId	string
protocolType	int32

Response

Add an account

Auth

Query String

Name	string
Description	string
Credentials	string
ProtocolType
VendorType
AutoDiscovery	boolean
GroupId	string
StorageIds	array

Request Body

object	object
CredentialsFile	file

POST /api/account

Copy

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
account
object	object
id	string
name	string
description	string
credentials	string
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
autoDiscovery	boolean
groupId	string

Response

Copy

Update an account

Auth

Query String

AccountId	string
Name	string
Description	string
Credentials	string
ProtocolType
VendorType
AutoDiscovery	boolean
GroupId	string

Request Body

object	object
CredentialsFile	file

PATCH /api/account

Copy

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
accountId	string

Response

Copy

Fetch account by ID

Auth

Path Params

accountId string

GET /api/account/{accountId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
account
object	object
id	string
name	string
description	string
storages	array[object]
id	string
groupId	string
accountId	string
name	string
storageClientId	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageStatus	object
message	string
statusType	int32
scansInProgress	boolean
isRtpInProgress	boolean
isScheduledScanInProgress	boolean
storageFunctionality	string
$type	string
credentials	string
autoDiscovery	boolean
groupId	string
protocolType	int32

Response

Delete an account

Auth

Path Params

accountId string

DELETE /api/account/{accountId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
accountId	string

Response

Fetch available storage units for an account

Auth

Path Params

accountId string

GET /api/account/{accountId}/storages

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
bucketName	string

Response

Fetch the number of accounts

Auth

GET /api/account/count

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
accountCount
object	object
count	int64

Response

Audit

List audit information

/api/audit/{startIndex}/{count}

Fetch audit logs

Auth

Path Params

startIndex	string
count	string

Query String

logType	string
categoryType	string
logLevel	string
searchText	string

GET /api/audit/{startIndex}/{count}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
logLevel	integer	0: Debug 1: Info 2: Warn 3: Error Enum: `0`,`1`,`2`,`3`
details	string
logType
integer	integer	0: FileDiscovered 1: FileScanned 2: FileDiscoveryFailed 3: FileCancelled 100: ProcessStarted 101: ProcessCompleted 102: ProcessCancelled 103: ProcessFailed 200: FileTagged 201: FileSanitizedKeptOriginal 203: FileSanitizedDeletedOriginal 204: FileDecryption 205: BlockedFileMoved 206: BlockedFileDeleted 207: SanitizedFileMoved 208: AllowedFileMoved 209: BlockedFileCopied 210: SanitizedFileCopied 211: AllowedFileCopied 212: BlockedFileKept 213: AllowedFileKept 214: SanitizedFileKept 215: AllowedFileDeleted 300: StorageAdded 301: StorageUpdated 302: StorageRemoved 320: GroupAdded 321: GroupUpdated 322: GroupRemoved 330: AccountAdded 331: AccountUpdated 332: AccountRemoved 350: SecurityChecklistItem 351: SecurityChecklistVerified 400: Rtp 410: FileTagging 411: DeepCdrRemediation 412: SanitizedFilesRemediation 413: BlockedFilesRemediation 414: TreatFilesWithSensitiveDataAsBlocked 415: TreatFilesWithVulnerabilitiesAsBlocked 416: AllowedFilesRemediation 417: StrictBlockFilesStrategy 418: ConfigurableBlockFilesStrategy 419: DeletedEmptyFolders 600: LoggedIn 601: LoggedOut 602: UserCreated 603: UserRegistered 604: UserRoleUpdated 605: UserUpdated 606: UserRemoved 700: ScanInstanceAdd 701: ScanInstanceUpdate 702: ScanInstanceDelete 703: ScanInstanceImport 750: ScanPoolAdd 751: ScanPoolUpdate 752: ScanPoolDelete 753: ScanPoolImport 800: OnlineLicenseActivated 801: OfflineLicenseActivated 802: LicenseDeactivated 900: ConfigurationImported 901: ConfigurationExported 950: Notifications 975: Smtp 1000: ExternalLoggerAdd 1001: ExternalLoggerUpdate 1002: ExternalLoggerDelete 1100: DataRetention 1200: ApiKeyAdd 1201: ApiKeyUpdate 1202: ApiKeyDelete 1300: SsoConfiguration 1400: WorkflowAdd 1401: WorkflowUpdate 1402: WorkflowDelete 1403: WorkflowSetDefault 1404: WorkflowImport 1410: WorkflowTechnologies 1500: ScanAdd 1501: ScanUpdate 1502: ScanDelete 1503: ScanImport 1600: OnDemandScanRequest 1700: ReportGenerated 1800: TourFinalized 1900: ScanScheduleAdd 1901: ScanScheduleUpdate 1902: ScanScheduleDelete 1903: ScanScheduleImport 2000: Encryption 2101: RemediationAdd 2102: RemediationUpdate 2103: RemediationDelete Enum: `0`,`1`,`2`,`3`,`100`,`101`,`102`,`103`,`200`,`201`,`203`,`204`,`205`,`206`,`207`,`208`,`209`,`210`,`211`,`212`,`213`,`214`,`215`,`300`,`301`,`302`,`320`,`321`,`322`,`330`,`331`,`332`,`350`,`351`,`400`,`410`,`411`,`412`,`413`,`414`,`415`,`416`,`417`,`418`,`419`,`600`,`601`,`602`,`603`,`604`,`605`,`606`,`700`,`701`,`702`,`703`,`750`,`751`,`752`,`753`,`800`,`801`,`802`,`900`,`901`,`950`,`975`,`1000`,`1001`,`1002`,`1100`,`1200`,`1201`,`1202`,`1300`,`1400`,`1401`,`1402`,`1403`,`1404`,`1410`,`1500`,`1501`,`1502`,`1503`,`1600`,`1700`,`1800`,`1900`,`1901`,`1902`,`1903`,`2000`,`2101`,`2102`,`2103`
userId	string
category	integer	0: Processes 1: PostActions 2: StorageUnits 3: Authentication 4: Settings 6: Users 8: Notifications 9: GroupUnits 10: AccountUnits Enum: `0`,`1`,`2`,`3`,`4`,`6`,`8`,`9`,`10`
timeStamp	date-time
userName	string
filterCount	int64
totalCount	int64

Response

Configuration

Import or export configuration file

/api/configuration/export

/api/configuration/import

/api/configuration/enabledModules

Export configuration file

Export the current configuration settings to an archive. The file will be encrypted using the provided password.

Auth

Query String

exportLicense	boolean
exportSmtp	boolean
exportEmailNotifications	boolean
exportRetention	boolean
password	string

GET /api/configuration/export

Responses

200

file file

Response

Import configuration file

Auth

Request Body

object	object
ConfigurationFile	file
password	string

POST /api/configuration/import

Responses

200

object	object
result	integer	0: Success 1: FailedToUpgradeConfigFile 2: FailedRequestBodyIsEmpty 3: FailedToActivateLicense 4: FailedToDeserializeConfigFile 5: FailedOutdatedVersion 6: FailedInvalidConfigFile 7: FailedMissingPassword 8: FailedWrongPassword Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
areSmtpSettingsImported	boolean
isLicenseImported	boolean
isRetentionImported	boolean
activationDto
object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Get enabled modules

Auth

GET /api/configuration/enabledModules

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
enabledModules	array[integer]

Response

Connector

/api/connector

connector

Auth

Query String

sharePath	string
clientId	string

GET /api/connector

Responses

200

file file

Response

External Logger

Manage external loggers

/api/externallogger

/api/externallogger/status

/api/externallogger/udpSyslog

/api/externallogger/udpSyslog

/api/externallogger/kafka

/api/externallogger/kafka

/api/externallogger/{id}

Retrieve external loggers

Auth

GET /api/externallogger

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError Enum: `0`,`1`,`2`,`3`,`0`,`1`,`2`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
isEnabled	boolean
loggerType	integer	0: SyslogUdp 1: Kafka Enum: `0`,`1`
connectionSettings
object	object
$type	string

Response

Update external logger state

Auth

Request Body

object	object
id	string	minLength: 1
isEnabled	boolean

PUT /api/externallogger/status

Responses

200

file file

Response

Update a Syslog server configuration

Auth

Request Body

object	object
isEnabled	boolean
serverAddress	string	minLength: 1 pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]))$\|^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$\|^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z]\|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$
port	int32	pattern: `^()(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})$`
loggerType	integer	0: SyslogUdp 1: Kafka Enum: `0`,`1`
facility	integer	0: KernelMessages 1: UserLevelMessages 2: MailSystem 3: SystemDaemons 4: SecurityOrAuthorizationMessages1 5: InternalMessages 6: LinePrinterSubsystem 7: NetworkNewsSubsystem 8: UUCPSubsystem 9: ClockDaemon1 10: SecurityOrAuthorizationMessages2 11: FTPDaemon 12: NTPSubsystem 13: LogAudit 14: LogAlert 15: ClockDaemon2 16: LocalUse0 17: LocalUse1 18: LocalUse2 19: LocalUse3 20: LocalUse4 21: LocalUse5 22: LocalUse6 23: LocalUse7 Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`21`,`22`,`23`
format	integer	0: RFC5424 Enum: `0`
$type	string
id	string	minLength: 1

PUT /api/externallogger/udpSyslog

Responses

200

file file

Response

Add a new Syslog server configuration

Auth

Request Body

object	object
isEnabled	boolean
serverAddress	string	minLength: 1 pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]))$\|^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$\|^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z]\|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$
port	int32	pattern: `^()(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})$`
loggerType	integer	0: SyslogUdp 1: Kafka Enum: `0`,`1`
facility	integer	0: KernelMessages 1: UserLevelMessages 2: MailSystem 3: SystemDaemons 4: SecurityOrAuthorizationMessages1 5: InternalMessages 6: LinePrinterSubsystem 7: NetworkNewsSubsystem 8: UUCPSubsystem 9: ClockDaemon1 10: SecurityOrAuthorizationMessages2 11: FTPDaemon 12: NTPSubsystem 13: LogAudit 14: LogAlert 15: ClockDaemon2 16: LocalUse0 17: LocalUse1 18: LocalUse2 19: LocalUse3 20: LocalUse4 21: LocalUse5 22: LocalUse6 23: LocalUse7 Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`21`,`22`,`23`
format	integer	0: RFC5424 Enum: `0`
$type	string

POST /api/externallogger/udpSyslog

Responses

200

file file

Response

Update a Kafka server configuration

Auth

Request Body

object	object
isEnabled	boolean
serverAddressWithPortList	string	minLength: 1 pattern: ^(?:(?:(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})\|(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})\|(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z]\|[A-Za-z][A-Za-z0-9\-][A-Za-z0-9]):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})))(?:,(?:(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})\|(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})\|(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z]\|[A-Za-z][A-Za-z0-9\-][A-Za-z0-9]):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})))*?$
loggerType	integer	0: SyslogUdp 1: Kafka Enum: `0`,`1`
topic	string	minLength: 1
configuration	string	minLength: 1
$type	string
id	string	minLength: 1

PUT /api/externallogger/kafka

Responses

200

file file

Response

Add a new Kafka server configuration

Auth

Request Body

object	object
isEnabled	boolean
serverAddressWithPortList	string	minLength: 1 pattern: ^(?:(?:(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})\|(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})\|(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z]\|[A-Za-z][A-Za-z0-9\-][A-Za-z0-9]):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})))(?:,(?:(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})\|(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})\|(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z]\|[A-Za-z][A-Za-z0-9\-][A-Za-z0-9]):(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})))*?$
loggerType	integer	0: SyslogUdp 1: Kafka Enum: `0`,`1`
topic	string	minLength: 1
configuration	string	minLength: 1
$type	string

POST /api/externallogger/kafka

Responses

200

file file

Response

Delete external logger

Auth

Path Params

id string

DELETE /api/externallogger/{id}

Responses

200

file file

Response

File

Retrieve processed files information

Enumerate processed files

Auth

Query String

startIndex	integer	maximum: 2147483647 minimum: 0
count	integer	maximum: 10000 minimum: 1
startDate	string
endDate	string
search	string
scanType	array	Enum: `0`,`1`,`2`
storageId	array
scanId	array
scanWorkflowSnapshotId	array
processingState	array	Enum: `0`,`1`,`2`,`3`
result	array	Enum: `0`,`1`,`2`
scanAllResultI	array	Enum: `0`,`1`,`2`,`3`,`7`,`8`,`9`,`10`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`21`,`22`,`23`,`24`,`25`,`26`,`27`,`28`,`29`,`30`,`31`,`32`,`33`,`34`,`36`,`38`,`39`,`40`,`41`,`42`,`43`,`255`,`1014`,`9999`
scanResultICount	array
vulnerabilityCount	array
hasVulnerabilities	boolean
dlpDetection	boolean
remediations	array	Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
sortBy	array	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
sortOrder	array	Enum: `0`,`1`
expand	array

GET /api/file

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
scanId	string
name	string
path	string
hash	string
fileOwner
object	object
userId	string
fullName	string
userName	string
emailAddress	string
size	int64
storageType
object	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageName	string
storageLocation	string
scanName	string
progress
object	object
upload	int32
scan	int32
scanResult
object	object
extractedFiles
object	object
dataId	string
scanResultI	int32
detectedBy	int32
filesExtractedCount	int32
scanResults
object	object
scanDetails	array[object]
engineName	string
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
engId	string
waitTime	number
dataId	string
scanAllResultI	int32
scanAllResultA	string
startTime	string
totalTime	number
totalAvs	int32
totalDetections	int32
progressPercentage	int32
fileInfo
object	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo
object	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	0: Allowed 1: Blocked 2: Processing Enum: `0`,`1`,`2`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
cwes	array[string]
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependenciesPackageCount	int32
dependenciesVulnerabilityTotal	int32
dependenciesVulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
resultTemplateHash	string
vulnerabilityInfo
object	object
vulnerabilityInfoResult
object	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct
object	object
hasVulnerability	boolean
isCurrent	boolean
product
object	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor
object	object
id	int64
name	string
version	string
versionData
object	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details
object	object
cpe	string
cve	string
cvss
object	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3
object	object
attackComplexity	string
attackVector	string
availabilityImpact	string
baseScore	string
baseSeverity	string
confidentialityImpact	string
exploitabilityScore	string
impactScore	string
integrityImpact	string
privilegesRequired	string
scope	string
userInteraction	string
vectorString	string
cwe	string
lastModifiedEpoch	string
publishedEpoch	string
references	array[string]
severity	string
severityIndex	int32
staticId	int64
sessionCookie	string
processingState	integer	0: InProgress 1: Failed 2: Canceled 3: Available Enum: `0`,`1`,`2`,`3`
exception
object	object
exceptionDetails	string
exceptionMessage	string
created	date-time
lastModified	date-time
discoveryStarted	date-time
fileProcessingDetails
object	object
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
coreEngines	array[object]
engineId	string
engineName	string
engineVersion	string
dbVersion	string
definitionTime	string
remediation
object	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
isCopied	boolean
deepCdr
object	object
isSanitized	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
hasSanitizedFileBeenCopied	boolean
sanitizationDetails
object	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
exception
object	object
exceptionDetails	string
exceptionMessage	string
objectRemediationActions	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
objectActionState	integer	0: NotApplied 1: Applied 3: CannotBeApplied 4: Error 5: SanitizationSkipped Enum: `0`,`1`,`3`,`4`,`5`
exceptions	array[string]
id	string
fileId	string
fileScanCompletedTime	date-time
tenantId	string
lastUpdated	date-time
metaDefenderCoreUrl	string
discoveryStartedDaySec	int64
objectStorageMetadata	string
scanWorkflowSnapshotId	string
scanWorkflowSnapshot
object	object
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time
filterCount	int64
totalCount	int64

Response

Scan a file on demand

This request is used to update a scanned file with passwords, in case it is an encrypted archive andit could not be scanned because the passwords to decrypt it were not provided. It can also be used withoutproviding any passwords to simply rescan a specific file from a finished scan.

Auth

Request Body

object	object
fileId	string	minLength: 1
scanId	string	minLength: 1
storageProtocolType	int32
passwords	array[string]

PUT /api/file

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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 /api/file/{fileId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageName	string	Deprecated
storageLocation	string	Deprecated
scanName	string	Deprecated
progress		Deprecated
object	object
upload	int32
scan	int32
scanResult		Deprecated
object	object
extractedFiles
object	object
dataId	string
scanResultI	int32
detectedBy	int32
filesExtractedCount	int32
scanResults
object	object
scanDetails	array[object]
engineName	string
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
engId	string
waitTime	number
dataId	string
scanAllResultI	int32
scanAllResultA	string
startTime	string
totalTime	number
totalAvs	int32
totalDetections	int32
progressPercentage	int32
fileInfo
object	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo
object	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	0: Allowed 1: Blocked 2: Processing Enum: `0`,`1`,`2`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
cwes	array[string]
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependenciesPackageCount	int32
dependenciesVulnerabilityTotal	int32
dependenciesVulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
resultTemplateHash	string
vulnerabilityInfo
object	object
vulnerabilityInfoResult
object	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct
object	object
hasVulnerability	boolean
isCurrent	boolean
product
object	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor
object	object
id	int64
name	string
version	string
versionData
object	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details
object	object
cpe	string
cve	string
cvss
object	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3
object	object
attackComplexity	string
attackVector	string
availabilityImpact	string
baseScore	string
baseSeverity	string
confidentialityImpact	string
exploitabilityScore	string
impactScore	string
integrityImpact	string
privilegesRequired	string
scope	string
userInteraction	string
vectorString	string
cwe	string
lastModifiedEpoch	string
publishedEpoch	string
references	array[string]
severity	string
severityIndex	int32
staticId	int64
sessionCookie	string
processingState		Deprecated
integer	integer	0: InProgress 1: Failed 2: Canceled 3: Available Enum: `0`,`1`,`2`,`3`
exception		Deprecated
object	object
exceptionDetails	string
exceptionMessage	string
created	date-time	Deprecated
lastModified	date-time	Deprecated
discoveryStarted	date-time	Deprecated
fileProcessingDetails		Deprecated
object	object
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
coreEngines	array[object]	Deprecated
engineId	string
engineName	string
engineVersion	string
dbVersion	string
definitionTime	string
remediation		Deprecated
object	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
isCopied	boolean
deepCdr
object	object
isSanitized	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
hasSanitizedFileBeenCopied	boolean
sanitizationDetails
object	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
exception
object	object
exceptionDetails	string
exceptionMessage	string
objectRemediationActions	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
objectActionState	integer	0: NotApplied 1: Applied 3: CannotBeApplied 4: Error 5: SanitizationSkipped Enum: `0`,`1`,`3`,`4`,`5`
exceptions	array[string]
id	string
fileId	string
fileScanCompletedTime	date-time
tenantId	string
lastUpdated	date-time
metaDefenderCoreUrl	string	Deprecated
discoveryStartedDaySec	int64	Deprecated
fileDto
object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
scanId	string
name	string
path	string
hash	string
fileOwner
object	object
userId	string
fullName	string
userName	string
emailAddress	string
size	int64
storageType
object	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageName	string
storageLocation	string
scanName	string
progress
object	object
upload	int32
scan	int32
scanResult
object	object
extractedFiles
object	object
dataId	string
scanResultI	int32
detectedBy	int32
filesExtractedCount	int32
scanResults
object	object
scanDetails	array[object]
engineName	string
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
engId	string
waitTime	number
dataId	string
scanAllResultI	int32
scanAllResultA	string
startTime	string
totalTime	number
totalAvs	int32
totalDetections	int32
progressPercentage	int32
fileInfo
object	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo
object	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	0: Allowed 1: Blocked 2: Processing Enum: `0`,`1`,`2`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
cwes	array[string]
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependenciesPackageCount	int32
dependenciesVulnerabilityTotal	int32
dependenciesVulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
resultTemplateHash	string
vulnerabilityInfo
object	object
vulnerabilityInfoResult
object	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct
object	object
hasVulnerability	boolean
isCurrent	boolean
product
object	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor
object	object
id	int64
name	string
version	string
versionData
object	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details
object	object
cpe	string
cve	string
cvss
object	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3
object	object
attackComplexity	string
attackVector	string
availabilityImpact	string
baseScore	string
baseSeverity	string
confidentialityImpact	string
exploitabilityScore	string
impactScore	string
integrityImpact	string
privilegesRequired	string
scope	string
userInteraction	string
vectorString	string
cwe	string
lastModifiedEpoch	string
publishedEpoch	string
references	array[string]
severity	string
severityIndex	int32
staticId	int64
sessionCookie	string
processingState	integer	0: InProgress 1: Failed 2: Canceled 3: Available Enum: `0`,`1`,`2`,`3`
exception
object	object
exceptionDetails	string
exceptionMessage	string
created	date-time
lastModified	date-time
discoveryStarted	date-time
fileProcessingDetails
object	object
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
coreEngines	array[object]
engineId	string
engineName	string
engineVersion	string
dbVersion	string
definitionTime	string
remediation
object	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
isCopied	boolean
deepCdr
object	object
isSanitized	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
hasSanitizedFileBeenCopied	boolean
sanitizationDetails
object	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
exception
object	object
exceptionDetails	string
exceptionMessage	string
objectRemediationActions	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
objectActionState	integer	0: NotApplied 1: Applied 3: CannotBeApplied 4: Error 5: SanitizationSkipped Enum: `0`,`1`,`3`,`4`,`5`
exceptions	array[string]
id	string
fileId	string
fileScanCompletedTime	date-time
tenantId	string
lastUpdated	date-time
metaDefenderCoreUrl	string
discoveryStartedDaySec	int64
objectStorageMetadata	string
scanWorkflowSnapshotId	string
scanWorkflowSnapshot
object	object
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time

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 /api/file/archive

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
archiveScanResults	array[object]
extractedFiles
object	object
dataId	string
scanResultI	int32
detectedBy	int32
filesExtractedCount	int32
scanResults
object	object
scanDetails	array[object]
engineName	string
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
engId	string
waitTime	number
dataId	string
scanAllResultI	int32
scanAllResultA	string
startTime	string
totalTime	number
totalAvs	int32
totalDetections	int32
progressPercentage	int32
fileInfo
object	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo
object	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	0: Allowed 1: Blocked 2: Processing Enum: `0`,`1`,`2`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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

Response

Cancel a file in an ongoing scan

Auth

Request Body

object	object
fileIds	array[string]

POST /api/file/cancel

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageName	string	Deprecated
storageLocation	string	Deprecated
scanName	string	Deprecated
progress		Deprecated
object	object
upload	int32
scan	int32
scanResult		Deprecated
object	object
extractedFiles
object	object
dataId	string
scanResultI	int32
detectedBy	int32
filesExtractedCount	int32
scanResults
object	object
scanDetails	array[object]
engineName	string
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
engId	string
waitTime	number
dataId	string
scanAllResultI	int32
scanAllResultA	string
startTime	string
totalTime	number
totalAvs	int32
totalDetections	int32
progressPercentage	int32
fileInfo
object	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo
object	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	0: Allowed 1: Blocked 2: Processing Enum: `0`,`1`,`2`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
cwes	array[string]
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependenciesPackageCount	int32
dependenciesVulnerabilityTotal	int32
dependenciesVulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
resultTemplateHash	string
vulnerabilityInfo
object	object
vulnerabilityInfoResult
object	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct
object	object
hasVulnerability	boolean
isCurrent	boolean
product
object	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor
object	object
id	int64
name	string
version	string
versionData
object	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details
object	object
cpe	string
cve	string
cvss
object	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3
object	object
attackComplexity	string
attackVector	string
availabilityImpact	string
baseScore	string
baseSeverity	string
confidentialityImpact	string
exploitabilityScore	string
impactScore	string
integrityImpact	string
privilegesRequired	string
scope	string
userInteraction	string
vectorString	string
cwe	string
lastModifiedEpoch	string
publishedEpoch	string
references	array[string]
severity	string
severityIndex	int32
staticId	int64
sessionCookie	string
processingState		Deprecated
integer	integer	0: InProgress 1: Failed 2: Canceled 3: Available Enum: `0`,`1`,`2`,`3`
exception		Deprecated
object	object
exceptionDetails	string
exceptionMessage	string
created	date-time	Deprecated
lastModified	date-time	Deprecated
discoveryStarted	date-time	Deprecated
fileProcessingDetails		Deprecated
object	object
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
coreEngines	array[object]	Deprecated
engineId	string
engineName	string
engineVersion	string
dbVersion	string
definitionTime	string
remediation		Deprecated
object	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
isCopied	boolean
deepCdr
object	object
isSanitized	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
hasSanitizedFileBeenCopied	boolean
sanitizationDetails
object	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
exception
object	object
exceptionDetails	string
exceptionMessage	string
objectRemediationActions	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
objectActionState	integer	0: NotApplied 1: Applied 3: CannotBeApplied 4: Error 5: SanitizationSkipped Enum: `0`,`1`,`3`,`4`,`5`
exceptions	array[string]
id	string
fileId	string
fileScanCompletedTime	date-time
tenantId	string
lastUpdated	date-time
metaDefenderCoreUrl	string	Deprecated
discoveryStartedDaySec	int64	Deprecated
fileDto
object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
scanId	string
name	string
path	string
hash	string
fileOwner
object	object
userId	string
fullName	string
userName	string
emailAddress	string
size	int64
storageType
object	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageName	string
storageLocation	string
scanName	string
progress
object	object
upload	int32
scan	int32
scanResult
object	object
extractedFiles
object	object
dataId	string
scanResultI	int32
detectedBy	int32
filesExtractedCount	int32
scanResults
object	object
scanDetails	array[object]
engineName	string
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
engId	string
waitTime	number
dataId	string
scanAllResultI	int32
scanAllResultA	string
startTime	string
totalTime	number
totalAvs	int32
totalDetections	int32
progressPercentage	int32
fileInfo
object	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeDescription	string
fileTypeExtension	string
displayName	string
originalFilePath	string
processInfo
object	object
postProcessing
object	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails
object	object
failureCategory	string
details	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
resultI	integer	0: Allowed 1: Blocked 2: Processing Enum: `0`,`1`,`2`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
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	0: None 1: Critical 2: High 3: Medium 4: Low 5: Unknown Enum: `0`,`1`,`2`,`3`,`4`,`5`
source	string
fixedVersions	string
cwes	array[string]
vulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependenciesPackageCount	int32
dependenciesVulnerabilityTotal	int32
dependenciesVulnerabilityCounts
object	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
resultTemplateHash	string
vulnerabilityInfo
object	object
vulnerabilityInfoResult
object	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct
object	object
hasVulnerability	boolean
isCurrent	boolean
product
object	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor
object	object
id	int64
name	string
version	string
versionData
object	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details
object	object
cpe	string
cve	string
cvss
object	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3
object	object
attackComplexity	string
attackVector	string
availabilityImpact	string
baseScore	string
baseSeverity	string
confidentialityImpact	string
exploitabilityScore	string
impactScore	string
integrityImpact	string
privilegesRequired	string
scope	string
userInteraction	string
vectorString	string
cwe	string
lastModifiedEpoch	string
publishedEpoch	string
references	array[string]
severity	string
severityIndex	int32
staticId	int64
sessionCookie	string
processingState	integer	0: InProgress 1: Failed 2: Canceled 3: Available Enum: `0`,`1`,`2`,`3`
exception
object	object
exceptionDetails	string
exceptionMessage	string
created	date-time
lastModified	date-time
discoveryStarted	date-time
fileProcessingDetails
object	object
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
coreEngines	array[object]
engineId	string
engineName	string
engineVersion	string
dbVersion	string
definitionTime	string
remediation
object	object
isTagged	boolean
isDeleted	boolean
isMoved	boolean
isCopied	boolean
deepCdr
object	object
isSanitized	boolean
isOriginalVersionOfSanitizedFile	boolean
hasSanitizedFileBeenMoved	boolean
hasSanitizedFileBeenCopied	boolean
sanitizationDetails
object	object
failureCategory	string
details	string
postActionFailedInformation	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
exception
object	object
exceptionDetails	string
exceptionMessage	string
objectRemediationActions	array[object]
objectActionType	integer	0: Tagging 5: AllowedMoved 6: BlockedMoved 7: BlockedDelete 8: AllowedSanitizedMoved 9: AllowedCopied 10: BlockedCopied 11: AllowedSanitizedCopied 12: AllowedSanitizedDeleted 13: AllowedDeleted 14: AllowedKept 15: BlockedKept 16: AllowedSanitizedKept 17: BlockedSanitizedCopied 18: BlockedSanitizedMoved 19: BlockedSanitizedDeleted 20: BlockedSanitizedKept 100: SoftDelete 101: PackageDelete 102: Copy Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
objectActionState	integer	0: NotApplied 1: Applied 3: CannotBeApplied 4: Error 5: SanitizationSkipped Enum: `0`,`1`,`3`,`4`,`5`
exceptions	array[string]
id	string
fileId	string
fileScanCompletedTime	date-time
tenantId	string
lastUpdated	date-time
metaDefenderCoreUrl	string
discoveryStartedDaySec	int64
objectStorageMetadata	string
scanWorkflowSnapshotId	string
scanWorkflowSnapshot
object	object
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time

Response

Fetch all groups

Auth

GET /api/group

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageStatus	object
message	string
statusType	int32
scansInProgress	boolean
isRtpInProgress	boolean
isScheduledScanInProgress	boolean
storageFunctionality	string
$type	string

Response

Add a group

Auth

Request Body

object	object
name	string	minLength: 1
description	string
storageIds	array[string]

POST /api/group

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
group
object	object
id	string
name	string
description	string
storages	array[object]
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string

Response

Update a group

Auth

Request Body

object	object
name	string
description	string
groupId	string	minLength: 1

PATCH /api/group

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
updatedGroup
object	object
id	string
name	string
description	string
storages	array[object]
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string

Response

Fetch group by ID

Auth

Path Params

groupId string

GET /api/group/{groupId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageStatus	object
message	string
statusType	int32
scansInProgress	boolean
isRtpInProgress	boolean
isScheduledScanInProgress	boolean
storageFunctionality	string
$type	string

Response

Delete a group

Auth

Path Params

groupId string

DELETE /api/group/{groupId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Fetch the number of groups

Auth

GET /api/group/count

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
groupCount	object
count	int64

Response

Health Status

API that responds with 200 OK if application is running.

/api/health

Get health status

Auth

Query String

verbose

boolean

Default: false

GET /api/health

Responses

200

object	object
apiStatus	string

Response

Onboarding

Manage onboarding

Fetch onboarding configuration

Auth

Query String

newConfigSetup	boolean
newDefaultWorkflow	boolean

GET /api/onboarding

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
hasUserConfigured	boolean
hasStorageConfigured	boolean
hasScanInstanceConfigured	boolean
isOnboardingDone	boolean
isEulaAgreed	boolean
isCloudType	boolean

Response

Finish onboarding

Auth

POST /api/onboarding

Responses

200

file file

Response

Accept Eula

Auth

POST /api/onboarding/eula

Responses

200

file file

Response

Remediations

Remediations information

/api/remediations/workflow/{id}

/api/remediations/{id}

/api/remediations/{id}

Get Remediations by workflow id

Auth

Path Params

id string

GET /api/remediations/workflow/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`

Response

Get Remediation by id

Auth

Path Params

id string

GET /api/remediations/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entry
object	object
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`

Response

Delete Remediation

Auth

Path Params

id string

DELETE /api/remediations/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Add Remediation

Auth

Request Body

object	object
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`

POST /api/remediations

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType
integer	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`

PATCH /api/remediations

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Report

Generate reports

/api/report

/api/report/download/{scanId}

Get scans report

Auth

Query String

storageId	string
name	string
scanTypesFilter	array	Enum: `0`,`1`,`2`
scanStatesFilter	array	Enum: `0`,`1`,`2`,`3`,`4`
startDate	string
endDate	string
sortDirectionFilter
startIndex	integer
count	integer

GET /api/report

Responses

200

object	object
result	integer	0: Success 1: StorageNotFound Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	integer	0: NotStarted 1: Running 2: Cancelled 3: Failed 4: Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
infectedFilesCount	int64
filesWithVulnerabilitiesCount	int64
filesWithSensitiveDataCount	int64
scanSequenceDto
object	object
previousScanId	string
nextScanId	string
workflowId	string	minLength: 1
scanConfigurationId	string
errors	array[string]
priority	integer	0: Low 1: Medium 2: High Enum: `0`,`1`,`2`
scanWorkflowSnapshotDtos	array[object]
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time
totalCount	int64

Response

Download PDF Report

Auth

Path Params

scanId string

Query String

typeOfReport	integer	Enum: `0`,`1`
startIndex	integer	maximum: 2147483647 minimum: 0
count	integer	maximum: 10000 minimum: 1
startDate	string
endDate	string
search	string
scanType	array	Enum: `0`,`1`,`2`
storageId	array
scanId	array
scanWorkflowSnapshotId	array
processingState	array	Enum: `0`,`1`,`2`,`3`
result	array	Enum: `0`,`1`,`2`
scanAllResultI	array	Enum: `0`,`1`,`2`,`3`,`7`,`8`,`9`,`10`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`21`,`22`,`23`,`24`,`25`,`26`,`27`,`28`,`29`,`30`,`31`,`32`,`33`,`34`,`36`,`38`,`39`,`40`,`41`,`42`,`43`,`255`,`1014`,`9999`
scanResultICount	array
vulnerabilityCount	array
hasVulnerabilities	boolean
dlpDetection	boolean
remediations	array	Enum: `0`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`19`,`20`,`100`,`101`,`102`
sortBy	array	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
sortOrder	array	Enum: `0`,`1`
expand	array

GET /api/report/download/{scanId}

Responses

200

file file

Response

Scan

Manage your scans

/api/scan/stop/{scanId}

/api/scan/scheduled/{storageId}

/api/scan/{storageId}

/api/scan/last_completed/{storageId}

/api/scan/active/{scanId}

/api/scan/realtime/{storageId}

Get scan by ID

Auth

Path Params

scanId string

GET /api/scan/{scanId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scan
object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	integer	0: NotStarted 1: Running 2: Cancelled 3: Failed 4: Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
infectedFilesCount	int64
filesWithVulnerabilitiesCount	int64
filesWithSensitiveDataCount	int64
scanSequenceDto
object	object
previousScanId	string
nextScanId	string
workflowId	string	minLength: 1
scanConfigurationId	string
errors	array[string]
priority	integer	0: Low 1: Medium 2: High Enum: `0`,`1`,`2`
scanWorkflowSnapshotDtos	array[object]
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time

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, and Google Cloud: Including the Folder Location integrated in MDSS and excluding the Bucket Name, Container, etc. For Box: With or without the "All Files" folder For Sharepoint and Onedrive: Excluding the Document Library, Site, or Group For NFS / SMB / SFTP: Only the folder path beyond your configured storage root (do not include the base path set during integration)

Auth

Request Body

object	object
storageId	string	Deprecated
name	string	pattern: `^[^@#$%&*"';:.\|,{}?+=><`~^[]!\]+$`
folder	string
priority	int32
storageIds	array[string]
workflowId	string	minLength: 1
scanConfigurationId	string
scanConfigDto
object	object
realTimeScanConfig
object	object
isEnabled	boolean
startDate	date-time
handlingType	integer	0: Polling 1: EventBased Enum: `0`,`1`

POST /api/scan/start

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scanId	string
scanIds	array[string]

Response

Stop a scan

Auth

Path Params

scanId string

POST /api/scan/stop/{scanId}

Responses

200

file file

Response

Get next scheduled scan

Auth

Path Params

storageId string

GET /api/scan/scheduled/{storageId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
nextScheduledScan
object	object
id	string
name	string
storageId	string
userId	string
createdAt	date-time
nextScanTime	date-time
lastScanTime	date-time
workflowId	string
recurrencePattern	object
type	integer	0: Hourly 1: Daily 2: Weekly 3: Monthly Enum: `0`,`1`,`2`,`3`
hourlyRecurrence
object	object
everyNumberOfHours	int32
dailyRecurrence
object	object
everyNumberOfDays	int32
weeklyRecurrence
object	object
daysOfWeek	array[integer]	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
everyNumberOfWeeks	int32
monthlyRecurrence
object	object
everyNumberOfMonths	int32
dayOfMonth	int32
startDate	date-time
timeToStart	date-time
priority	integer	0: Low 1: Medium 2: High Enum: `0`,`1`,`2`
additionalProperties	string
scheduledScansCount	int32

Response

Delete scans

Auth

Path Params

storageId string

Request Body

array array[string]

DELETE /api/scan/{storageId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Polling 1: EventBased Enum: `0`,`1`
discoveryState	integer	0: NotStarted 1: Running 2: Cancelled 3: Failed 4: Completed Enum: `0`,`1`,`2`,`3`,`4`
scanningState	integer	0: NotStarted 1: Running 2: Cancelled 3: Failed 4: Completed Enum: `0`,`1`,`2`,`3`,`4`
scanType	integer	0: Instant 1: Scheduled 2: RealTime Enum: `0`,`1`,`2`
startTime	date-time
stopTime	date-time
priority	integer	0: Low 1: Medium 2: High Enum: `0`,`1`,`2`
additionalProperties	string
tenantId	string
errors	array[string]

Response

Fetch last completed scan

Auth

Path Params

storageId string

GET /api/scan/last_completed/{storageId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scan
object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	integer	0: NotStarted 1: Running 2: Cancelled 3: Failed 4: Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
infectedFilesCount	int64
filesWithVulnerabilitiesCount	int64
filesWithSensitiveDataCount	int64
scanSequenceDto
object	object
previousScanId	string
nextScanId	string
workflowId	string	minLength: 1
scanConfigurationId	string
errors	array[string]
priority	integer	0: Low 1: Medium 2: High Enum: `0`,`1`,`2`
scanWorkflowSnapshotDtos	array[object]
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time

Response

Get an active scan by scan ID

Auth

Path Params

scanId string

GET /api/scan/active/{scanId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scan
object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	integer	0: NotStarted 1: Running 2: Cancelled 3: Failed 4: Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
infectedFilesCount	int64
filesWithVulnerabilitiesCount	int64
filesWithSensitiveDataCount	int64
scanSequenceDto
object	object
previousScanId	string
nextScanId	string
workflowId	string	minLength: 1
scanConfigurationId	string
errors	array[string]
priority	integer	0: Low 1: Medium 2: High Enum: `0`,`1`,`2`
scanWorkflowSnapshotDtos	array[object]
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time
serviceName	string
storageName	string
currentProcessingFilePath	string
currentProcessingFileProgress	string
discoveryState	integer	0: NotStarted 1: Running 2: Cancelled 3: Failed 4: Completed Enum: `0`,`1`,`2`,`3`,`4`
statusMessages	array[object]
message	string
severity	integer	0: Information 1: Warning 2: Error Enum: `0`,`1`,`2`

Response

Get Real-Time scan by storage Id

Auth

Path Params

storageId string

GET /api/scan/realtime/{storageId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scan
object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
id	string
name	string
startTime	date-time
stopTime	date-time
scanType	string
scanningState	integer	0: NotStarted 1: Running 2: Cancelled 3: Failed 4: Completed Enum: `0`,`1`,`2`,`3`,`4`
scanStatusDto	object
pendingFilesCount	int64
allowedFilesCount	int64
blockedFilesCount	int64
totalFilesCount	int64
processingFailedCount	int64
processedFilesCount	int64
scanStatsDto	object
infectedFilesCount	int64
filesWithVulnerabilitiesCount	int64
filesWithSensitiveDataCount	int64
scanSequenceDto
object	object
previousScanId	string
nextScanId	string
workflowId	string	minLength: 1
scanConfigurationId	string
errors	array[string]
priority	integer	0: Low 1: Medium 2: High Enum: `0`,`1`,`2`
scanWorkflowSnapshotDtos	array[object]
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time
isRealTimeEnabled	boolean
handlingType	integer	0: Polling 1: EventBased Enum: `0`,`1`

Response

Scan Instance

List, add, update and delete Scan Instances

/api/scaninstance/{id}

/api/scaninstance/{id}

/api/scaninstance/Test

Get Scan Instances

Auth

Query String

scanPoolId string

GET /api/scaninstance

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`

Response

Update an existing Scan Instance

Auth

Request Body

object	object
id	string	minLength: 1
url	string	pattern: `^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})?)?$)\|(^((https?):\/\/)?\[(?:0\:)?:?01\](:(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})?)?$)).)$`
apiKey	string
timeout	string

PUT /api/scaninstance

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Add a new Scan Instance

Auth

Request Body

object	object
scanPoolId	string	minLength: 1
url	string	minLength: 1 pattern: `^((?!(^((https?):\/\/)?127(?:\.[0-9]+){0,2}\.[0-9]+(:(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})?)?$)\|(^((https?):\/\/)?\[(?:0\:)?:?01\](:(6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5]\|[1-5][0-9]{4}\|[1-9][0-9]{0,3})?)?$)).)$`
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`

POST /api/scaninstance

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scanInstanceId	string

Response

Get Scan Instance by ID

Auth

Path Params

id string

GET /api/scaninstance/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entry
object	object
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`

Response

Delete a Scan Instance

Auth

Path Params

id string

DELETE /api/scaninstance/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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

POST /api/scaninstance/Test

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Scan Pool

List, add, update and delete Scan Pools

Get Scan Pools

Auth

GET /api/scanpool

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`

Response

Update an existing Scan Pool

Auth

Request Body

object object

string

minLength: 1

name

string

maxLength: 30

minLength: 3

PUT /api/scanpool

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Add a new Scan Pool

Auth

Request Body

object object

name

string

maxLength: 30

minLength: 3

scanPoolType

integer

0: MdCore
1: MdCloud

Enum: 0,1

POST /api/scanpool

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scanPoolId	string

Response

Get Scan Pool by ID

Auth

Path Params

id string

GET /api/scanpool/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entry
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`

Response

Delete a Scan Pool

Auth

Path Params

id string

DELETE /api/scanpool/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Scan Workflow Snapshot

List scan workflow snapshots

/api/scanworkflowsnapshot/getAllFromScan/{scanId}

Get all scan workflow snapshots by scan ID

Auth

Path Params

scanId string

GET /api/scanworkflowsnapshot/getAllFromScan/{scanId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
scanWorkflowSnapshots	array[object]
id	string
scanId	string
workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`
startTimestamp	int64
stopTimestamp	int64
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
storage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
workflowStatistics	object
taggingStatistics
object	object
total	int64
keepAllowedStatistics
object	object
total	int64
keepBlockedStatistics
object	object
total	int64
keepSanitizedStatistics
object	object
total	int64
movedAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedSanitizedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
movedBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyAllowedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
copyBlockedStatistics
object	object
total	int64
destinationStorageInformation	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string
deleteAllowedStatistics
object	object
total	int64
deleteBlockedStatistics
object	object
total	int64
lastCalculatedStatisticsTime	date-time

Response

Settings

List or update your settings

/api/settings/notifications

/api/settings/notifications

/api/settings/admin/license/activate/online

/api/settings/admin/license/activate/offline

/api/settings/admin/license

/api/settings/admin/license/deactivate

/api/settings/retention

/api/settings/retention

/api/settings/encryption/generate

/api/settings/encryption/creation-date

Get notifications configuration

Auth

GET /api/settings/notifications

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
emailNotificationsConfig
object	object
generatedReportNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	0: OwnerOnly 1: AllRegisteredUsers Enum: `0`,`1`
userRequestNotificationsConfig
object	object
isEnabled	boolean
blockedFileNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	0: AllRegisteredUsers 1: FileOwner 2: FileOwnerAndAllRegisteredUsers Enum: `0`,`1`,`2`
webhookNotificationsConfig
object	object
scanCompletedNotificationsConfig
object	object
isEnabled	boolean
destinationAddress	string
headers	object
*	string
requestType	integer	0: Post 1: Put Enum: `0`,`1`

Response

Update notifications configuration

Auth

Request Body

object	object
emailNotificationsConfig
object	object
generatedReportNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	0: OwnerOnly 1: AllRegisteredUsers Enum: `0`,`1`
userRequestNotificationsConfig
object	object
isEnabled	boolean
blockedFileNotificationsConfig
object	object
isEnabled	boolean
recipientsType	integer	0: AllRegisteredUsers 1: FileOwner 2: FileOwnerAndAllRegisteredUsers Enum: `0`,`1`,`2`
webhookNotificationsConfig
object	object
scanCompletedNotificationsConfig
object	object
isEnabled	boolean
destinationAddress	string
headers	object
*	string
requestType	integer	0: Post 1: Put Enum: `0`,`1`

PUT /api/settings/notifications

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
newNotificationsConfig
object	object
id	string
emailNotificationsConfig	object
userRequestNotificationsConfig	object
isEnabled	boolean
generatedReportNotificationsConfig	object
isEnabled	boolean
recipientsType	integer	0: OwnerOnly 1: AllRegisteredUsers Enum: `0`,`1`
blockedFileNotificationsConfig	object
isEnabled	boolean
recipientsType	integer	0: AllRegisteredUsers 1: FileOwner 2: FileOwnerAndAllRegisteredUsers Enum: `0`,`1`,`2`
webhookNotificationsConfig	object
scanCompletedNotificationsConfig	object
isEnabled	boolean
destinationAddress	string
headers	object
*	string
requestType	integer	0: Post 1: Put Enum: `0`,`1`
initialNotificationsConfig
object	object
id	string
emailNotificationsConfig	object
userRequestNotificationsConfig	object
isEnabled	boolean
generatedReportNotificationsConfig	object
isEnabled	boolean
recipientsType	integer	0: OwnerOnly 1: AllRegisteredUsers Enum: `0`,`1`
blockedFileNotificationsConfig	object
isEnabled	boolean
recipientsType	integer	0: AllRegisteredUsers 1: FileOwner 2: FileOwnerAndAllRegisteredUsers Enum: `0`,`1`,`2`
webhookNotificationsConfig	object
scanCompletedNotificationsConfig	object
isEnabled	boolean
destinationAddress	string
headers	object
*	string
requestType	integer	0: Post 1: Put Enum: `0`,`1`

Response

Fetch SMTP configuration

Auth

GET /api/settings/smtp

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
host	string
port	int32
baseUrl	string
senderAddress	string
senderName	string
domain	string
username	string
secureSocketOption	integer	0: None 1: Auto 2: SslOnConnect 3: StartTls 4: StartTlsWhenAvailable Enum: `0`,`1`,`2`,`3`,`4`
ignoreCertWarnings	boolean
isSmtpEnabled	boolean

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	0: None 1: Auto 2: SslOnConnect 3: StartTls 4: StartTlsWhenAvailable Enum: `0`,`1`,`2`,`3`,`4`
ignoreCertWarnings	boolean
isSmtpEnabled	boolean

PATCH /api/settings/smtp

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: None 1: Auto 2: SslOnConnect 3: StartTls 4: StartTlsWhenAvailable Enum: `0`,`1`,`2`,`3`,`4`
ignoreCertWarnings	boolean
isSmtpEnabled	boolean
oldSmtpConfig
object	object
host	string
baseUrl	string
port	int32
senderAddress	string
senderName	string
domain	string
username	string
secureSocketOption	integer	0: None 1: Auto 2: SslOnConnect 3: StartTls 4: StartTlsWhenAvailable Enum: `0`,`1`,`2`,`3`,`4`
ignoreCertWarnings	boolean
isSmtpEnabled	boolean

Response

Online license activation

Auth

Request Body

object	object
key	string	minLength: 1

POST /api/settings/admin/license/activate/online

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Offline license activation

Auth

Request Body

object	object
LicenseContent	file

POST /api/settings/admin/license/activate/offline

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Get license details

Auth

GET /api/settings/admin/license

Responses

200

object	object
apiStatus	string

Response

Deactivate license

Auth

POST /api/settings/admin/license/deactivate

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Fetch retention configuration

Auth

GET /api/settings/retention

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
retentionAuditDays	int32
reportRetentionConfiguration
object	object
isEnabled	boolean
retentionDays	int32
rtpHistoryRetentionConfiguration
object	object
isEnabled	boolean
retentionDays	int32

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 /api/settings/retention

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Generate encryption key

Generate a new encryption key, replacing the old one if it exists.

Auth

POST /api/settings/encryption/generate

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Get encryption key creation date

Get the creation date of the encryption key.

Auth

GET /api/settings/encryption/creation-date

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
creationDate	date-time

Response

Sso

Sso Authentication and Sso configuration update

Get Sso Configuration

Auth

GET /api/sso/config

Responses

200

object	object
isEnabled	boolean
ssoProvider	integer	0: Azure 1: Okta 2: Auth0 3: Adfs 4: PingFederate 5: Opswat Enum: `0`,`1`,`2`,`3`,`4`,`5`
ssoType	integer	0: OpenIdConnect 1: Saml2 Enum: `0`,`1`
baseUrl	string
clientId	string
clientSecret	string
authority	string
identityProviderCertificate	string
identityProviderIssuer	string
loginUrl	string
logoutUrl	string
administratorRoleName	string
readonlyRoleName	string

Response

Update Sso Configuration

Auth

Request Body

object	object
clientId	string	maxLength: 255
clientSecret	string	maxLength: 255
authority	string	maxLength: 255
baseUrl	string	maxLength: 255
identityProviderCertificate	object
content	string
identityProviderIssuer	string	maxLength: 255
identityProviderLoginUrl	string	maxLength: 255
identityProviderLogoutUrl	string	maxLength: 255
isEnabled	boolean
ssoType	int32
ssoProvider	int32
administratorRoleName	string	maxLength: 63
readonlyRoleName	string	maxLength: 63

PATCH /api/sso

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
clientId	string
authority	string
baseUrl	string
isEnabled	boolean
ssoType	integer	0: OpenIdConnect Enum: `0`
ssoProvider	integer	0: Azure 1: Okta 2: Auth0 3: Adfs 4: PingFederate Enum: `0`,`1`,`2`,`3`,`4`
identityProviderIssuer	string
identityProviderLoginUrl	string
identityProviderLogoutUrl	string
administratorRoleName	string
readonlyRoleName	string
ssoConfig
object	object
isEnabled	boolean
ssoProvider	integer	0: Azure 1: Okta 2: Auth0 3: Adfs 4: PingFederate 5: Opswat Enum: `0`,`1`,`2`,`3`,`4`,`5`
ssoType	integer	0: OpenIdConnect 1: Saml2 Enum: `0`,`1`
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

/api/storage/all

/api/storage/{storageId}

/api/storage/{storageId}

PATCH

/api/storage/{storageId}

/api/storage/{storageId}/users

/api/storage/enumerate/{startIndex}/{count}

/api/storage/{storageId}/scan_schedule

/api/storage/scan_schedule/update/{storageId}

/api/storage/scan_schedules/{storageId}/{sortDirection}/{startIndex}/{count}

/api/storage/scan_schedule

/api/storage/{storageId}/user

/api/storage/{storageId}/{userId}

Fetch all storage units

Auth

GET /api/storage/all

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageStatus	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 /api/storage/{storageId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageStatus	object
message	string
statusType	int32
scansInProgress	boolean
isRtpInProgress	boolean
isScheduledScanInProgress	boolean
storageFunctionality	string
$type	string

Response

Delete a storage

Auth

Path Params

storageId string

Query String

forceDelete

boolean

Default: false

DELETE /api/storage/{storageId}

Responses

200

file file

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 /api/storage/{storageId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
updatedStorage
object	object
id	string
name	string
groupId	string
clientId	string
accountId	string
storageCredentials	string
source	string
storageFunctionality	string
storageType	object
name	string
categoryType	integer	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem 100: GitHubSdk 101: DockerHubSdk 102: BitbucketSdk 103: AmazonEcrSdk 104: QuaySdk 105: JFrogContainerSdk 106: JFrogBinarySdk 107: AzureAcrSdk 108: GitLabSourceSdk 109: GitLabContainerSdk 110: SvnSdk Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem 100: GitHub 101: DockerHub 102: Bitbucket 103: AmazonEcr 104: Quay 105: JFrogContainer 106: JFrogBinary 107: AzureAcr 108: GitLabSource 109: GitLabContainer 110: Svn Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`,`100`,`101`,`102`,`103`,`104`,`105`,`106`,`107`,`108`,`109`,`110`
storageStatus	object
message	string
statusType	integer	0: NotTested 1: Testing 2: Operational 3: Error Enum: `0`,`1`,`2`,`3`
workflowId	string
lastUpdated	date-time
tenantId	string

Response

Fetch storage users

Auth

Path Params

storageId string

Query String

filter string

GET /api/storage/{storageId}/users

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
fullName	string

Response

Add a storage

Auth

Request Body

object	object
Name	string
StorageVendorType	string
StorageProtocolType	string
CredentialsFile	file
Credentials	string
Source	string
GroupId	string
AccountId	string
WorkflowId	string
TransferMetadataAndChecksum	boolean

POST /api/storage

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
storageId	string

Response

Add batch of storages

Auth

Request Body

object	object
addStorageParametersList	array[object]
name	string	maxLength: 60 minLength: 3 pattern: `^[^@#$%&*"';:.\|,{}?+=><`~^[]!\]+$`
storageVendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageProtocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
credentialsFile	file
credentials	string
source	string	minLength: 1
groupId	string
accountId	string
workflowId	string
transferMetadataAndChecksum	boolean

POST /api/storage/batch

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
storageId	string

Response

Get batch of add storages results

Auth

Query String

token string

GET /api/storage/results

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
addStorageResultInfos	array
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
storageStatus	object
message	string
statusType	int32
source	string
name	string
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
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 /api/storage/enumerate/{startIndex}/{count}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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	0: Local 1: Cloud 2: Object Enum: `0`,`1`,`2`
protocolType	integer	0: Smb 1: GraphSdk 2: BoxSdk 3: AwsSdk 4: AzureBlobSdk 5: AlibabaCloudSdk 6: GoogleCloudSdk 7: AzureFilesSdk 8: Sftp 9: Nfs 10: Mft 11: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`
vendorType	integer	0: AmazonS3 1: OneDrive 2: Box 3: DellIsilon 4: AzureFiles 5: SmbCompatible 6: S3Compatible 7: AzureBlob 8: AlibabaCloud 9: GoogleCloud 10: Sftp 11: SharePoint 12: Nfs 13: Wasabi 14: OracleCloud 15: NetAppOntap 16: Cubbit 17: Mft 18: SharepointOnPrem Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`13`,`14`,`15`,`16`,`17`,`18`
storageStatus	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	object
type	string
hourlyRecurrence
object	object
everyNumberOfHours	int32	maximum: 24 minimum: 1
dailyRecurrence
object	object
everyNumberOfDays	int32	maximum: 365 minimum: 1
weeklyRecurrence
object	object
daysOfWeek	array[integer]	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
everyNumberOfWeeks	int32
monthlyRecurrence
object	object
everyNumberOfMonths	int32	maximum: 12 minimum: 1
dayOfMonth	int32	maximum: 30 minimum: 1
startDate	date-time
timeToStart	date-time
priority	int32
$type	string

PUT /api/storage/{storageId}/scan_schedule

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	object
type	string
hourlyRecurrence
object	object
everyNumberOfHours	int32	maximum: 24 minimum: 1
dailyRecurrence
object	object
everyNumberOfDays	int32	maximum: 365 minimum: 1
weeklyRecurrence
object	object
daysOfWeek	array[integer]	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
everyNumberOfWeeks	int32
monthlyRecurrence
object	object
everyNumberOfMonths	int32	maximum: 12 minimum: 1
dayOfMonth	int32	maximum: 30 minimum: 1
startDate	date-time
timeToStart	date-time
priority	int32
$type	string
id	string

PUT /api/storage/scan_schedule/update/{storageId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Fetch scan schedules

Auth

Path Params

storageId	string
sortDirection	integer	Enum: `0`,`1`
startIndex	integer	maximum: 2147483647 minimum: 0
count	integer	maximum: 2147483647 minimum: 1

Query String

name	string	pattern: `^[^@#$%&*"';:.\|,{}?+=><`~^[]!\]+$`
user	string	pattern: `^[\p{L}\p{M} ',.-]+$`
type	string

GET /api/storage/scan_schedules/{storageId}/{sortDirection}/{startIndex}/{count}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
name	string
workflowId	string	minLength: 1
scanConfigurationId	string
type	string
createdAt	date-time
lastScanTime	date-time
nextScanTime	date-time
recurrencePatternDto
object	object
type	integer	0: Hourly 1: Daily 2: Weekly 3: Monthly Enum: `0`,`1`,`2`,`3`
hourlyRecurrence
object	object
everyNumberOfHours	int32
dailyRecurrence
object	object
everyNumberOfDays	int32
weeklyRecurrence
object	object
daysOfWeek	array[integer]	Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
everyNumberOfWeeks	int32
monthlyRecurrence
object	object
everyNumberOfMonths	int32
dayOfMonth	int32
startDate	date-time
timeToStart	date-time
createdBy	string
priority	integer	0: Low 1: Medium 2: High Enum: `0`,`1`,`2`
totalCount	int64

Response

Delete scan schedules

Auth

Request Body

array array[string]

DELETE /api/storage/scan_schedule

Responses

200

object	object
result	integer	0: Success 1: FailedInvalidListOfIds Enum: `0`,`1`,`2`,`3`,`0`,`1`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
areAllDeleted	boolean

Response

Retrieve storage user name

Auth

Path Params

storageId string

Query String

userId string

GET /api/storage/{storageId}/user

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
userName	string

Response

Retrieve storage user name

Auth

Path Params

storageId	string
userId	string

GET /api/storage/{storageId}/{userId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
userName	string

Response

User

Create, list and update user accounts

/api/user/active/{startIndex}/{count}

/api/user/authenticate

/api/user/refreshToken

/api/user/password/reset

/api/user/password

Fetch active users

Auth

Path Params

startIndex	string
count	string

Query String

searchTerm	string	pattern: `^[\p{L}\p{M} ',.-]+$`
orderType
orderBy
searchText	string	pattern: `^[\p{L}\p{M} ',.-]+$`

GET /api/user/active/{startIndex}/{count}

Responses

200

object	object
entries	array[object]
id	string
userName	string
fullName	string
email	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`
totalCount	int64

Response

Register a user

Auth

Request Body

object	object
fullName	string	minLength: 1
userName	string	minLength: 1
password	string
email	string	minLength: 1
ssoUserId	string

POST /api/user/register

Responses

200

file file

Response

Create a user

Auth

Request Body

object	object
fullName	string	minLength: 1
userName	string	minLength: 1
password	string
email	string	minLength: 1
ssoUserId	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`

POST /api/user/create

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	minLength: 1
password	string	minLength: 1

POST /api/user/authenticate

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
fullName	string
email	string
userName	string
role
integer	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`
user
object	object
id	string
userName	string
fullName	string
email	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`
userId	string
accessToken	string
accessTokenExpiryTime	date-time
refreshToken	string
refreshTokenExpiryTime	date-time

Response

Refresh user token

Auth

Request Body

object	object
accessToken	string	minLength: 1
refreshToken	string	minLength: 1

POST /api/user/refreshToken

Responses

200

file file

Response

Logout

Auth

POST /api/user/logout

Responses

200

file file

Response

Update user role

Auth

Request Body

object object

userId

string

minLength: 1

role

integer

0: None
1: ReadOnlyAdministrator
2: Administrator
4: SsoAdministrator
5: SsoReadOnlyAdministrator
6: TenantAdministrator
999: Invalid

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

PUT /api/user/role

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
user
object	object
id	string
userName	string
fullName	string
email	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`

Response

Fetch users

Auth

Query String

startIndex	integer	maximum: 2147483647 minimum: 0
count	integer	maximum: 2147483647 minimum: 1
orderType
orderBy
searchText	string	pattern: `^[\p{L}\p{M} ',.-]+$`

GET /api/user/requests

Responses

200

object	object
entries	array[object]
id	string
userName	string
fullName	string
email	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`
totalCount	int64

Response

Delete a user

Auth

Path Params

userId string

DELETE /api/user/{userId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
user
object	object
id	string
userName	string
fullName	string
email	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`

Response

Update current user

Auth

Request Body

object	object
userId	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`
userName	string
fullName	string
currentPassword	string
newPassword	string
email	string
accountSecurity
object	object
incrementalDelay	string
failedLoginDate	date-time

PUT /api/user

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
user
object	object
id	string
userName	string
fullName	string
email	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`

Response

Request password reset

Auth

Request Body

object	object
userInput	string	minLength: 1

POST /api/user/password/reset

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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 /api/user/password

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
user
object	object
id	string
userName	string
fullName	string
email	string
role	integer	0: None 1: ReadOnlyAdministrator 2: Administrator 4: SsoAdministrator 5: SsoReadOnlyAdministrator 6: TenantAdministrator 999: Invalid Enum: `0`,`1`,`2`,`4`,`5`,`6`,`999`

Response

User Tour

Finalize and list user tours

/api/usertour/{userId}

/api/usertour/finalizeUserTour

Fetch tours completed by a user

Auth

Path Params

userId string

GET /api/usertour/{userId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
userId	string
userTours	array[object]
tourType	integer	0: OnboardingUi 1: WorkflowUi Enum: `0`,`1`
finalizedDate	date-time

Response

Mark a specific Tour as completed by a user

Auth

Request Body

object object

userId

string

minLength: 1

userTourType

integer

0: OnboardingUi
1: WorkflowUi

Enum: 0,1

POST /api/usertour/finalizeUserTour

Responses

200

file file

Response

Webhook

/api/webhook/realtime

/api/webhook/realtime/{storageClientId}

/api/webhook/realtime/public/{storageClientId}

/api/webhook/realtime/graph/{storageClientId}/{scanId}

File event trigger of real time processing

This endpoint takes the parameters and tries to find the file in the specified storage and applies the workflow for the specified file

Auth

Request Body

object	object
metadata	string	minLength: 1
storageClientId	string	minLength: 1

POST /api/webhook/realtime

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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 /api/webhook/realtime/{storageClientId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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 /api/webhook/realtime/public/{storageClientId}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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 /api/webhook/realtime/graph/{storageClientId}/{scanId}

Responses

200

file file

Response

Workflow

List, add, update and delete Workflows

/api/workflow/setDefault/{id}

/api/workflow/enabledTechnologies

Get Workflows

Auth

GET /api/workflow

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entries	array[object]
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`

Response

Add a new Workflow

Auth

Request Body

object	object
scanPoolId	string	minLength: 1
rules	array[string]
name	string	maxLength: 30 minLength: 3
userAgent	string
failOverScanPoolId	string
filters	object
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time

POST /api/workflow

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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
rules	array[string]
name	string	maxLength: 30 minLength: 3
userAgent	string
failOverScanPoolId	string
failOverDisabled	boolean
filters
object	object
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition
object	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean

PATCH /api/workflow

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Get Workflow by ID

Auth

Path Params

id string

GET /api/workflow/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
entry
object	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`

Response

Delete a Workflow

Auth

Path Params

id string

DELETE /api/workflow/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Response

Set a Workflow as default

Auth

Path Params

id string

POST /api/workflow/setDefault/{id}

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
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 /api/workflow/enabledTechnologies

Responses

200

object	object
result	integer	0: Success 1: Error 2: InternalError 3: NotFound Enum: `0`,`1`,`2`,`3`
responseKey	string
responseMessage	string
responseMessageParams	object
*	string
workflowDto
object	object
id	string
scanPoolId	string
rules	array[string]
type	integer	0: Default 1: Basic Enum: `0`,`1`
workflowSupportedTechnologies
object	object
dlp	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
deepCdr	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
sandBox	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
metascan	object
status	integer	0: Unknown 1: Disabled 2: Enabled Enum: `0`,`1`,`2`
name	string
userAgent	string
scanPool	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
failOverScanPoolId	string
failOverScanPool
object	object
id	string
name	string
scanPoolType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
isDefault	boolean
scanInstances	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string
scanInstanceType	integer	0: MdCore 1: MdCloud Enum: `0`,`1`
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
fileDefinition	object
blockingStrategy	integer	0: Strict 1: Configurable Enum: `0`,`1`
configurableBlockingStrategy	object
shouldTreatFilesWithSensitiveDataAsBlocked	boolean
shouldTreatFilesWithVulnerabilitiesAsBlocked	boolean
remediations	array[object]
id	string
workflowId	string
isEnabled	boolean
configuration	string
type	integer	0: FileTagging 1: DeepCdr 2: BlockedFileRemediation 3: AllowedSanitizedFileRemediation 4: AllowedFileRemediation 5: BlockedSanitizedFileRemediation 6: DeleteEmptyFoldersRemediation Enum: `0`,`1`,`2`,`3`,`4`,`5`,`6`
handlingType	integer	0: Delete 1: Move 2: Copy 3: Keep 999: NotApplicable Enum: `0`,`1`,`2`,`3`,`999`

Response

Tenant

/api/tenant/{tenantId}

/api/tenant/{tenantId}