MetaDefender Software Supply Chain API 4.0.1 4.0.1

/api/v1/monitored-files

/api/v1/monitored-files

/api/v1/monitored-files/{id}/history

/api/v1/monitored-files/{id}/scan-now

/api/v1/monitored-files/{id}/enabled

/api/v1/monitored-files/{id}/interval

/api/v1/monitored-files/{id}

monitored-files

Auth

Request Body

object	object
file	file
workflowId	string	Default: null
intervalMinutes	int32	Default: null
groupId	string	Default: null
groupName	string	Default: null

POST /api/v1/monitored-files

 
curl --request POST \ --url 'http://localhost:8001/api/v1/monitored-files' \ --form 'file=@{file}'
Copy

Responses

200

object	object
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes	int32
newCveCount	int32
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

 "rescanIntervalMinutes": "{int32}",
 
Copy

monitored-files

Auth

GET /api/v1/monitored-files

 
curl --get \ --url 'http://localhost:8001/api/v1/monitored-files'
Copy

Responses

200

array	array[object]
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes	int32
newCveCount	int32
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

  "rescanIntervalMinutes": "{int32}",
 
Copy

history

Auth

Path Params

id string

GET /api/v1/monitored-files/{id}/history

 
curl --get \ --url 'http://localhost:8001/api/v1/monitored-files/{id}/history'
Copy

Responses

200

array	array[object]
id	string
scanId	string
runAt	date-time
newCveIds	string

Response

  "runAt": "{date-time}",
 
Copy

scan-now

Auth

Path Params

id string

POST /api/v1/monitored-files/{id}/scan-now

 
curl --request POST \ --url 'http://localhost:8001/api/v1/monitored-files/{id}/scan-now'
Copy

Responses

200

object	object
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes	int32
newCveCount	int32
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

 "rescanIntervalMinutes": "{int32}",
 
Copy

enabled

Auth

Path Params

id string

Request Body

object	object
enabled	boolean

POST /api/v1/monitored-files/{id}/enabled

 
curl --request POST \ --url 'http://localhost:8001/api/v1/monitored-files/{id}/enabled' \ --data '{  "enabled": "{boolean}"}'
Copy

Responses

200

object	object
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes	int32
newCveCount	int32
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

interval

Auth

Path Params

id string

Request Body

object	object
intervalMinutes	int32

POST /api/v1/monitored-files/{id}/interval

Copy

Responses

200

object	object
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes	int32
newCveCount	int32
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

Copy

{id}

Auth

Path Params

id string

DELETE /api/v1/monitored-files/{id}

Copy

Responses

204

No Content

No response body

Response

Copy

Manage Abac Attribute-based Access Control

/api/v1/abac/roles/{roleId}

/api/v1/abac/roles/{roleId}

/api/v1/abac/roles/{roleId}

/api/v1/abac/permissions

/api/v1/abac/permissions

/api/v1/abac/permissions/{permissionId}

/api/v1/abac/roles/{roleId}/permissions

/api/v1/abac/roles/{roleId}/permissions/{permissionId}

/api/v1/abac/users/{userId}/roles

/api/v1/abac/users/{userId}/roles

/api/v1/abac/users/{userId}/roles/{roleBindingId}

/api/v1/abac/users/{userId}/permissions

/api/v1/abac/users/{userId}/permissions/{userPermissionId}

Get Roles

Auth

Query String

includePermissions

boolean

Default: true

GET /api/v1/abac/roles

Copy

Responses

200

object	object
roles3 fields	array[object]
id	uuid
name	string
permissions3 fields	array[object]
id	uuid
action	string
resource	string
responseKey	string
responseMessage	string

Response

Copy

Create Role

Auth

Request Body

object	object
name	string	maxLength: 100 minLength: 3
permissionIds	array[string]
templateRoleId	uuid

POST /api/v1/abac/roles

Copy

Responses

200

object	object
role3 fields	object
id	uuid
name	string
permissions3 fields	array[object]
id	uuid
action	string
resource	string
responseKey	string
responseMessage	string

Response

Copy

Get Role by ID

Auth

Path Params

roleId string

GET /api/v1/abac/roles/{roleId}

Copy

Responses

200

object	object
role3 fields	object
id	uuid
name	string
permissions3 fields	array[object]
id	uuid
action	string
resource	string
responseKey	string
responseMessage	string

Response

Copy

Update Role

Auth

Path Params

roleId string

Request Body

object object

name

string

maxLength: 100

minLength: 3

permissionIds array[string]

PUT /api/v1/abac/roles/{roleId}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Delete Role

Auth

Path Params

roleId string

DELETE /api/v1/abac/roles/{roleId}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Get Permissions

Auth

GET /api/v1/abac/permissions

Copy

Responses

200

object	object
permissions3 fields	array[object]
id	uuid
action	string
resource	string
responseKey	string
responseMessage	string

Response

Copy

Create Permission

Auth

Request Body

object	object
action	string
resource	string

POST /api/v1/abac/permissions

Copy

Responses

200

object	object
permission3 fields	object
id	uuid
action	string
resource	string
responseKey	string
responseMessage	string

Response

Copy

Delete Permission

Auth

Path Params

permissionId string

DELETE /api/v1/abac/permissions/{permissionId}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Assign Permission to Role

Auth

Path Params

roleId string

Request Body

object	object
permissionId	uuid

POST /api/v1/abac/roles/{roleId}/permissions

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Remove Permission from Role

Auth

Path Params

roleId	string
permissionId	string

DELETE /api/v1/abac/roles/{roleId}/permissions/{permissionId}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Assign Role to User

Auth

Path Params

userId string

Request Body

object	object
roleId	uuid
expiresAt	date-time

POST /api/v1/abac/users/{userId}/roles

Copy

Responses

200

object	object
roleBindingId	uuid
responseKey	string
responseMessage	string

Response

Copy

Replace User Roles

Auth

Path Params

userId string

Request Body

object	object
roleIds	array[string]

PUT /api/v1/abac/users/{userId}/roles

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Remove Role from User

Auth

Path Params

userId	string
roleBindingId	string

DELETE /api/v1/abac/users/{userId}/roles/{roleBindingId}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Assign Permission to User

Auth

Path Params

userId string

Request Body

object	object
permissionId	uuid
expiresAt	date-time

POST /api/v1/abac/users/{userId}/permissions

Copy

Responses

200

object	object
userPermissionId	uuid
responseKey	string
responseMessage	string

Response

Copy

Remove Permission from User

Auth

Path Params

userId	string
userPermissionId	string

DELETE /api/v1/abac/users/{userId}/permissions/{userPermissionId}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Manage Audit

/api/v1/audit

List audit events

Auth

Query String

Start	string	pattern: `^[0-9]*$`
Count	string	pattern: `^[0-9]*$`
LogType	array
CategoryType	string	pattern: `^[0-9]*$`
LogLevel	string	pattern: `^[0-9]*$`
Search	string	pattern: `^[0-9]*$`

GET /api/v1/audit

Copy

Responses

200

object	object
entries4 fields	array[object]
id	string
level	integer
properties5 fields	object
logType	integer
category	integer
eventTimestamp	date-time
userId	string
userName	string
renderedMessage	string
totalCount	int64
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

Response

Copy

Manage Configuration

/api/v1

Get application configuration

Auth

GET /api/v1

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Manage Cross Domain Transfers

/api/v1/cross-domain/file-stream

/api/v1/cross-domain/global-config/lowside

/api/v1/cross-domain/global-config/lowside

/api/v1/cross-domain/global-config/lowside/disable

/api/v1/cross-domain/global-config/highside

/api/v1/cross-domain/global-config/highside

/api/v1/cross-domain/global-config/highside/disable

/api/v1/cross-domain/logs

/api/v1/cross-domain/logs/{transmissionId}

/api/v1/cross-domain/lowside-configuration-notifications

/api/v1/cross-domain/notifications

/api/v1/cross-domain/storage-config/lowside

/api/v1/cross-domain/storage-config/lowside

/api/v1/cross-domain/storage-config/lowside/{id}

/api/v1/cross-domain/storage-config/lowside/{id}

/api/v1/cross-domain/storage-config/highside

/api/v1/cross-domain/storage-config/highside

/api/v1/cross-domain/storage-config/highside/{id}

/api/v1/cross-domain/storage-config/highside/{id}

Receive a full file as a single framed binary stream with manifest in headers

Auth

Headers

receiveFileStreamDto9 fields	object
transmissionId	string
fileName	string
fileSizeBytes	int64
totalChunks	int64
chunkSizeBytes	int32
storageName	string
repositoryName	string
reference	string
organization	string

POST /api/v1/cross-domain/file-stream

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

500

Internal Server Error

Response

Copy

Get global lowside configuration

Auth

GET /api/v1/cross-domain/global-config/lowside

Copy

Responses

200

object	object
configuration	object
highsideAddress	string
enabled	boolean
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Set global lowside configuration

Auth

Request Body

object	object
highsideAddress	string
authorizationToken	string
enabled	boolean

PUT /api/v1/cross-domain/global-config/lowside

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Copy

Disable global lowside configuration

Auth

POST /api/v1/cross-domain/global-config/lowside/disable

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Get global highside configuration

Auth

GET /api/v1/cross-domain/global-config/highside

Copy

Responses

200

object	object
configuration8 fields	object
pushBehaviour	integer
enabled	boolean
scanBeforeImport	boolean
scanWorkflowId	string
maxAllowedSeverity	integer
blockOnSecrets	boolean
scanTimeoutSeconds	int32
pollIntervalSeconds	int32
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Set global highside configuration

Auth

Request Body

object	object
pushBehaviour	integer
enabled	boolean
scanBeforeImport	boolean
scanWorkflowId	string
maxAllowedSeverity	integer
blockOnSecrets	boolean
scanTimeoutSeconds	int32
pollIntervalSeconds	int32

PUT /api/v1/cross-domain/global-config/highside

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Copy

Disable global highside configuration

Auth

POST /api/v1/cross-domain/global-config/highside/disable

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Get cross-domain operation logs

Auth

Query String

page	integer	Default: null
pageSize	integer	Default: null
sortBy	string	pattern: `^[0-9]*$` Default: null
sortOrder	string	pattern: `^[0-9]*$` Default: null
filter	string	pattern: `^[0-9]*$` Default: null
search	string	pattern: `^[0-9]*$` Default: null

GET /api/v1/cross-domain/logs

Copy

Responses

200

object	object
logs12 fields	array[object]
id	string
transmissionId	string
storageId	string
step	integer
status	integer
timestamp	date-time
storageName	string
storage9 fields	object
id	string
credentialsType	int32
scanWorkflowId	string
domain	string
realTimeStatus	integer
name	string
vendorType	integer
protocolType	integer
lowsideRepositoryName	string
highsideRepositoryName	string
reference	string
errorMessage	string
hasNextPage	boolean
hasPreviousPage	boolean
responseKey	string
responseMessage	string

Response

Copy

Delete a cross-domain activity-log entry by transmission id

Auth

Path Params

transmissionId string

DELETE /api/v1/cross-domain/logs/{transmissionId}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Receive a lowside configuration change notification

Auth

Request Body

object	object
storageName	string
protocolType	integer
changeType	integer

POST /api/v1/cross-domain/lowside-configuration-notifications

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Copy

Get all cross-domain notifications

Auth

GET /api/v1/cross-domain/notifications

Copy

Responses

200

object	object
notifications6 fields	array[object]
id	string
storageName	string
protocolType	integer
changeType	integer
receivedAt	date-time
acknowledged	boolean
responseKey	string
responseMessage	string

Response

Copy

Get a lowside configuration by storage ID

Auth

GET /api/v1/cross-domain/storage-config/lowside

Copy

Responses

200

object	object
configurations5 fields	array[object]
id	string
storageId	string
storageName	string
protocolType	integer
valid	boolean
responseKey	string
responseMessage	string

Response

Copy

Add a lowside configuration

Auth

Request Body

object	object
storageId	string

POST /api/v1/cross-domain/storage-config/lowside

Copy

Responses

200

object	object
configurationId	string
responseKey	string
responseMessage	string

400

Bad Request

Response

Copy

Update a lowside configuration by ID

Auth

Path Params

id string

Request Body

object	object
storageId	string

PUT /api/v1/cross-domain/storage-config/lowside/{id}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Delete a lowside configuration by ID

Auth

Path Params

id string

DELETE /api/v1/cross-domain/storage-config/lowside/{id}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Get a highside storage configuration by storage ID

Auth

GET /api/v1/cross-domain/storage-config/highside

Copy

Responses

200

object	object
configurations6 fields	array[object]
id	string
storageId	string
storageName	string
lowsideStorageName	string
lowsideProtocolType	integer
valid	boolean
responseKey	string
responseMessage	string

Response

Copy

Add a highside configuration

Auth

Request Body

object	object
storageId	string
notificationId	string

POST /api/v1/cross-domain/storage-config/highside

Copy

Responses

200

object	object
configurationId	string
responseKey	string
responseMessage	string

400

Bad Request

Response

Copy

Update a highside configuration by ID

Auth

Path Params

id string

Request Body

object	object
storageId	string
storageName	string
lowsideStorageName	string

PUT /api/v1/cross-domain/storage-config/highside/{id}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Delete a highside configuration by ID

Auth

Path Params

id string

DELETE /api/v1/cross-domain/storage-config/highside/{id}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Copy

Manage Dashboard

/api/v1/dashboard

/api/v1/dashboard/top-risky

Get the dashboard summary and trends time-series

Auth

Query String

connection_id	string
window	string
timezone	string

GET /api/v1/dashboard

Copy

Responses

200

object	object
summary19 fields	object
totalConnections	int32
totalScannedRepositories	int32
totalScannedRepositoriesTrend	int32
totalPackages	int32
totalPackagesTrend	int32
riskScore	int32
riskScoreTrend	int32
criticalVulnerabilities	int32
criticalPackages	int32
criticalRepositories	int32
totalVulnerabilities	int32
totalVulnerabilitiesTrend	int32
totalThreats	int32
totalThreatsTrend	int32
totalSecrets	int32
totalSecretsTrend	int32
severity5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
topRiskyPackages	array[object]
name	string
criticalCount	int32
topRiskyRepositories	array[object]
name	string
detectionCount	int32
trends9 fields	array[object]
periodStart	date-time
periodEnd	date-time
totalVulnerabilities	int32
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
scansConsidered	int32

400

Bad Request

500

Internal Server Error

Response

Copy

Get top-risky repositories across all connections

Auth

Query String

window	string
count	integer	Default: null

GET /api/v1/dashboard/top-risky

Copy

Responses

200

array	array[object]
connectionId	string
connectionName	string
repositoryId	string
repositoryName	string
riskScore	int32

400

Bad Request

500

Internal Server Error

Response

Copy

Manage Export

/api/v1/export/cyclonedx/{repoId}

/api/v1/export/cyclonedx/file/{fileId}

/api/v1/export/spdx/{scanId}

/api/v1/export/spdx/file/{fileId}

/api/v1/export/pdf/all-scans

/api/v1/export/pdf/overview/{scanId}

/api/v1/export/pdf/sbom/{scanId}

/api/v1/export/pdf/sbom/file/{fileId}

/api/v1/export/csv/sbom/{scanId}

/api/v1/export/csv/sbom/file/{fileId}

/api/v1/export/csv/cves

/api/v1/export/csv/packages

Export a CycloneDX report for repository

Auth

Path Params

repoId string

Query String

Reference

string

pattern: ^[0-9]*$

Default: null

GET /api/v1/export/cyclonedx/{repoId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export a CycloneDX report for a specific file scan

Auth

Path Params

fileId string

GET /api/v1/export/cyclonedx/file/{fileId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export an SPDX report for a specific scan

Auth

Path Params

scanId string

Query String

format	string
version	string

GET /api/v1/export/spdx/{scanId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export an SPDX report for a specific file scan

Auth

Path Params

fileId string

Query String

format	string
version	string

GET /api/v1/export/spdx/file/{fileId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export a PDF report for all scans

Auth

Query String

ProductAddress	string	pattern: `^[0-9]*$` Default: null
Type	array
TimeFrame	string	pattern: `^[0-9]*$` Default: null
Vulnerabilities	array
LicenseRisks	array
Status	array
TriggerEvent	array
Workflow	string	pattern: `^[0-9]*$` Default: null
Connection	string	pattern: `^[0-9]*$` Default: null
Secrets	boolean
Threats	boolean
Search	string	pattern: `^[0-9]*$` Default: null
ConnectionType	string	pattern: `^[0-9]*$` Default: null
RepositoryId	string	pattern: `^[0-9]*$` Default: null
Latest	boolean

GET /api/v1/export/pdf/all-scans

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export a PDF overview report for repository

Auth

Path Params

scanId string

Query String

ProductAddress

string

pattern: ^[0-9]*$

Default: null

GET /api/v1/export/pdf/overview/{scanId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export a PDF SBOM report for repository

Auth

Path Params

scanId string

Query String

ProductAddress

string

pattern: ^[0-9]*$

Default: null

GET /api/v1/export/pdf/sbom/{scanId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export a PDF SBOM report for a specific batch of files

Auth

Path Params

fileId string

Query String

ProductAddress

string

pattern: ^[0-9]*$

Default: null

GET /api/v1/export/pdf/sbom/file/{fileId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export a CSV report for repository

Auth

Path Params

scanId string

GET /api/v1/export/csv/sbom/{scanId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export a CSV report for a specific batch of files

Auth

Path Params

fileId string

GET /api/v1/export/csv/sbom/file/{fileId}

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Copy

Export a CSV report of all CVEs from latest scans

Auth

Query String

Severity array

GET /api/v1/export/csv/cves

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

Response

Copy

Export a CSV report of all packages from latest scans

Auth

GET /api/v1/export/csv/packages

Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag2 fields	object
tag5 fields	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

Response

Copy

Manage External Loggers

/api/v1/externallogger

/api/v1/externallogger

/api/v1/externallogger/{id}

/api/v1/externallogger/{id}

Get all external loggers

Auth

GET /api/v1/externallogger

Copy

Responses

200

No response body

Response

Copy

Add an external logger

Auth

Request Body

object	object
connectionSettings4 fields	object
serverAddress	string
port	int32
facility	integer
format	integer

POST /api/v1/externallogger

Copy

Responses

200

No response body

Response

Copy

Update an external logger

Auth

Path Params

id string

Request Body

object	object
connectionSettings4 fields	object
serverAddress	string
port	int32
facility	integer
format	integer

PUT /api/v1/externallogger/{id}

Copy

Responses

200

No response body

Response

Copy

Delete an external logger

Auth

Path Params

id string

DELETE /api/v1/externallogger/{id}

Copy

Responses

200

No response body

Response

Copy

Manage Global Label Keys

/api/v1/global-label-keys

/api/v1/global-label-keys

/api/v1/global-label-keys/{id}

/api/v1/global-label-keys/{id}

Returns all global label keys

Auth

GET /api/v1/global-label-keys

Copy

Responses

200

object	object
globalKeys10 fields	array[object]
id	string
name	string
description	string
valueType	string
options	array[string]
created	date-time
updated	date-time
tenantId	string
createdAt	date-time
lastUpdated	date-time
responseKey	string
responseMessage	string

Response

Copy

Adds a new global label key

Auth

Request Body

object	object
name	string
description	string
valueType	string
options	array[string]

POST /api/v1/global-label-keys

Copy

Responses

200

object	object
globalKey10 fields	object
id	string
name	string
description	string
valueType	string
options	array[string]
created	date-time
updated	date-time
tenantId	string
createdAt	date-time
lastUpdated	date-time
responseKey	string
responseMessage	string

Response

Copy

Updates an global label key

Auth

Path Params

id string

Request Body

object	object
name	string
description	string
valueType	string
options	array[string]

PUT /api/v1/global-label-keys/{id}

Copy

Responses

200

object	object
globalKey10 fields	object
id	string
name	string
description	string
valueType	string
options	array[string]
created	date-time
updated	date-time
tenantId	string
createdAt	date-time
lastUpdated	date-time
responseKey	string
responseMessage	string

Response

Copy

Deletes an global label key

Auth

Path Params

id string

DELETE /api/v1/global-label-keys/{id}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Manage Jobs V2

/api/v1/jobs/scheduled

/api/v1/jobs/scheduled

/api/v1/jobs/{id}/cancel

/api/v1/jobs/{id}

Start a Scan Now job over one or more targets (each target carries its own StorageId, so a single job may mix protocols)

Auth

Request Body

object	object
name	string
priority	integer
workflowId	string
targets9 fields	array[object]
storageId	string
repositoryId	string
repositoryName	string
connection	string
organization	string
packageType	string
repositoryType	string
references	array[string]

POST /api/v1/jobs

Copy

Responses

200

object	object
jobIds	array[string]
priority	integer
enabledRepositories	array[string]
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

207

Multi-Status

400

Bad Request

Response

Copy

List jobs (paginated, queryable by trigger type)

Auth

Query String

TriggerType	array	Enum: `ScanNow`,`Scheduled`,`RealTime`,`DirectFile`
Priority	array
Status	array
WorkflowId	array
Search	string	pattern: `^[0-9]*$` Default: null
TimeFrame	string	pattern: `^[0-9]*$` Default: null
Type	array
ConnectionType	string	pattern: `^[0-9]*$` Default: null
Repository	string	pattern: `^[0-9]*$` Default: null
Service	string	pattern: `^[0-9]*$` Default: null
Vulnerabilities	array
LicenseRisks	array
Threats	boolean
Secrets	boolean
SortBy	string	pattern: `^[0-9]*$` Default: null
SortDir	string	pattern: `^[0-9]*$` Default: null
Page	integer
PageSize	integer

GET /api/v1/jobs

Copy

Responses

200

object	object
page	int32
pageSize	int32
totalCount	int32
hasMoreItems	boolean
jobs9 fields	array[object]
jobId	string
name	string
priority	integer
storage7 fields	object
storageId	string
storageName	string
vendorType	string
protocolType	string
connection	string
packageType	string
organization	string
repository6 fields	object
repositoryId	string
repositoryName	string
repositoryType	string
repositoryUrl	string
repositoryReference	string
repositoryMetadata	string
scanInformation11 fields	object
filesProcessed	int64
malware	object
infectedFiles	int32
secrets	object
filesWithSecrets	int32
vulnerabilities6 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
total	int32
licenses3 fields	object
blockedLicensesCount	int32
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations	array[object]
isEnabled	boolean
type	string
package	object
totalPackages	int32
vulnerablePackages	int32
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus4 fields	object
scanningState	integer
discoveryState	integer
scanProgress	int32
uploadProgress	int32

Response

Copy

Bulk delete jobs (trigger-agnostic)

Auth

Request Body

object	object
jobIds	array[string]

DELETE /api/v1/jobs

Copy

Responses

200

object	object
deletedJobIds	array[string]
failedJobIds	array[string]
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

Response

Copy

Start a Real-Time Protection job over one or more targets (each target carries its own StorageId)

Auth

Request Body

object	object
name	string
priority	integer
workflowId	string
targets9 fields	array[object]
storageId	string
repositoryId	string
repositoryName	string
connection	string
organization	string
packageType	string
repositoryType	string
references	array[string]

POST /api/v1/jobs/rtp

Copy

Responses

200

object	object
jobIds	array[string]
priority	integer
enabledRepositories	array[string]
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

207

Multi-Status

400

Bad Request

Response

Copy

Create a scheduled job with a recurrence pattern

Auth

Request Body

object	object
name	string
priority	integer
workflowId	string
recurrencePattern5 fields	object
type	integer
hourlyRecurrence	object
everyNumberOfHours	int32
dailyRecurrence	object
everyNumberOfDays	int32
weeklyRecurrence	object
daysOfWeek	array[integer]
everyNumberOfWeeks	int32
monthlyRecurrence	object
everyNumberOfMonths	int32
dayOfMonth	int32
targets9 fields	array[object]
storageId	string
repositoryId	string
repositoryName	string
connection	string
organization	string
packageType	string
repositoryType	string
references	array[string]

POST /api/v1/jobs/scheduled

Copy

Responses

200

object	object
jobIds	array[string]
priority	integer
nextRunTime	date-time
failedRepositories	array[string]
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

207

Multi-Status

400

Bad Request

Response

Copy

Delete all upcoming jobs

Auth

DELETE /api/v1/jobs/scheduled

Copy

Responses

200

object	object
deletedJobIds	array[string]
failedJobIds	array[string]
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

207

Multi-Status

400

Bad Request

Response

Copy

Cancel a job (for RealTime jobs this disables RTP)

Auth

Path Params

id string

POST /api/v1/jobs/{id}/cancel

Copy

Responses

200

object	object
jobId	string
status	string
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

404

Not Found

Response

Copy

Get a single job by id

Auth

Path Params

id string

GET /api/v1/jobs/{id}

Copy

Responses

200

object	object
jobId	string
name	string
priority	integer
storage7 fields	object
storageId	string
storageName	string
vendorType	string
protocolType	string
connection	string
packageType	string
organization	string
repository6 fields	object
repositoryId	string
repositoryName	string
repositoryType	string
repositoryUrl	string
repositoryReference	string
repositoryMetadata	string
scanInformation11 fields	object
filesProcessed	int64
malware	object
infectedFiles	int32
secrets	object
filesWithSecrets	int32
vulnerabilities6 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
total	int32
licenses3 fields	object
blockedLicensesCount	int32
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations	array[object]
isEnabled	boolean
type	string
package	object
totalPackages	int32
vulnerablePackages	int32
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus4 fields	object
scanningState	integer
discoveryState	integer
scanProgress	int32
uploadProgress	int32

404

Not Found

Response

Copy

Manage Licenses

/api/v1/licenses/online

/api/v1/licenses/current-deployment-id

/api/v1/licenses/offline

Activate a license online

Auth

Request Body

object	object
key	string

POST /api/v1/licenses/online

Copy

Responses

200

object	object
result	integer
responseMessage	string

400

Bad Request

Response

Copy

Activate a license offline

Auth

Request Body

object	object
LicenseContent	file

POST /api/v1/licenses/offline

Copy

Responses

200

object	object
result	integer
responseMessage	string

400

Bad Request

Response

Copy

Remove licenses

Auth

DELETE /api/v1/licenses

Copy

Responses

200

object	object
result	integer
responseMessage	string

400

Bad Request

404

Not Found

Response

Copy

Get licenses

Auth

GET /api/v1/licenses

Copy

Responses

200

object	object
result	integer
license8 fields	object
productId	string
productName	string
expiration	int64
deploymentId	string
currentDeploymentId	string
activationKey	string
licenseContent	string
maxDevelopers	int32
responseMessage	string

400

Bad Request

404

Not Found

Response

Copy

Get current deployment Id for offline license activation

Auth

GET /api/v1/licenses/current-deployment-id

Copy

Responses

200

object	object
result	integer
currentDeploymentId	string
responseMessage	string

400

Bad Request

Response

Copy

Manage Opswat Central Management Ocm

Update an OCM instance

Auth

Request Body

object	object
serverApi	string
regCode	string

PUT /api/v1/ocm

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Delete an OCM instance

Auth

DELETE /api/v1/ocm

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Get an OCM instance

Auth

GET /api/v1/ocm

Copy

Responses

200

object	object
ocmInformation29 fields	object
id	string
apiKey	string
serverApi	string
registrationCode	string
deploymentId	string
cmVersion	string
scanConfigurationHash	string
storageConfigurationHash	string
retentionConfigurationHash	string
externalLoggerConfigurationHash	string
userConfigurationHash	string
licenseConfigurationHash	string
smtpConfigurationHash	string
notificationConfigurationHash	string
agentToken	string
instanceId	string
tokenRefreshedAt	int64
confHash	string
vpackHash	string
heartbeatIntervalSeconds	int32
fetchConfigIntervalSeconds	int32
groupId	string
enrollStatus	integer
lastServerConnection	int64
lastConfigurationSync	int64
connectionStatus	integer
createdAt	date-time
lastUpdated	date-time
tenantId	string
responseKey	string
responseMessage	string

Response

Copy

Manage Onboarding

/api/v1/onboarding

/api/v1/onboarding/complete

/api/v1/onboarding/accept-eula

Get onboarding

Auth

GET /api/v1/onboarding

Copy

Responses

200

object	object
hasUserConfigured	boolean
hasLicenseConfigured	boolean
hasScanInstanceConfigured	boolean
hasConnectionConfigured	boolean
isCloudType	boolean
isEulaAgreed	boolean
isOnboardingDone	boolean
responseKey	string
responseMessage	string

Response

Copy

Complete onboarding

Auth

POST /api/v1/onboarding/complete

Copy

Responses

200

No response body

Response

Copy

Agree to onboarding EULA

Auth

POST /api/v1/onboarding/accept-eula

Copy

Responses

200

No response body

Response

Copy

Manage Packages

/api/v1/packages

/api/v1/packages/versions

/api/v1/packages/{id}

/api/v1/packages/by-uid/{uidInB64}

/api/v1/packages/{id}/cves

/api/v1/packages/{id}/update-instructions

/api/v1/packages/{id}/labels

/api/v1/packages/{id}/labels

/api/v1/packages/{id}/labels/{key}

/api/v1/packages/{id}/labels/{key}

/api/v1/packages/search/labels

Retrieves a paginated, sortable list of packages

Auth

Query String

Name	string	pattern: `^[0-9]*$` Default: null
Ecosystem	string	pattern: `^[0-9]*$` Default: null
Version	string	pattern: `^[0-9]*$` Default: null
Vulnerabilities	array
LicenseRisks	array
Connection	string	pattern: `^[0-9]*$` Default: null
Repository	string	pattern: `^[0-9]*$` Default: null
Reference	string	pattern: `^[0-9]*$` Default: null
ScanId	string	pattern: `^[0-9]*$` Default: null
StepSha256	string	pattern: `^[0-9]*$` Default: null
Search	string	pattern: `^[0-9]*$` Default: null
IncludeDirectFiles	boolean
sortBy	string	Default: null
sortDir	string	Default: null
page	integer	Default: null
pageSize	integer	Default: null

GET /api/v1/packages

Copy

Responses

200

object	object
page	int32
pageSize	int32
totalCount	int32
hasMoreItems	boolean
packages22 fields	array[object]
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
packageType	string
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
repositories7 fields	array[object]
connection	string
repository	string
repositoryId	string
reference	string
scanned	date-time
scanIds	array[string]
stepSha256s	array[string]
directFiles3 fields	array[object]
fileName	string
scanned	date-time
scanResultId	string
hashes	array[object]
sha256	string
fileName	string
vulnerabilities8 fields	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
dependencies6 fields	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings	array
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
supplierName	string
releaseDate	date-time
labels5 fields	array[object]
key	string
value	string
valueType	string
created	date-time
updated	date-time
latest	object
version	string
releaseDate	string
createdAt	date-time
lastUpdated	date-time
impact	integer
recommendedVersion	string

207

Multi-Status

401

Unauthorized

Response

Copy

Retrieves all versions of a specific package by its name and ecosystem

Auth

Query String

ecosystem	string
packageName	string

GET /api/v1/packages/versions

Copy

Responses

200

object	object
packageName	string
ecosystem	string
versions6 fields	array[object]
version	string
vulnerabilities8 fields	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
supplierName	string
releaseDate	date-time
dependencies6 fields	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings	array
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
responseKey	string
responseMessage	string

Response

Copy

Retrieves a package by its internal database ID

Auth

Path Params

id string

Query String

includeDirectFiles

boolean

Default: false

GET /api/v1/packages/{id}

Copy

Responses

200

object	object
package22 fields	object
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
packageType	string
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
repositories7 fields	array[object]
connection	string
repository	string
repositoryId	string
reference	string
scanned	date-time
scanIds	array[string]
stepSha256s	array[string]
directFiles3 fields	array[object]
fileName	string
scanned	date-time
scanResultId	string
hashes	array[object]
sha256	string
fileName	string
vulnerabilities8 fields	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
dependencies6 fields	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings	array
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
supplierName	string
releaseDate	date-time
labels5 fields	array[object]
key	string
value	string
valueType	string
created	date-time
updated	date-time
latest	object
version	string
releaseDate	string
createdAt	date-time
lastUpdated	date-time
impact	integer
recommendedVersion	string
responseKey	string
responseMessage	string

Response

Copy

Retrieves a package by its universal package UID

Auth

Path Params

uidInB64 string

GET /api/v1/packages/by-uid/{uidInB64}

Copy

Responses

200

object	object
package22 fields	object
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
packageType	string
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
repositories7 fields	array[object]
connection	string
repository	string
repositoryId	string
reference	string
scanned	date-time
scanIds	array[string]
stepSha256s	array[string]
directFiles3 fields	array[object]
fileName	string
scanned	date-time
scanResultId	string
hashes	array[object]
sha256	string
fileName	string
vulnerabilities8 fields	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
dependencies6 fields	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings	array
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
supplierName	string
releaseDate	date-time
labels5 fields	array[object]
key	string
value	string
valueType	string
created	date-time
updated	date-time
latest	object
version	string
releaseDate	string
createdAt	date-time
lastUpdated	date-time
impact	integer
recommendedVersion	string
responseKey	string
responseMessage	string

Response

Copy

Retrieves CVEs associated with a specific package

Auth

Path Params

id string

GET /api/v1/packages/{id}/cves

Copy

Responses

200

object	object
cves8 fields	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
responseKey	string
responseMessage	string

Response

Copy

Retrieves the ecosystem-specific upgrade command for a package

Auth

Path Params

id string

GET /api/v1/packages/{id}/update-instructions

Copy

Responses

200

object	object
packageId	string
ecosystem	string
command	string
message	string
responseKey	string
responseMessage	string

401

Unauthorized

404

Not Found

500

Internal Server Error

Response

Copy

Retrieves all labels for a specific package

Auth

Path Params

id string

GET /api/v1/packages/{id}/labels

Copy

Responses

200

object	object
labels5 fields	array[object]
Key	string
Value	string
ValueType	string
Created	date-time
Updated	date-time
responseKey	string
responseMessage	string

Response

Copy

Adds a label to a package

Auth

Path Params

id string

Request Body

object	object
Key	string
Value	string
ValueType	string
Created	date-time
Updated	date-time

POST /api/v1/packages/{id}/labels

Copy

Responses

200

object	object
label5 fields	object
Key	string
Value	string
ValueType	string
Created	date-time
Updated	date-time
responseKey	string
responseMessage	string

Response

Copy

Updates a label in a package

Auth

Path Params

id	string
key	string

Request Body

object	object
value	string
valueType	string

PUT /api/v1/packages/{id}/labels/{key}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Deletes a label from a package

Auth

Path Params

id	string
key	string

DELETE /api/v1/packages/{id}/labels/{key}

Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Copy

Searches for packages by label key and optionally value

Auth

Query String

key	string
value	string	Default: null

GET /api/v1/packages/search/labels

Copy

Responses

200

object	object
packages22 fields	array[object]
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
packageType	string
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
repositories7 fields	array[object]
connection	string
repository	string
repositoryId	string
reference	string
scanned	date-time
scanIds	array[string]
stepSha256s	array[string]
directFiles3 fields	array[object]
fileName	string
scanned	date-time
scanResultId	string
hashes	array[object]
sha256	string
fileName	string
vulnerabilities8 fields	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
dependencies6 fields	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings	array
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
supplierName	string
releaseDate	date-time
labels5 fields	array[object]
key	string
value	string
valueType	string
created	date-time
updated	date-time
latest	object
version	string
releaseDate	string
createdAt	date-time
lastUpdated	date-time
impact	integer
recommendedVersion	string
responseKey	string
responseMessage	string

Response

Copy

Manage Projects

/api/v1/projects/{id}

/api/v1/projects/{id}

/api/v1/projects/{id}

/api/v1/projects/{id}/workflows/attach

/api/v1/projects/{id}/workflows/detach

/api/v1/projects/{id}/storages/attach

/api/v1/projects/{id}/storages/detach

Create a project

Auth

Request Body

object	object
name	string	maxLength: 50
workflowIds	array[string]
storageIds	array[string]

POST /api/v1/projects

Copy

Responses

200

object	object
project4 fields	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

400

Bad Request

Response

Copy

List projects

Auth

GET /api/v1/projects

Copy

Responses

200

array	array[object]
id	string
name	string
workflowIds	array[string]
storageIds	array[string]

Response

Get a project by ID

Auth

Path Params

id string

GET /api/v1/projects/{id}

Responses

200

object	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]

404

Not Found

Response

Update a project

Auth

Path Params

id string

Request Body

object	object
name	string	maxLength: 50

PUT /api/v1/projects/{id}

Responses

200

object	object
project4 fields	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

Delete a project

Auth

Path Params

id string

DELETE /api/v1/projects/{id}

Responses

200

object	object
project4 fields	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

Attach workflows to a project

Auth

Path Params

id string

Request Body

object	object
ids	array[string]

POST /api/v1/projects/{id}/workflows/attach

Responses

200

object	object
project4 fields	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

Detach workflows from a project

Auth

Path Params

id string

Request Body

object	object
ids	array[string]

POST /api/v1/projects/{id}/workflows/detach

Responses

200

object	object
project4 fields	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

Attach connections (services) to a project

Auth

Path Params

id string

Request Body

object	object
ids	array[string]

POST /api/v1/projects/{id}/storages/attach

Responses

200

object	object
project4 fields	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

Detach connections (services) from a project

Auth

Path Params

id string

Request Body

object	object
ids	array[string]

POST /api/v1/projects/{id}/storages/detach

Responses

200

object	object
project4 fields	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

Manage Real-time Protection

/api/v1/realtime/{storageId}/enable

PATCH

/api/v1/realtime/{storageId}/disable

PATCH

/api/v1/realtime/{storageId}/{repositoryId}/disable

/api/v1/realtime

/api/v1/realtime/{storageId}

/api/v1/realtime/{storageId}

/api/v1/realtime/{storageId}/{repositoryId}

Enable real-time protection for multiple repositories

Auth

Path Params

storageId string

Request Body

object	object
repositories	array[object]
repositoryId	string
repositoryName	string
connection	string
workflowId	string

POST /api/v1/realtime/{storageId}/enable

Responses

207

Multi-Status

object	object
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

409

Conflict

Response

Disable real-time protection for connection

Auth

Path Params

storageId string

PATCH /api/v1/realtime/{storageId}/disable

Responses

200

No response body

Response

Disable real-time protection for repository

Auth

Path Params

storageId	string
repositoryId	string

PATCH /api/v1/realtime/{storageId}/{repositoryId}/disable

Responses

200

No response body

Response

List connections with real-time protection enabled

Auth

GET /api/v1/realtime

Responses

200

object	object
storages4 fields	array[object]
id	string
name	string
storageType4 fields	object
name	string
categoryType	integer
protocolType	integer
vendorType	integer
storageStatus	object
message	string
statusType	integer

Response

List ongoing real-time protection scans for connection

Auth

Path Params

storageId string

GET /api/v1/realtime/{storageId}

Responses

200

object	object
storageId	string
realTimeScans5 fields	array[object]
scanId	string
repositoryId	string
repositoryName	string
scanningState	integer
workflowId	string
scanInformation7 fields	object
totalFiles	int32
malware	int32
secret	int32
blockedFiles	int32
vulnerabilityIssues5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses3 fields	object
blockedLicensesCount	int32
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
package	object
totalPackages	int32
vulnerablePackages	int32

Response

Delete real-time scan protection for connection

Auth

Path Params

storageId string

Query String

forceDelete

boolean

Default: false

DELETE /api/v1/realtime/{storageId}

Responses

200

No response body

Response

Delete real-time scan protection for repository

Auth

Path Params

storageId	string
repositoryId	string

Query String

forceDelete

boolean

Default: false

DELETE /api/v1/realtime/{storageId}/{repositoryId}

Responses

200

No response body

Response

Manage Scan Configurations

/api/v1/scan-configurations

/api/v1/scan-configurations

/api/v1/scan-configurations/{id}

/api/v1/scan-configurations/{id}

/api/v1/scan-configurations/{id}

/api/v1/scan-configurations/scan-pools/{id}

Add a scan configuration

Auth

Request Body

object	object
name	string	maxLength: 50 minLength: 3
scanPoolId	string
rules	array[string]
userAgent	string

POST /api/v1/scan-configurations

Responses

200

object	object
id	string
scanPoolId	string
rules	array[string]
type	integer
name	string
scanPool5 fields	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances5 fields	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
userAgent	string
filters5 fields	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time

400

Bad Request

502

Bad Gateway

Response

Get all scan configurations

Auth

GET /api/v1/scan-configurations

Responses

200

object	object
Workflows8 fields	array[object]
id	string
scanPoolId	string
rules	array[string]
type	integer
name	string
scanPool5 fields	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances5 fields	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
userAgent	string
filters5 fields	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Update a scan configuration

Auth

Path Params

id string

Request Body

object	object
name	string	maxLength: 50 minLength: 3
scanPoolId	string
rules	array[string]
userAgent	string

PUT /api/v1/scan-configurations/{id}

Responses

200

object	object
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Delete a scan configuration

Auth

Path Params

id string

DELETE /api/v1/scan-configurations/{id}

Responses

200

object	object
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Get a scan configuration by ID

Auth

Path Params

id string

GET /api/v1/scan-configurations/{id}

Responses

200

object	object
Workflow8 fields	object
id	string
scanPoolId	string
rules	array[string]
type	integer
name	string
scanPool5 fields	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances5 fields	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
userAgent	string
filters5 fields	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Get all scan configurations by scan pool ID

Auth

Path Params

id string

GET /api/v1/scan-configurations/scan-pools/{id}

Responses

200

object	object
Workflows8 fields	array[object]
id	string
scanPoolId	string
rules	array[string]
type	integer
name	string
scanPool5 fields	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances5 fields	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
userAgent	string
filters5 fields	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

Response

Manage Scan Instances

/api/v1/scan-instances

/api/v1/scan-instances/{id}

/api/v1/scan-instances/{id}

/api/v1/scan-instances/{id}

Add a new scan instance

Auth

Request Body

object	object
scanPoolId	string
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
scanInstanceType	integer

POST /api/v1/scan-instances

Responses

200

object	object
scanInstanceId	string
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Delete a scan instance

Auth

Path Params

id string

DELETE /api/v1/scan-instances/{id}

Responses

200

object	object
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Get a scan instance by ID

Auth

Path Params

id string

GET /api/v1/scan-instances/{id}

Responses

200

object	object
scanInstance5 fields	object
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Update a scan instance

Auth

Path Params

id string

Request Body

object	object
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`

PUT /api/v1/scan-instances/{id}

Responses

200

object	object
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Manage Scan Pools

/api/v1/scan-pools/{id}

/api/v1/scan-pools/{id}

/api/v1/scan-pools/{id}

/api/v1/scan-pools/{id}/rules

Add a new scan pool

Auth

Request Body

object	object
name	string
scanPoolType	integer

POST /api/v1/scan-pools

Responses

200

object	object
scanPoolId	string
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Get scan pools

Auth

GET /api/v1/scan-pools

Responses

200

object	object
scanPools5 fields	array[object]
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances5 fields	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Delete a scan pool

Auth

Path Params

id string

DELETE /api/v1/scan-pools/{id}

Responses

200

object	object
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Get a scan pool by ID

Auth

Path Params

id string

GET /api/v1/scan-pools/{id}

Responses

200

object	object
scanPool5 fields	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances5 fields	array[object]
id	string
scanPoolId	string
url	string
apiKey	string
timeout	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Update an existing scan pool

Auth

Path Params

id string

Request Body

object	object
name	string

PUT /api/v1/scan-pools/{id}

Responses

200

object	object
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

Response

Get all rules from a scan pool

Auth

Path Params

id string

GET /api/v1/scan-pools/{id}/rules

Responses

200

array	array[object]
name	string
user_agents	array[string]

400

Bad Request

Response

Manage Scans

/api/v1/scans/{serviceId}/latest

/api/v1/scans/{id}/overview

/api/v1/scans/{serviceId}/{repositoryId}

/api/v1/scans/schedules

/api/v1/scans/cves

/api/v1/scans/cleanup

/api/v1/scans/{scanId}/files

/api/v1/scans/{scanResultId}/core-result

/api/v1/scans/{scanResultId}/archive

/api/v1/scans/vulnerability-trends/details

Add or start a scan

Auth

Request Body

object	object
storageId	string
storageName	string
scanType	integer
workflowId	string
repositoryId	string
repositoryName	string
protocolType	integer
repositoryReferences	array[string]
organization	string
connection	string
packageType	string
repositoryType	string

POST /api/v1/scans

Responses

200

object	object
scanIds	array[string]
referencesUsedForScanning	array[string]
protocolType	integer
repositoryId	string
repositoryName	string
serviceId	string
storageName	string
workflowId	string
workflowName	string
triggerEvent	string
triggerBy	string
responseKey	string
responseMessage	string

Response

Enumerate scan results

Auth

Query String

Type	array
TimeFrame	string	pattern: `^[0-9]*$` Default: null
Vulnerabilities	array
LicenseRisks	array
Status	array
TriggerEvent	array
Workflow	string	pattern: `^[0-9]*$` Default: null
Connection	string	pattern: `^[0-9]*$` Default: null
Secrets	boolean
Threats	boolean
Search	string	pattern: `^[0-9]*$` Default: null
ConnectionType	string	pattern: `^[0-9]*$` Default: null
RepositoryId	string	pattern: `^[0-9]*$` Default: null
Latest	boolean

GET /api/v1/scans

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Delete multiple scans by their scan IDs

Auth

Request Body

array array[string]

DELETE /api/v1/scans

Responses

200

No response body

400

Bad Request

500

Internal Server Error

Response

Upload and scan a file immediately

Uploads and scans files immediately. Optional 'jobName' labels the scan; if omitted, a name is generated automatically.

Auth

Request Body

object	object
files	array[string]
workflowId	string
metadata	string
jobName	string

POST /api/v1/scans/direct

Responses

200

object	object
scanIds	array[string]
referencesUsedForScanning	array[string]
protocolType	integer
repositoryId	string
repositoryName	string
serviceId	string
storageName	string
workflowId	string
workflowName	string
triggerEvent	string
triggerBy	string
responseKey	string
responseMessage	string

Response

Stop a scan

Auth

Path Params

id string

POST /api/v1/scans/{id}

Responses

200

object	object
statusCode	int32

Response

Get scan results by scan ID

Auth

Path Params

id string

GET /api/v1/scans/{id}

Responses

200

object	object
serviceId	string
repositoryId	string
repositoryName	string
repositoryType	string
referenceUsedForScanning	string
scanId	string
protocolType	integer
connection	string
packageType	string
organization	string
startTime	date-time
stopTime	date-time
duration	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
vulnerabilityIssues5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
scanStatus	integer
discoveryStatus	integer
errors	array[string]
blockedLicensesCount	int32
infectedFiles	int32
filesWithSecrets	int32

404

Not Found

Response

Enumerate all latest scan results

Auth

Query String

Type	array
TimeFrame	string	pattern: `^[0-9]*$` Default: null
Vulnerabilities	array
LicenseRisks	array
Status	array
TriggerEvent	array
Workflow	string	pattern: `^[0-9]*$` Default: null
Connection	string	pattern: `^[0-9]*$` Default: null
Secrets	boolean
Threats	boolean
Search	string	pattern: `^[0-9]*$` Default: null
ConnectionType	string	pattern: `^[0-9]*$` Default: null
RepositoryId	string	pattern: `^[0-9]*$` Default: null
Latest	boolean

GET /api/v1/scans/latest

Responses

200

array	array[object]
scanId	string
repository7 fields	object
connectionId	string
connectionName	string
protocolType	integer
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryMetadata	string
scanInformation12 fields	object
malware	boolean
secret	boolean
vulnerabilityIssues5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses3 fields	object
blockedLicensesCount	int32
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations	array[object]
isEnabled	boolean
type	string
package	object
totalPackages	int32
vulnerablePackages	int32
riskScore	int32
riskBreakdown4 fields	object
floor	int32
floorReason	string
extras	object
*	number
finalScore	int32
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus3 fields	object
scanningState	string
uploadProgress	int32
scanProgress	int32
metadata	string
sbomDocument3 fields	object
authorName	string
authorTool	string
timestamp	string

404

Not Found

Response

Enumerate all latest scan results by service ID

Auth

Path Params

serviceId string

Query String

Type	array
TimeFrame	string	pattern: `^[0-9]*$` Default: null
Vulnerabilities	array
LicenseRisks	array
Status	array
TriggerEvent	array
Workflow	string	pattern: `^[0-9]*$` Default: null
Connection	string	pattern: `^[0-9]*$` Default: null
Secrets	boolean
Threats	boolean
Search	string	pattern: `^[0-9]*$` Default: null
ConnectionType	string	pattern: `^[0-9]*$` Default: null
RepositoryId	string	pattern: `^[0-9]*$` Default: null
Latest	boolean

GET /api/v1/scans/{serviceId}/latest

Responses

200

object	object
scanId	string
repository7 fields	object
connectionId	string
connectionName	string
protocolType	integer
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryMetadata	string
scanInformation12 fields	object
malware	boolean
secret	boolean
vulnerabilityIssues5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses3 fields	object
blockedLicensesCount	int32
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations	array[object]
isEnabled	boolean
type	string
package	object
totalPackages	int32
vulnerablePackages	int32
riskScore	int32
riskBreakdown4 fields	object
floor	int32
floorReason	string
extras	object
*	number
finalScore	int32
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus3 fields	object
scanningState	string
uploadProgress	int32
scanProgress	int32
metadata	string
sbomDocument3 fields	object
authorName	string
authorTool	string
timestamp	string

Response

Get scan overview by scan ID

Auth

Path Params

id string

GET /api/v1/scans/{id}/overview

Responses

200

array	array[object]
scanId	string
repository7 fields	object
connectionId	string
connectionName	string
protocolType	integer
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryMetadata	string
scanInformation12 fields	object
malware	boolean
secret	boolean
vulnerabilityIssues5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses3 fields	object
blockedLicensesCount	int32
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations	array[object]
isEnabled	boolean
type	string
package	object
totalPackages	int32
vulnerablePackages	int32
riskScore	int32
riskBreakdown4 fields	object
floor	int32
floorReason	string
extras	object
*	number
finalScore	int32
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus3 fields	object
scanningState	string
uploadProgress	int32
scanProgress	int32
metadata	string
sbomDocument3 fields	object
authorName	string
authorTool	string
timestamp	string

Response

Enumerate all scan results by repository ID

Auth

Path Params

serviceId	string
repositoryId	string

GET /api/v1/scans/{serviceId}/{repositoryId}

Responses

200

array	array[object]
scanId	string
repository7 fields	object
connectionId	string
connectionName	string
protocolType	integer
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryMetadata	string
scanInformation12 fields	object
malware	boolean
secret	boolean
vulnerabilityIssues5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses3 fields	object
blockedLicensesCount	int32
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations	array[object]
isEnabled	boolean
type	string
package	object
totalPackages	int32
vulnerablePackages	int32
riskScore	int32
riskBreakdown4 fields	object
floor	int32
floorReason	string
extras	object
*	number
finalScore	int32
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus3 fields	object
scanningState	string
uploadProgress	int32
scanProgress	int32
metadata	string
sbomDocument3 fields	object
authorName	string
authorTool	string
timestamp	string

Response

Enumerate all scan schedules

Auth

GET /api/v1/scans/schedules

Responses

200

array	array[object]
id	string
workflowId	string
storageId	string
userId	string
name	string
priority	integer
createdAt	date-time
lastUpdated	date-time
lastScanTime	date-time
nextScanTime	date-time
recurrenceType	integer
startDate	date-time
timeToStart	date-time
everyNumberOfHours	int32
everyNumberOfDays	int32
everyNumberOfWeeks	int32
everyNumberOfMonths	int32
daysOfWeek	array[integer]
dayOfMonth	int32
workflow14 fields	object
id	string
name	string
description	string
userId	string
scanConfigurationId	string
blockedFileDefinition2 fields	object
mode	string
configuration4 fields	object
blockMaliciousContent	boolean
blockSensitiveData	boolean
blockVulnerabilities	boolean
vulnerabilitySeverities	array[string]
fileRemediations3 fields	object
sourceCode2 fields	object
allowed	object
keep	boolean
softDelete	boolean
blocked	object
keep	boolean
softDelete	boolean
container2 fields	object
allowed2 fields	object
keep	boolean
copy2 fields	object
serviceConnections6 fields	array[object]
sourceServiceId	string
destinationServiceId	string
sourceRepositoryId	string
destinationRepositoryId	string
sourceRepositoryPackageType	string
destinationRepositoryPackageType	string
isEnabled	boolean
blocked2 fields	object
keep	boolean
copy2 fields	object
serviceConnections6 fields	array[object]
sourceServiceId	string
destinationServiceId	string
sourceRepositoryId	string
destinationRepositoryId	string
sourceRepositoryPackageType	string
destinationRepositoryPackageType	string
isEnabled	boolean
binary2 fields	object
allowed2 fields	object
keep	boolean
copy2 fields	object
serviceConnections6 fields	array[object]
sourceServiceId	string
destinationServiceId	string
sourceRepositoryId	string
destinationRepositoryId	string
sourceRepositoryPackageType	string
destinationRepositoryPackageType	string
isEnabled	boolean
blocked3 fields	object
keep	boolean
copy2 fields	object
serviceConnections6 fields	array[object]
sourceServiceId	string
destinationServiceId	string
sourceRepositoryId	string
destinationRepositoryId	string
sourceRepositoryPackageType	string
destinationRepositoryPackageType	string
isEnabled	boolean
packageDelete	object
isEnabled	boolean
remediations
emailRecipients	array[string]
isEnabled	boolean
deleted	boolean
crossDomainTransfer3 fields	object
isEnabled	boolean
maxAllowedSeverity	integer
blockOnSecrets	boolean
createdAt	date-time
lastUpdated	date-time
tenantId	string
scans33 fields	array[object]
name	string
discoveryState	integer
scanningState	integer
scanType	integer
startTime	date-time
stopTime	date-time
executionId	string
errors	array[string]
priority	integer
realTimeIsEnabled	boolean
realTimeStartDate	date-time
realTimeHandlingType	integer
storageId	string
scanScheduleId	string
userId	string
tenantId	string
scanSchedule	object
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryRevision	string
repositoryType	string
packageType	string
scanTargetPath	string
organization	string
serviceName	string
protocolType	string
workflowId	string
workflowName	string
scanPartition	string
scanStatistics23 fields	object
totalFiles	int32
infectedFiles	int32
filesWithSecrets	int32
totalVulnerabilities	int32
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
startTime	date-time
stopTime	date-time
duration	string	pattern: `^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$`
appliedRemediations	array[string]
totalPackages	int32
packagesWithVulnerabilities	int32
allowedLicenses4 fields	array[object]
id	string
url	string
category	string
usage_restriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blockedLicenses	array
riskScore	int32
riskBreakdown4 fields	object
floor	int32
floorReason	string
extras	object
*	number
finalScore	int32
scan33 fields	object
name	string
discoveryState	integer
scanningState	integer
scanType	integer
startTime	date-time
stopTime	date-time
executionId	string
priority	integer
realTimeIsEnabled	boolean
realTimeStartDate	date-time
realTimeHandlingType	integer
storageId	string
scanScheduleId	string
userId	string
tenantId	string
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryRevision	string
repositoryType	string
packageType	string
scanTargetPath	string
organization	string
serviceName	string
protocolType	string
workflowId	string
workflowName	string
scanPartition	string
id	string
rowVersion	uint32
id	string
tenantId	string
id	string

Response

Enumerate all CVEs across scanned packages

Auth

Query String

severities	string	Default: null
search	string	Default: null
page	integer	Default: null
pageSize	integer	Default: null

GET /api/v1/scans/cves

Responses

200

object	object
page	int32
pageSize	int32
totalCount	int32
hasMoreItems	boolean
cves7 fields	array[object]
cve8 fields	object
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
packageId	string
packageName	string
packageVersion	string
ecosystem	string
repository	string
reference	string

400

Bad Request

401

Unauthorized

500

Internal Server Error

Response

Clean up historical scan results older than the specified time frame

Auth

Request Body

object	object
timeFrame	integer

POST /api/v1/scans/cleanup

Responses

200

object	object
deletedScansCount	int32
totalScansFound	int32
responseKey	string
responseMessage	string

207

Multi-Status

400

Bad Request

500

Internal Server Error

Response

Enumerate files by scan ID

Auth

Path Params

scanId string

Query String

page	integer	Default: null
pageSize	integer	Default: null
search	string	Default: null
includeArchives	boolean	Default: null
includePackages	boolean	Default: null

GET /api/v1/scans/{scanId}/files

Responses

200

array	array[object]
objectIdentityId	string
objectIdentityHash	string
scanResultId	string
progressUpload	int16
progressScan	int16
processingState	integer
exceptionDetails	string
created	date-time
discoveryStarted	date-time
discoveryStartedDaySec	int64
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
processingFailedTime	date-time
processingRetryCount	int16
objectTriggeredActions	array[object]
actionStatus	integer
triggeredActionType	integer
skippedScan	boolean
hasAppliedRemediation	boolean
hasAppliedSanitization	boolean
hasFailedSanitization	boolean
createdAt	date-time
lastUpdated	date-time
tenantId	string
objectRemediationActions12 fields	array[object]
id	string
objectActionType	integer
objectActionState	integer
cdrObjectState	integer
exceptions	array[string]
fileId	string
fileScanCompletedTime	date-time
remediationId	string
createdAt	date-time
lastUpdated	date-time
tenantId	string
file	object
versions41 fields	array[object]
url	string
fileId	string
fileScanCompletedTime	date-time
scanResultId	string
objectIdentityId	string
objectIdentityHash	string
progressScan	int16
progressUpload	int16
processingState	integer
exceptionDetails	string
created	date-time
discoveryStarted	date-time
discoveryStartedDaySec	int64
streamingTimeSpanMs	int64
scanCompletedTime	date-time
processingTimeSpanMs	int64
streamingStartedTime	date-time
streamingCompletedTime	date-time
processingFailedTime	date-time
processingRetryCount	int16
lastUpdated	date-time
createdAt	date-time
tenantId	string
objectIdentity15 fields	object
id	string
storageId	string
lastModifiedTime	date-time
storageObjectHash	string
path	string
processingType	integer
type	integer
objectIdentityHash	string
createdAt	date-time
lastUpdated	date-time
tenantId	string
objectIdentityActions	array[object]
scanResult21 fields	object
scanInstanceUrl	string
scanWorkflowSnapshotId	string
coreEnginesHash	string
objectIdentityId	string
objectIdentityHash	string
objectIdentity15 fields	object
id	string
storageId	string
lastModifiedTime	date-time
storageObjectHash	string
path	string
processingType	integer
type	integer
objectIdentityHash	string
createdAt	date-time
lastUpdated	date-time
tenantId	string
objectIdentityActions	array[object]
id	string
coreScanResult	string
resultI	integer
scanAllResultI	int16
totalDetections	int16
vulnerabilities	int16
dlpVerdict	int16
hasVulnerability	boolean
sandboxVerdict	integer
createdAt	date-time
lastUpdated	date-time
tenantId	string
file	object
id	string
scanId	string
storageId	string
scanWorkflowSnapshotId	string
metaDefenderCoreUrl	string
name	string
path	string
hash	string
objectStorageMetadata	string
size	int64
lastModified	date-time
storageLocation	string
fileTypeCategory	integer
pathForDisplay	string
extension	string
id	string
scanId	string
storageId	string
scanWorkflowSnapshotId	string
metaDefenderCoreUrl	string
name	string
path	string
hash	string
objectStorageMetadata	string
size	int64
lastModified	date-time
storageLocation	string
fileTypeCategory	integer
pathForDisplay	string
extension	string

404

Not Found

Response

Get the core result of a file by its scan result ID

Auth

Path Params

scanResultId string

GET /api/v1/scans/{scanResultId}/core-result

Responses

200

object	object
extracted_files5 fields	object
data_id	string
scan_result_i	int32
detected_by	int32
files_in_archive11 fields	array[object]
display_name	string
data_id	string
file_type	string
file_type_description	string
scan_result_i	int32
scan_all_result_i	int32
detected_by	int32
scanned_with	int32
progress_percentage	int32
file_size	int64
process_info9 fields	object
post_processing6 fields	object
actions_ran	string
actions_failed	string
converted_to	string
copy_move_destination	string
converted_destination	string
sanitization_details	object
failure_category	string
progress_percentage	int32
user_agent	string
profile	string
result	string
blocked_reason	string
file_type_skipped_scan	boolean
processing_time	number
queue_time	number
files_extracted_count	int32
scan_results8 fields	object
scan_details	object
*6 fields	object
threat_found	string
scan_result_i	int32
def_time	string
scan_time	number
wait_time	number
eng_id	string
data_id	string
scan_all_result_i	int32
start_time	string
total_time	number
total_avs	int32
progress_percentage	int32
scan_all_result_a	string
file_info13 fields	object
file_size	int64
upload_timestamp	string
md5	string
sha1	string
sha256	string
sha512	string
file_type	string
file_type_category	string
file_type_description	string
file_type_id	string
file_type_extension	string
display_name	string
original_file_path	string
process_info9 fields	object
post_processing6 fields	object
actions_ran	string
actions_failed	string
converted_to	string
copy_move_destination	string
converted_destination	string
sanitization_details	object
failure_category	string
progress_percentage	int32
user_agent	string
profile	string
result	string
blocked_reason	string
file_type_skipped_scan	boolean
processing_time	number
queue_time	number
data_id	string
source	string
scanned_on	string
dlp_info3 fields	object
hits	object
*2 fields	object
display_name	string
hits11 fields	array[object]
after	string
before	string
hit	string
certainty	string
certainty_score	int64
severity	integer
location	string
line	int32
column	int32
tryRedact	boolean
redactionStatus	integer
verdict	int64
category_counts9 fields	object
credit_cards	int32
social_security_numbers	int32
government_ids	int32
ipv4_addresses	int32
cidr	int32
adult_content	int32
personal_identity_documents	int32
secrets_in_text_files	int32
custom_regular_expressions	int32
sbom_info3 fields	object
final_verdict8 fields	object
blocked	boolean
licensing_package_counts4 fields	object
allowed	int32
blocked	int32
unknown	int32
unsupported	int32
total_package_count	int32
verdict	string
verdict_explanation	array[string]
vulnerability_counts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
vulnerable_package_count	int32
overview_report16 fields	object
is_partial_report	boolean
os_info	object
os_name	string
os_version	string
scan_mode	string
steps14 fields	array[object]
command	string
license_status	string
licensing_package_counts4 fields	object
allowed	int32
blocked	int32
unknown	int32
unsupported	int32
packages24 fields	array[object]
authors	string
release_date	string
arch	string
ecosystem	string
group	string
archive	boolean
executable	boolean
structured	boolean
uid	string
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usage_restriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
os_name	string
os_version	string
package_name	string
latest	object
version	string
release_date	string
hashes	array[object]
sha256	string
file_name	string
package_version	string
vulnerabilities9 fields	array[object]
id	string
source	string
fixed_versions	string
cwes	array[string]
type	string
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
vulnerability_counts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies7 fields	array[object]
uid	string
ecosystem	string
group	string
package_name	string
package_version	string
vulnerabilities	array
vulnerability_counts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
package_type	string
up_to_date	boolean
labels5 fields	array[object]
Key	string
Value	string
ValueType	string
Created	date-time
Updated	date-time
url	string
update_frequency	object
label	string
step	int32
vulnerability_count	int32
vulnerability_counts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies_vulnerability_count	int32
dependencies_vulnerability_counts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
sha256	string
package_count	int32
vulnerable_dependencies_package_count	int32
vulnerable_package_count	int32
packages23 fields	array[object]
authors	string
description	string
release_date	string
ecosystem	string
group	string
archive	boolean
executable	boolean
structured	boolean
uid	string
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usage_restriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
package_name	string
package_version	string
target	string
latest	object
version	string
release_date	string
hashes	array
vulnerabilities	array
vulnerability_counts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies	array
package_type	string
up_to_date	boolean
labels	array
url	string
update_frequency	object
label	string
dependencies_package_count	int32
dependencies_vulnerability_count	int32
dependencies_vulnerability_counts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
vulnerability_count	int32
vulnerability_counts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
has_pe_info	boolean
package_count	int32
timestamp	string
author	object
name	string
tool	string
vulnerable_dependencies_package_count	int32
vulnerable_package_count	int32
result_template_hash	string
vulnerability_info1 field	object
result6 fields	object
code	int64
hash	string
method	int64
timestamp	string
timing	int64
detected_product11 fields	object
has_vulnerability	boolean
is_current	boolean
product	object
id	int64
name	string
remediation_link	string
severity	string
sig_name	string
signature	int64
vendor	object
id	int64
name	string
version	string
version_data3 fields	object
count_behind	int64
feed_id	int64
version	string
vulnerabilities5 fields	array[object]
description	string
details8 fields	object
cpe	string
cve	string
cvss9 fields	object
access-complexity	string
access-vector	string
authentication	string
availability-impact	string
confidentiality-impact	string
generated-on-epoch	string
integrity-impact	string
score	string
source	string
cvss_3_013 fields	object
attack_complexity	string
attack_vector	string
availability_impact	string
base_score	string
base_severity	string
confidentiality_impact	string
exploitability_score	string
impact_score	string
integrity_impact	string
privileges_required	string
scope	string
user_interaction	string
vector_string	string
cwe	string
last-modified-epoch	string
published-epoch	string
references	array[string]
severity	string
severity_index	int32
static_id	int64
engine_stat	object
*14 fields	array[object]
abandoned	boolean
active	boolean
def_time	string
download_progress	int32
download_time	date-time
eng_id	string
eng_name	string
eng_type	string
eng_ver	string
engine_type	string
pinned	boolean
state	string
type	string
db_ver	string
sessionCookie	string
isFailed	boolean

Response

Get the core results of files in an archive by their scan result ID

Auth

Path Params

scanResultId string

Query String

count	integer
offset	integer

GET /api/v1/scans/{scanResultId}/archive

Responses

200

object	object
coreScanResults13 fields	array[object]
extractedFiles5 fields	object
dataId	string
scanResultI	int32
detectedBy	int32
filesInArchive11 fields	array[object]
displayName	string
dataId	string
fileType	string
fileTypeDescription	string
scanResultI	int32
scanAllResultI	int32
detectedBy	int32
scannedWith	int32
progressPercentage	int32
fileSize	int64
processInfo9 fields	object
postProcessing6 fields	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails	object
failureCategory	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
filesExtractedCount	int32
scanResults8 fields	object
scanDetails	object
*6 fields	object
threatFound	string
scanResultI	int32
defTime	string
scanTime	number
waitTime	number
engId	string
dataId	string
scanAllResultI	int32
startTime	string
totalTime	number
totalAvs	int32
progressPercentage	int32
scanAllResultA	string
fileInfo12 fields	object
fileSize	int64
uploadTimestamp	string
md5	string
sha1	string
sha256	string
fileTypeCategory	string
fileTypeCategoryCloud	string
fileTypeDescription	string
fileTypeExtension	string
fileTypeExtensionCloud	string
displayName	string
originalFilePath	string
processInfo9 fields	object
postProcessing6 fields	object
actionsRan	string
actionsFailed	string
convertedTo	string
copyMoveDestination	string
convertedDestination	string
sanitizationDetails	object
failureCategory	string
progressPercentage	int32
userAgent	string
profile	string
result	string
blockedReason	string
fileTypeSkippedScan	boolean
processingTime	number
queueTime	number
dataId	string
source	string
scannedOn	string
dlpInfo2 fields	object
hits2 fields	object
displayName	string
hits6 fields	array[object]
after	string
before	string
hit	string
certainty	string
certaintyScore	int64
severity	integer
verdict	int64
sbomInfo2 fields	object
finalVerdict3 fields	object
blocked	boolean
severity	integer
verdict	string
overviewReport6 fields	object
steps5 fields	array[object]
command	string
packages16 fields	array[object]
authors	string
arch	string
ecosystem	string
group	string
archive	boolean
executable	boolean
uid	string
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
osName	string
packageType	string
latest	object
version	string
hashes	array[object]
sha256	string
vulnerabilities9 fields	array[object]
id	string
source	string
severity	integer
fixedVersions	string
cwes	array[string]
type	string
aliases	array[string]
epss3 fields	object
date	string
percentile	number
score	number
ratings4 fields	array[object]
method	string
score	number
severity	string
source	object
name	string
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies3 fields	array[object]
ecosystem	string
group	string
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
upToDate	boolean
step	int32
sha256	string
severity	integer
packages15 fields	array[object]
authors	string
ecosystem	string
group	string
archive	boolean
executable	boolean
uid	string
licenses2 fields	object
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction3 fields	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
target	string
packageType	string
latest	object
version	string
hashes	array
vulnerabilities	array
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies	array
upToDate	boolean
vulnerabilityCount	int32
vulnerabilityCounts5 fields	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
hasPeInfo	boolean
timestamp	string
vulnerabilityInfo1 field	object
vulnerabilityInfoResult6 fields	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct11 fields	object
hasVulnerability	boolean
isCurrent	boolean
product	object
id	int64
name	string
remediationLink	string
severity	string
sigName	string
signature	int64
vendor	object
id	int64
name	string
version	string
versionData3 fields	object
countBehind	int64
feedId	int64
version	string
vulnerabilities5 fields	array[object]
description	string
details8 fields	object
cpe	string
cve	string
cvss9 fields	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss313 fields	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
engines	object
*13 fields	array[object]
abandoned	boolean
active	boolean
defTime	string
downloadProgress	int32
engId	string
engName	string
engType	string
engineVersion	string
engineType	string
pinned	boolean
state	string
type	string
dbVer	string
sessionCookie	string
isFailed	boolean
hasMore	boolean

Response

Get per-CVE new/fixed details for each trend period

Auth

Query String

interval	integer	Default: 1
periods	integer	Default: 4

GET /api/v1/scans/vulnerability-trends/details

Responses

200

array	array[object]
periodStart	date
periodEnd	date
newCves6 fields	array[object]
cveId	string
severity	integer
repositoryId	string
repositoryName	string
packageName	string
packageVersion	string
fixedCves	array

500

Internal Server Error

Response

Manage Services Connections

/api/v1/services/{serviceId}

/api/v1/services/{serviceId}

/api/v1/services/{serviceId}

/api/v1/services/{serviceId}/references

/api/v1/services/{serviceId}/resources

/api/v1/services/{serviceId}/top-risky

/api/v1/services/{serviceId}/{repositoryId}/references

/api/v1/services/references

Add a service

Auth

Request Body

object	object
credentials	string
name	string
vendorType	integer
protocolType	integer

POST /api/v1/services

Responses

200

object	object
id	string
name	string
type4 fields	object
name	string
categoryType	integer
protocolType	integer
vendorType	integer
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

Response

Get all services

Auth

Query String

content	boolean
type	array

GET /api/v1/services

Responses

200

object	object
serviceDtos9 fields	array[object]
id	string
credentialsType	int32
scanWorkflowId	string
domain	string
realTimeStatus	integer
name	string
vendorType	integer
protocolType	integer
statusMessage	string

206

Partial Content

400

Bad Request

Response

Update a service by ID

Auth

Path Params

serviceId string

Request Body

object	object
name	string
credentials	string
hasNewCredentials	boolean

PUT /api/v1/services/{serviceId}

Responses

200

object	object
id	string
name	string
type4 fields	object
name	string
categoryType	integer
protocolType	integer
vendorType	integer
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

Response

Get a service by ID

Auth

Path Params

serviceId string

Query String

content	boolean
Search	string	Default: null
Page	integer	Default: null
PageSize	integer	Default: null
FilterValue	string	maxLength: 256 minLength: 0 pattern: `^[0-9]*$` Default: null
Cursor	string	maxLength: 256 minLength: 0 pattern: `^[0-9]*$` Default: null
Search	string	maxLength: 256 minLength: 0 pattern: `^[0-9]*$` Default: null
PrioritizedRepositoriesReference	string	Default: null

GET /api/v1/services/{serviceId}

Responses

200

object	object
id	string
credentialsType	int32
scanWorkflowId	string
domain	string
realTimeStatus	integer
name	string
vendorType	integer
protocolType	integer

400

Bad Request

404

Not Found

Response

Delete a service by ID

Auth

Path Params

serviceId string

DELETE /api/v1/services/{serviceId}

Responses

200

object	object
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

404

Not Found

Response

Get service references by service ID

Auth

Path Params

serviceId string

GET /api/v1/services/{serviceId}/references

Responses

200

object	object
serviceId	string
serviceName	string
repositoryReferenceInfoArray3 fields	array[object]
repositoryId	string
defaultReference	string
references	array[string]

404

Not Found

Response

Get service resources by service ID

Auth

Path Params

serviceId string

GET /api/v1/services/{serviceId}/resources

Responses

200

object	object
resources	array[string]

404

Not Found

Response

Get top-risky repositories for a service

Auth

Path Params

serviceId string

Query String

count

integer

Default: null

GET /api/v1/services/{serviceId}/top-risky

Responses

200

array	array[object]
connectionId	string
connectionName	string
repositoryId	string
repositoryName	string
riskScore	int32

500

Internal Server Error

Response

Get service references by service ID and repository ID

Auth

Path Params

serviceId	string
repositoryId	string

Query String

Page	integer	Default: null
PageSize	integer	Default: null
FilterValue	string	maxLength: 256 minLength: 0 pattern: `^[0-9]*$` Default: null
Cursor	string	maxLength: 256 minLength: 0 pattern: `^[0-9]*$` Default: null
Search	string	maxLength: 256 minLength: 0 pattern: `^[0-9]*$` Default: null

GET /api/v1/services/{serviceId}/{repositoryId}/references

Responses

200

object	object
references	array[string]
totalReferences	uint32

404

Not Found

Response

Add service references

Auth

Request Body

array	array[object]
serviceId	string
repositoryIds	array[string]

POST /api/v1/services/references

Responses

200

array	array[object]
serviceId	string
serviceName	string
repositoryReferenceInfoArray3 fields	array[object]
repositoryId	string
defaultReference	string
references	array[string]

204

No Content

404

Not Found

Response

Add a SMTP configuration

Auth

Request Body

object	object
host	string
baseUrl	string
port	int32
senderAddress	string
senderName	string
domain	string
username	string
password	string
secureSocketOption	integer
ignoreCertWarnings	boolean
isEnabled	boolean

POST /api/v1/smtp

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Partially update SMTP configuration

Auth

Request Body

object	object
host	string
baseUrl	string
port	int32
senderAddress	string
senderName	string
domain	string
username	string
password	string
secureSocketOption	integer
ignoreCertWarnings	boolean
isEnabled	boolean

PATCH /api/v1/smtp

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Get a SMTP configuration

Auth

GET /api/v1/smtp

Responses

200

object	object
smtp15 fields	object
id	string
host	string
port	int32
senderAddress	string
senderName	string
domain	string
baseUrl	string
userName	string
password	string
secureSocketOption	integer
ignoreCertWarnings	boolean
isEnabled	boolean
tenantId	string
createdAt	date-time
lastUpdated	date-time
responseKey	string
responseMessage	string

400

Bad Request

Response

Add a Jira configuration

Auth

Request Body

object	object
name	string
apiKey	string
baseAddress	string
productAddress	string
username	string

POST /api/v1/jira

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Get all Jira configurations

Auth

GET /api/v1/jira

Responses

200

object	object
jiraEntries9 fields	array[object]
id	string
name	string
apiKey	string
baseAddress	string
productAddress	string
username	string
tenantId	string
createdAt	date-time
lastUpdated	date-time
responseKey	string
responseMessage	string

400

Bad Request

Response

Get a Jira configuration by ID

Auth

Path Params

id string

GET /api/v1/jira/{id}

Responses

200

object	object
jira9 fields	object
id	string
name	string
apiKey	string
baseAddress	string
productAddress	string
username	string
tenantId	string
createdAt	date-time
lastUpdated	date-time
responseKey	string
responseMessage	string

404

Not Found

Response

Update a Jira configuration by ID

Auth

Path Params

id string

Request Body

object	object
name	string
apiKey	string
baseAddress	string
productAddress	string
username	string

PUT /api/v1/jira/{id}

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Delete a Jira configuration by ID

Auth

Path Params

id string

DELETE /api/v1/jira/{id}

Responses

200

object	object
jiraId	string
responseKey	string
responseMessage	string

404

Not Found

Response

Get Jira projects

Auth

Path Params

id string

GET /api/v1/jira/{id}/projects

Responses

200

object	object
projects	array[object]
id	string
name	string
responseKey	string
responseMessage	string

404

Not Found

Response

Add a Teams configuration

Auth

Request Body

object	object
name	string
apiKey	string
webhookUrl	string
productAddress	string

POST /api/v1/teams

Responses

201

Created

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Get all Teams configurations

Auth

GET /api/v1/teams

Responses

200

object	object
teamsConnections8 fields	array[object]
name	string
apiKey	string
webhookUrl	string
productAddress	string
createdAt	date-time
lastUpdated	date-time
id	string
tenantId	string
responseKey	string
responseMessage	string

400

Bad Request

Response

Get a Teams configuration by ID

Auth

Path Params

id string

GET /api/v1/teams/{id}

Responses

200

object	object
teams8 fields	object
name	string
apiKey	string
webhookUrl	string
productAddress	string
createdAt	date-time
lastUpdated	date-time
id	string
tenantId	string
responseKey	string
responseMessage	string

404

Not Found

Response

Update a Teams configuration by ID

Auth

Path Params

id string

Request Body

object	object
name	string
apiKey	string
webhookUrl	string
productAddress	string

PUT /api/v1/teams/{id}

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Delete a Teams configuration by ID

Auth

Path Params

id string

DELETE /api/v1/teams/{id}

Responses

200

object	object
teamsId	string
responseKey	string
responseMessage	string

404

Not Found

Response

telemetry

Auth

GET /api/v1/telemetry

Responses

200

object	object
enabled	boolean
sendToOpswatEnabled	boolean
collectors4 fields	array[object]
endpointUrl	string
metricProtocol	string
hasApiKey	boolean
responseKey	string
responseMessage	string

Response

enabled

Auth

Request Body

object	object
enabled	boolean

PUT /api/v1/telemetry/enabled

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

opswat

Auth

Request Body

object	object
sendToOpswatEnabled	boolean

PUT /api/v1/telemetry/opswat

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

collectors

Auth

Request Body

object	object
endpointUrl	string
metricProtocol	string
apiKey	string

POST /api/v1/telemetry/collectors

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

collectors

Auth

Request Body

object	object
endpointUrl	string
metricProtocol	string
apiKey	string

PUT /api/v1/telemetry/collectors

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

collectors

Auth

Query String

endpointUrl string

DELETE /api/v1/telemetry/collectors

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Manage Users

/api/v1/users/{userId}

/api/v1/user/login

/api/v1/user/login/{userId}

/api/v1/user/token

/api/v1/user/password/request-reset

/api/v1/user/password/new-password

Add a new user

Auth

Request Body

object	object
role	integer
fullName	string
userName	string
password	string
email	string

POST /api/v1/users

Responses

200

object	object
createUserParameters5 fields	object
role	integer
fullName	string
userName	string
password	string
email	string
currentUserId	string

400

Bad Request

Response

Get users

Auth

Query String

Type	string	maxLength: 256 minLength: 0 pattern: `^[0-9]*$` Default: null
StartIndex	integer	Default: null
Count	integer	Default: null
SearchTerm	string	maxLength: 256 minLength: 0 pattern: `^[0-9]*$` Default: null

GET /api/v1/users

Responses

200

object	object
enumerateUsersDto2 fields	object
entries6 fields	array[object]
userId	string
username	string
fullName	string
email	string
role	integer
showTutorial	boolean
totalCount	int64
responseKey	string
responseMessage	string

400

Bad Request

Response

Update a user

Auth

Request Body

object	object
userId	string
role	integer
userName	string
fullName	string
email	string
currentPassword	string
newPassword	string
showTutorial	boolean

PUT /api/v1/users

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Get current user

Auth

GET /api/v1/user

Responses

200

object	object
userDto6 fields	object
userId	string
username	string
fullName	string
email	string
role	integer
showTutorial	boolean
responseKey	string
responseMessage	string

400

Bad Request

Response

Delete a user

Auth

Path Params

userId string

DELETE /api/v1/users/{userId}

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Login user

Auth

Request Body

object	object
username	string
password	string

POST /api/v1/user/login

Responses

200

object	object
jwtToken	object
token	string
responseKey	string
responseMessage	string

400

Bad Request

Response

Remove all tokens for an user

Auth

Path Params

userId string

DELETE /api/v1/user/login/{userId}

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Get a new Access Token

Auth

Request Body

object	object
accessToken	string

PUT /api/v1/user/token

Responses

200

object	object
jwtToken	object
token	string
responseKey	string
responseMessage	string

400

Bad Request

Response

Request a password reset

Auth

Request Body

object	object
emailInput	string

POST /api/v1/user/password/request-reset

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Reset a user password

Auth

Request Body

object	object
newPassword	string	minLength: 12
newPasswordConfirmation	string	minLength: 12
secureToken	string
userId	string

POST /api/v1/user/password/new-password

Responses

200

object	object
user6 fields	object
userId	string
username	string
fullName	string
email	string
role	integer
showTutorial	boolean
responseKey	string
responseMessage	string

Response

Manage Versions

Get application version

Auth

Query String

api-version

string

maxLength: 256

minLength: 0

pattern: ^[0-9]*$

Default: null

GET /api/version

Responses

200

object	object
version	string
lastSupportedConfigVersion	string
responseKey	string
responseMessage	string

Response

Get application version

Auth

GET /api/v1/version

Responses

200

object	object
version	string
lastSupportedConfigVersion	string
responseKey	string
responseMessage	string

Response

Manage Webhooks

/api/v1/webhook/hmac/{routeParameter}

/api/v1/webhook/{routeParameter}

Handles a scan event triggered by a webhook. Requires a custom header and a body.

Auth

Path Params

routeParameter string

Request Body

No request body

POST /api/v1/webhook/hmac/{routeParameter}

Responses

200

No response body

400

Bad Request

500

Internal Server Error

Response

Handles a scan event triggered by a webhook. Requires a custom body.

Auth

Path Params

routeParameter string

Request Body

No request body

POST /api/v1/webhook/{routeParameter}

Responses

200

No response body

400

Bad Request

500

Internal Server Error

Response

Manage Workflows

/api/v1/workflows/{id}

/api/v1/workflows/{id}

/api/v1/workflows/{id}