MetaDefender Software Supply Chain API 4.1.0 4.1.0

/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
intervalMinutes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
groupId	string
groupName	string

POST /api/v1/monitored-files

Responses

200

object	object
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
newCveCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

monitored-files

Auth

GET /api/v1/monitored-files

Responses

200

array	array[object]
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
newCveCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

history

Auth

Path Params

id string

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

Responses

200

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

Response

scan-now

Auth

Path Params

id string

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

Responses

200

object	object
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
newCveCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

enabled

Auth

Path Params

id string

Request Body

object	object
enabled	boolean

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

Responses

200

object	object
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
newCveCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

interval

Auth

Path Params

id string

Request Body

object	object
intervalMinutes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer

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

Responses

200

object	object
id	string
originalFileName	string
sha256	string
groupId	string
groupName	string
enabled	boolean
rescanIntervalMinutes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
newCveCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
lastRunAt	date-time
nextRunAt	date-time
createdAt	date-time

Response

{id}

Auth

Path Params

id string

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

Responses

204

No Content

No response body

Response

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

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

Create Role

Auth

Request Body

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

POST /api/v1/abac/roles

Responses

200

object	object
role
responseKey	string
responseMessage	string

Response

Get Role by ID

Auth

Path Params

roleId string

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

Responses

200

object	object
role
responseKey	string
responseMessage	string

Response

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}

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Delete Role

Auth

Path Params

roleId string

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Get Permissions

Auth

GET /api/v1/abac/permissions

Responses

200

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

Response

Create Permission

Auth

Request Body

object	object
action	string
resource	string

POST /api/v1/abac/permissions

Responses

200

object	object
permission
responseKey	string
responseMessage	string

Response

Delete Permission

Auth

Path Params

permissionId string

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Assign Permission to Role

Auth

Path Params

roleId string

Request Body

object	object
permissionId	uuid

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Remove Permission from Role

Auth

Path Params

roleId	string
permissionId	string

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

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

Responses

200

object	object
roleBindingId	uuid
responseKey	string
responseMessage	string

Response

Replace User Roles

Auth

Path Params

userId string

Request Body

object	object
roleIds	array[string]

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Remove Role from User

Auth

Path Params

userId	string
roleBindingId	string

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

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

Responses

200

object	object
userPermissionId	uuid
responseKey	string
responseMessage	string

Response

Remove Permission from User

Auth

Path Params

userId	string
userPermissionId	string

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Manage Audit

/api/v1/audit

List audit events

Auth

Query String

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

GET /api/v1/audit

Responses

200

object	object
entries4 fields	array[object]	Because it belongs to a response, if RetrieveLogs breaks, we won't have Entries and TotalCount.
id	string
level	integer
properties5 fields	object
logType	integer
category	integer
eventTimestamp	date-time
userId	string
userName	string
renderedMessage	string
totalCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

Response

Manage Password Encryption

/api/v1/auth/public-key

Get the public key used to encrypt passwords

Auth

GET /api/v1/auth/public-key

Responses

200

object	object
mode	integer
serverTime		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
keys6 fields	array[object]
kty	string
kid	string
use	string
alg	string
n	string
e	string

Response

Manage Configuration

/api/v1

Get application configuration

Auth

GET /api/v1

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Manage Cross Domain Transfers

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

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

/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/disable

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

/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

receiveFileStreamDto11 fields	object
transmissionId	string
fileName	string
fileSizeBytes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalChunks		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
chunkSizeBytes		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
storageName	string
repositoryName	string
reference	string
organization	string
transferTimestamp		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
transferSignature	string

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

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

500

Internal Server Error

Response

Get the global cross-domain configuration for both sides

Auth

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

Responses

200

object	object
lowside
highside
responseKey	string
responseMessage	string

Response

Set global lowside configuration

Auth

Request Body

object	object
highsideAddress	string
authorizationToken	string
pairingSecret	string
enabled	boolean

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

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Disable global lowside configuration

Auth

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

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Set global highside configuration

Auth

Request Body

object	object
pushBehaviour	integer
enabled	boolean
scanBeforeImport	boolean
scanWorkflowId	string
maxAllowedSeverity
blockOnSecrets	boolean
scanTimeoutSeconds		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
pollIntervalSeconds		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
hasPairingSecret	boolean
pairingSecretIssuedAt	date-time

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

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Disable global highside configuration

Auth

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

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Generate a pairing secret for the global highside configuration

Auth

POST /api/v1/cross-domain/global-config/highside/pairing-secret

Responses

200

object	object
pairingSecret
responseKey	string
responseMessage	string

400

Bad Request

404

Not Found

Response

Get cross-domain operation logs

Auth

Query String

page		pattern: `^-?(?:0\|[1-9]\d*)$`
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
sortBy	string
sortOrder	integer
filter	string
search	string

GET /api/v1/cross-domain/logs

Responses

200

object	object
logs14 fields	array[object]
id	string
transmissionId	string
storageId	string
step	integer
status	integer
timestamp	date-time
storageName	string
storage
lowsideRepositoryName	string
highsideRepositoryName	string
reference	string
scanId	string
fileId	string
errorMessage	string
hasNextPage	boolean
hasPreviousPage	boolean
responseKey	string
responseMessage	string

Response

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

Auth

Path Params

transmissionId string

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

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Receive a lowside configuration change notification

Auth

Headers

X-Transfer-Timestamp		pattern: `^-?(?:0\|[1-9]\d*)$`
X-Transfer-Signature	string

Request Body

object	object
storageName	string
protocolType	integer
changeType	integer

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

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Get all cross-domain notifications

Auth

GET /api/v1/cross-domain/notifications

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

Get a lowside configuration by storage ID

Auth

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

Responses

200

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

Response

Add a lowside configuration

Auth

Request Body

object	object
storageId	string

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

Responses

200

object	object
configurationId	string
responseKey	string
responseMessage	string

400

Bad Request

Response

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}

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Delete a lowside configuration by ID

Auth

Path Params

id string

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

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Get a highside storage configuration by storage ID

Auth

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

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

Add a highside configuration

Auth

Request Body

object	object
storageId	string
notificationId	string

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

Responses

200

object	object
configurationId	string
responseKey	string
responseMessage	string

400

Bad Request

Response

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}

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

Delete a highside configuration by ID

Auth

Path Params

id string

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

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

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

Responses

200

object	object
summary19 fields	object
totalConnections		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalScannedRepositories		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalScannedRepositoriesTrend		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalPackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalPackagesTrend		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskScore		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskScoreTrend		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
criticalVulnerabilities		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
criticalPackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
criticalRepositories		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalVulnerabilities		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalVulnerabilitiesTrend		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalThreats		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalThreatsTrend		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalSecrets		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalSecretsTrend		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
severity5 fields	object
critical		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
topRiskyPackages	array[object]
name	string
criticalCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
topRiskyRepositories	array[object]
name	string
detectionCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
trends9 fields	array[object]
periodStart	date-time
periodEnd	date-time
totalVulnerabilities		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
critical		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scansConsidered		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer

400

Bad Request

500

Internal Server Error

Response

Get top-risky repositories across all connections

Auth

Query String

window	string
count		pattern: `^-?(?:0\|[1-9]\d*)$`

GET /api/v1/dashboard/top-risky

Responses

200

array	array[object]
connectionId	string
connectionName	string
repositoryId	string
repositoryName	string
riskScore		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer

400

Bad Request

500

Internal Server Error

Response

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/pdf/sbom/dependencies/{scanId}

/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

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a CycloneDX report for a specific file scan

Auth

Path Params

fileId string

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

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}

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

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}

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a PDF report for all scans

Auth

Query String

Type	array
TimeFrame	integer
Vulnerabilities	array
LicenseRisks	array
Status	array
TriggerEvent	array
Workflow	string
Connection	string
Secrets	boolean
Threats	boolean
Search	string
ConnectionType	integer
RepositoryId	string
Latest	boolean

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a PDF overview report for repository

Auth

Path Params

scanId string

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a PDF SBOM report for repository

Auth

Path Params

scanId string

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a PDF SBOM report for a specific batch of files

Auth

Path Params

fileId string

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a PDF SBOM report for repository that lists every package dependency as its own package

Auth

Path Params

scanId string

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a CSV report for repository

Auth

Path Params

scanId string

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a CSV report for a specific batch of files

Auth

Path Params

fileId string

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

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

Export a CSV report of all CVEs from latest scans

Auth

Query String

Severity array

GET /api/v1/export/csv/cves

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

Response

Export a CSV report of all packages from latest scans

Auth

GET /api/v1/export/csv/packages

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag
enableRangeProcessing	boolean

400

Bad Request

Response

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

Responses

200

No response body

Response

Add an external logger

Auth

Request Body

object	object
connectionSettings4 fields	object
serverAddress	string
port		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
facility	integer
format	integer

POST /api/v1/externallogger

Responses

200

No response body

Response

Update an external logger

Auth

Path Params

id string

Request Body

object	object
connectionSettings4 fields	object
serverAddress	string
port		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
facility	integer
format	integer

PUT /api/v1/externallogger/{id}

Responses

200

No response body

Response

Delete an external logger

Auth

Path Params

id string

DELETE /api/v1/externallogger/{id}

Responses

200

No response body

Response

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

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

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

Responses

200

object	object
globalKey
responseKey	string
responseMessage	string

Response

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}

Responses

200

object	object
globalKey
responseKey	string
responseMessage	string

Response

Deletes an global label key

Auth

Path Params

id string

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

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
workflowId	string
referenceSelectionMode
targets4 fields	array[object]
protocolType	integer
storageId	string
repositoryId	string
repositoryName	string

POST /api/v1/jobs

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

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
TimeFrame	integer
Type	array
ConnectionType	integer
Repository	string
Service	string
Vulnerabilities	array
LicenseRisks	array
Threats	boolean
Secrets	boolean
SortBy	string
SortDir	string
Page		pattern: `^-?(?:0\|[1-9]\d*)$`
PageSize		pattern: `^-?(?:0\|[1-9]\d*)$`

GET /api/v1/jobs

Responses

200

object	object
page		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
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
scanInformation
scanStatus

Response

Bulk delete jobs (trigger-agnostic)

Auth

Request Body

object	object
jobIds	array[string]

DELETE /api/v1/jobs

Responses

200

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

400

Bad Request

Response

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
workflowId	string
targets4 fields	array[object]
protocolType	integer
storageId	string
repositoryId	string
repositoryName	string

POST /api/v1/jobs/rtp

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

Create a scheduled job with a recurrence pattern

Auth

Request Body

object	object
name	string
priority
workflowId	string
referenceSelectionMode
recurrencePattern5 fields	object
type	integer
hourlyRecurrence
dailyRecurrence
weeklyRecurrence
monthlyRecurrence
targets4 fields	array[object]
protocolType	integer
storageId	string
repositoryId	string
repositoryName	string

POST /api/v1/jobs/scheduled

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

Delete all upcoming jobs

Auth

DELETE /api/v1/jobs/scheduled

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

Cancel a job (for RealTime jobs this disables RTP)

Auth

Path Params

id string

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

Responses

200

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

404

Not Found

Response

Get a single job by id

Auth

Path Params

id string

GET /api/v1/jobs/{id}

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
scanInformation
scanStatus

404

Not Found

Response

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

Responses

200

object	object
result	integer
responseMessage	string

400

Bad Request

Response

Activate a license offline

Auth

Request Body

object	object
LicenseContent	file

POST /api/v1/licenses/offline

Responses

200

object	object
result	integer
responseMessage	string

400

Bad Request

Response

Remove licenses

Auth

DELETE /api/v1/licenses

Responses

200

object	object
result	integer
responseMessage	string

400

Bad Request

404

Not Found

Response

Get licenses

Auth

GET /api/v1/licenses

Responses

200

object	object
result	integer
license
responseMessage	string

400

Bad Request

404

Not Found

Response

Get current deployment Id for offline license activation

Auth

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

Responses

200

object	object
result	integer
currentDeploymentId	string
responseMessage	string

400

Bad Request

Response

Manage Opswat Central Management Ocm

Update an OCM instance

Auth

Request Body

object	object
serverApi	string
regCode	string

PUT /api/v1/ocm

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Delete an OCM instance

Auth

DELETE /api/v1/ocm

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Get an OCM instance

Auth

GET /api/v1/ocm

Responses

200

object	object
ocmInformation
responseKey	string
responseMessage	string

Response

Manage Onboarding

/api/v1/onboarding

/api/v1/onboarding/complete

/api/v1/onboarding/accept-eula

Get onboarding

Auth

GET /api/v1/onboarding

Responses

200

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

Response

Complete onboarding

Auth

POST /api/v1/onboarding/complete

Responses

200

No response body

Response

Agree to onboarding EULA

Auth

POST /api/v1/onboarding/accept-eula

Responses

200

No response body

Response

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
Ecosystem	string
Version	string
Vulnerabilities	array
LicenseRisks	array
Connection	string
Repository	string
Reference	string
ScanId	string
StepSha256	string
Search	string
IncludeDirectFiles	boolean
sortBy	integer
sortDir	integer
page		pattern: `^-?(?:0\|[1-9]\d*)$`
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`

GET /api/v1/packages

Responses

200

object	object
page		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
hasMoreItems	boolean
packages23 fields	array[object]
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
packageType	string
licenses
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]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
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]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts
supplierName	string
releaseDate	date-time
labels5 fields	array[object]
key	string
value	string
valueType	string
created	date-time
updated	date-time
latest
createdAt	date-time
lastUpdated	date-time
impact	integer
dependencyImpact	integer
recommendedVersion	string

207

Multi-Status

401

Unauthorized

Response

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

Auth

Query String

ecosystem	string
packageName	string

GET /api/v1/packages/versions

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]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
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]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts
licenses
responseKey	string
responseMessage	string

Response

Retrieves a package by its internal database ID

Auth

Path Params

id string

Query String

includeDirectFiles

boolean

Default: false

GET /api/v1/packages/{id}

Responses

200

object	object
package
responseKey	string
responseMessage	string

Response

Retrieves a package by its universal package UID

Auth

Path Params

uidInB64 string

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

Responses

200

object	object
package
responseKey	string
responseMessage	string

Response

Retrieves CVEs associated with a specific package

Auth

Path Params

id string

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

Responses

200

object	object
cves8 fields	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
responseKey	string
responseMessage	string

Response

Retrieves the ecosystem-specific upgrade command for a package

Auth

Path Params

id string

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

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

Retrieves all labels for a specific package

Auth

Path Params

id string

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

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

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

Responses

200

object	object
label
responseKey	string
responseMessage	string

Response

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}

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Deletes a label from a package

Auth

Path Params

id	string
key	string

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

Responses

200

object	object
responseKey	string
responseMessage	string

Response

Searches for packages by label key and optionally value

Auth

Query String

key	string
value	string

GET /api/v1/packages/search/labels

Responses

200

object	object
packages23 fields	array[object]
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
packageType	string
licenses
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]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
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]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts
supplierName	string
releaseDate	date-time
labels5 fields	array[object]
key	string
value	string
valueType	string
created	date-time
updated	date-time
latest
createdAt	date-time
lastUpdated	date-time
impact	integer
dependencyImpact	integer
recommendedVersion	string
responseKey	string
responseMessage	string

Response

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

Responses

200

object	object
project
responseKey	string
responseMessage	string

400

Bad Request

Response

List projects

Auth

GET /api/v1/projects

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
project
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
project
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
project
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
project
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
project
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
project
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
scanInformation

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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
maximumSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
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]	Because it belongs to a response, if GetMultipleScanConfiguration breaks, we won't have ScanConfigurations.
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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
maximumSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
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
Workflow
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]	Because it belongs to a response, if GetMultipleScanConfiguration breaks, we won't have ScanConfigurations.
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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
maximumSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
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

400

Bad Request

404

Not Found

500

Internal Server Error

Response

Delete a scan instance

Auth

Path Params

id string

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

Responses

200

No response body

400

Bad Request

404

Not Found

500

Internal Server Error

Response

Get a scan instance by ID

Auth

Path Params

id string

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

Responses

200

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

400

Bad Request

404

Not Found

500

Internal Server Error

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

No response body

400

Bad Request

404

Not Found

500

Internal Server Error

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

No response body

400

Bad Request

404

Not Found

500

Internal Server Error

Response

Get a scan pool by ID

Auth

Path Params

id string

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

Responses

200

object	object
scanPool
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}/details

/api/v1/scans/{scanResultId}/children

/api/v1/scans/{scanResultId}/dependencies

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

/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
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
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	integer
Vulnerabilities	array
LicenseRisks	array
Status	array
TriggerEvent	array
Workflow	string
Connection	string
Secrets	boolean
Threats	boolean
Search	string
ConnectionType	integer
RepositoryId	string
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

object	object
notFoundScanIds	array[string]
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

207

Multi-Status

400

Bad Request

404

Not Found

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
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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer

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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scanStatus	integer
discoveryStatus	integer
errors	array[string]
blockedLicensesCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
infectedFiles		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
filesWithSecrets		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer

404

Not Found

Response

Enumerate all latest scan results

Auth

Query String

Type	array
TimeFrame	integer
Vulnerabilities	array
LicenseRisks	array
Status	array
TriggerEvent	array
Workflow	string
Connection	string
Secrets	boolean
Threats	boolean
Search	string
ConnectionType	integer
RepositoryId	string
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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
licenses3 fields	object
blockedLicensesCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction
blocked4 fields	array[object]
id	string
url	string
category	string
usageRestriction
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations3 fields	array[object]
isEnabled	boolean
type	string
config
package	object
totalPackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
vulnerablePackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskScore		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskBreakdown
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus3 fields	object
scanningState	string
uploadProgress		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scanProgress		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
metadata	string

404

Not Found

Response

Enumerate all latest scan results by service ID

Auth

Path Params

serviceId string

Query String

Type	array
TimeFrame	integer
Vulnerabilities	array
LicenseRisks	array
Status	array
TriggerEvent	array
Workflow	string
Connection	string
Secrets	boolean
Threats	boolean
Search	string
ConnectionType	integer
RepositoryId	string
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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
licenses3 fields	object
blockedLicensesCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction
blocked4 fields	array[object]
id	string
url	string
category	string
usageRestriction
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations3 fields	array[object]
isEnabled	boolean
type	string
config
package	object
totalPackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
vulnerablePackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskScore		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskBreakdown
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus3 fields	object
scanningState	string
uploadProgress		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scanProgress		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
metadata	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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
licenses3 fields	object
blockedLicensesCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction
blocked4 fields	array[object]
id	string
url	string
category	string
usageRestriction
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations3 fields	array[object]
isEnabled	boolean
type	string
config
package	object
totalPackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
vulnerablePackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskScore		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskBreakdown
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus3 fields	object
scanningState	string
uploadProgress		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scanProgress		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
metadata	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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
licenses3 fields	object
blockedLicensesCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
allowed4 fields	array[object]
id	string
url	string
category	string
usageRestriction
blocked4 fields	array[object]
id	string
url	string
category	string
usageRestriction
workflow4 fields	object
workflowId	string
workflowName	string
workflowIsDeleted	boolean
remediations3 fields	array[object]
isEnabled	boolean
type	string
config
package	object
totalPackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
vulnerablePackages		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskScore		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
riskBreakdown
scannedOn	date-time
stopTime	date-time
triggerEvent	string
errors	array[string]
scanStatus3 fields	object
scanningState	string
uploadProgress		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scanProgress		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
metadata	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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
everyNumberOfDays		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
everyNumberOfWeeks		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
everyNumberOfMonths		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
daysOfWeek	array[integer]
dayOfMonth		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
workflow
scans	array[object]

Response

Enumerate all CVEs across scanned packages

Auth

Query String

severities	string
search	string
page		pattern: `^-?(?:0\|[1-9]\d*)$`
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`

GET /api/v1/scans/cves

Responses

200

object	object
page		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
hasMoreItems	boolean
cves6 fields	array[object]
cve8 fields	object
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
aliases	array[string]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
packageId	string
packageName	string
packageVersion	string
ecosystem	string
repositories7 fields	array[object]
connection	string
repository	string
repositoryId	string
reference	string
scanned	date-time
scanIds	array[string]
stepSha256s	array[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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalScansFound		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
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		pattern: `^-?(?:0\|[1-9]\d*)$`
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
search	string
includeArchives	boolean
includePackages	boolean

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

Responses

200

array	array[object]
objectIdentityId	string
objectIdentityHash	string
scanResultId	string
progressUpload		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
progressScan		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
processingState	integer
exceptionDetails	string
created	date-time
discoveryStarted	date-time
discoveryStartedDaySec		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
streamingStartedTime	date-time
streamingCompletedTime	date-time
streamingTimeSpanMs		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scanCompletedTime	date-time
processingTimeSpanMs		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
processingFailedTime	date-time
processingRetryCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
objectTriggeredActions	array[object]
actionStatus	integer
triggeredActionType	integer
skippedScan	boolean
hasAppliedRemediation	boolean
hasAppliedSanitization	boolean
hasFailedSanitization	boolean
createdAt	date-time
lastUpdated	date-time
tenantId	string
objectRemediationActions	array[object]
scanResult
objectIdentity
versions	array[object]
id	string
scanId	string
storageId	string
scanWorkflowSnapshotId	string
metaDefenderCoreUrl	string
name	string
path	string
hash	string
objectStorageMetadata	string
size		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
lastModified	date-time
storageLocation	string
fileTypeCategory
pathForDisplay	string
extension	string

404

Not Found

Response

Get the file details view of a file by its scan result ID

Auth

Path Params

scanResultId string

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

Responses

200

object	object
fileId	string
scanResultId	string
parentId	string
displayName	string
filePath	string
fileType	string
size		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scannedOn	string
startTime	date-time
isArchive	boolean
isBlocked	boolean
blockedReason	string
isMalware	boolean
hasSecrets	boolean
isVulnerable	boolean
dlp
metascan
sbom5 fields	object
vulnerabilityCounts5 fields	object
critical		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
dependencyVulnerabilityCounts5 fields	object
critical		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
licenses
packages12 fields	array[object]
packageId	string
ecosystem	string
group	string
packageName	string
packageVersion	string
target	string
licenses
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts
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]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts
labels5 fields	array[object]
key	string
value	string
valueType	string
created	date-time
updated	date-time
latest
steps3 fields	array[object]
step		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
command	string
sha256	string

Response

Get the archive entries of a file by its scan result ID

Auth

Path Params

scanResultId string

Query String

page		pattern: `^-?(?:0\|[1-9]\d*)$`
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`

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

Responses

200

object	object
page		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
hasMoreItems	boolean
children18 fields	array[object]
fileId	string
scanResultId	string
parentId	string
displayName	string
filePath	string
fileType	string
size		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scannedOn	string
startTime	date-time
isArchive	boolean
isBlocked	boolean
blockedReason	string
isMalware	boolean
hasSecrets	boolean
isVulnerable	boolean
dlp
metascan
sbom5 fields	object
vulnerabilityCounts5 fields	object
critical		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
dependencyVulnerabilityCounts5 fields	object
critical		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
high		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
medium		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
low		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
unknown		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
licenses
packages12 fields	array[object]
packageId	string
ecosystem	string
group	string
packageName	string
packageVersion	string
target	string
licenses
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts
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]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts
labels5 fields	array[object]
key	string
value	string
valueType	string
created	date-time
updated	date-time
latest
steps3 fields	array[object]
step		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
command	string
sha256	string

Response

Get the dependencies of a file and its archive entries by its scan result ID

Rolls up the transitive dependencies reported for a file and every entry inside it when it is an archive. ReportedDependencyCount is what the scan engine reported; ItemizedDependencyCount is how many it itemized and therefore how many rows this endpoint can return.

Auth

Path Params

scanResultId string

Query String

page		pattern: `^-?(?:0\|[1-9]\d*)$`
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
search	string

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

Responses

200

object	object
page		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
hasMoreItems	boolean
directPackageCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalPackageCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
reportedDependencyCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
itemizedDependencyCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
distinctDependencyCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
vulnerabilityCounts
dependencies9 fields	array[object]
uid	string
ecosystem	string
group	string
packageName	string
packageVersion	string
parentPackageName	string
parentPackageVersion	string
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts

Response

Get the dependencies of one archive entry, including nested entries, by its child data ID

Same rollup as the file dependencies endpoint, scoped to one extracted file and any archive entries nested under it. ReportedDependencyCount is what the scan engine reported; ItemizedDependencyCount is how many it itemized and therefore how many rows this endpoint can return.

Auth

Path Params

scanResultId	string
childDataId	string

Query String

page		pattern: `^-?(?:0\|[1-9]\d*)$`
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
search	string

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

Responses

200

object	object
page		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
pageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
hasMoreItems	boolean
directPackageCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalPackageCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
reportedDependencyCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
itemizedDependencyCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
distinctDependencyCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
vulnerabilityCounts
dependencies9 fields	array[object]
uid	string
ecosystem	string
group	string
packageName	string
packageVersion	string
parentPackageName	string
parentPackageVersion	string
vulnerabilities9 fields	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
aliases	array[string]
epss
ratings4 fields	array[object]
method	string
score		pattern: `^-?(?:0\|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$`
number	number
severity	string
source
vulnerabilityCounts

Response

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

Auth

Query String

interval integer

periods

pattern: ^-?(?:0|[1-9]\d*)$

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
fixedCves6 fields	array[object]
cveId	string
severity	integer
repositoryId	string
repositoryName	string
packageName	string
packageVersion	string

500

Internal Server Error

Response

Manage Services Connections

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

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

/api/v1/services/references

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

/api/v1/services/{serviceId}

/api/v1/services/{serviceId}

/api/v1/services/{serviceId}

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

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 references by service ID and repository ID

Auth

Path Params

serviceId	string
repositoryId	string

Query String

Page		pattern: `^-?(?:0\|[1-9]\d*)$`
PageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
FilterValue	string
Cursor	string
Search	string	maxLength: 256 minLength: 0

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

Responses

200

object	object
references	array[string]
totalReferences		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer

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

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

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
type
details
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

409

Conflict

500

Internal Server Error

503

Service Unavailable

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		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
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
type
details
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

400

Bad Request

404

Not Found

409

Conflict

500

Internal Server Error

503

Service Unavailable

Response

Get a service by ID

Auth

Path Params

serviceId string

Query String

content	boolean
Search	string
Page		pattern: `^-?(?:0\|[1-9]\d*)$`
PageSize		pattern: `^-?(?:0\|[1-9]\d*)$`
FilterValue	string
Cursor	string
Search	string	maxLength: 256 minLength: 0
PrioritizedRepositoriesReference	string

GET /api/v1/services/{serviceId}

Responses

200

object	object
id	string
credentialsType		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
scanWorkflowId	string
domain	string
realTimeStatus	integer
name	string
vendorType	integer
protocolType	integer

400

Bad Request

404

Not Found

500

Internal Server Error

Response

Delete a service by ID

Auth

Path Params

serviceId string

DELETE /api/v1/services/{serviceId}

Responses

200

No response body

400

Bad Request

404

Not Found

500

Internal Server Error

Response

Get top-risky repositories for a service

Auth

Path Params

serviceId string

Query String

window	string
count		pattern: `^-?(?:0\|[1-9]\d*)$`

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

Responses

200

array	array[object]
connectionId	string
connectionName	string
repositoryId	string
repositoryName	string
riskScore		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer

400

Bad Request

500

Internal Server Error

Response

Get the base URL

Auth

GET /api/v1/network

Responses

200

object	object
baseUrl	string

500

Internal Server Error

Response

Set the base URL

Auth

Request Body

object	object
baseUrl	string

PUT /api/v1/network

Responses

200

No response body

400

Bad Request

409

Conflict

500

Internal Server Error

Response

Add a SMTP configuration

Auth

Request Body

object	object
host	string
port		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
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
port		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
senderAddress	string
senderName	string
domain	string
username	string
password	string
secureSocketOption
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
smtp
responseKey	string
responseMessage	string

400

Bad Request

Response

Add a Jira configuration

Auth

Request Body

object	object
name	string
apiKey	string
baseAddress	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
jiraEntries8 fields	array[object]
id	string
name	string
apiKey	string
baseAddress	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
jira
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
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

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
teamsConnections7 fields	array[object]
name	string
apiKey	string
webhookUrl	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
teams
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

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

Get the SSO configuration

Auth

GET /api/v1/sso

Responses

200

object	object
isEnabled	boolean
ssoType	integer
ssoProvider	integer
baseUrl	string
clientId	string
authority	string
identityProviderIssuer	string
identityProviderLoginUrl	string
identityProviderLogoutUrl	string
administratorRoleName	string
readonlyRoleName	string
roleMappings	array[object]
roleId	uuid
idpRoleName	string
hasClientSecret	boolean
hasIdentityProviderCertificate	boolean

404

Not Found

500

Internal Server Error

Response

Create or update the SSO configuration

Auth

Request Body

object	object
isEnabled	boolean
ssoType	integer
ssoProvider	integer
baseUrl	string
clientId	string
clientSecret	string
authority	string
identityProviderCertificate	string
identityProviderIssuer	string
identityProviderLoginUrl	string
identityProviderLogoutUrl	string
administratorRoleName	string
readonlyRoleName	string
roleMappings	array[object]
roleId	uuid
idpRoleName	string

PUT /api/v1/sso

Responses

200

No response body

400

Bad Request

404

Not Found

500

Internal Server Error

Response

Anonymous by design: the login page must decide whether to offer the SSO button before a session exists. It returns only a boolean — never provider, authority, or secret presence.

Auth

GET /api/v1/sso/enabled

Responses

200

object	object
isEnabled	boolean

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/register

/api/v1/users/{userId}/approve

/api/v1/users/{userId}/reject

/api/v1/user/permissions

/api/v1/users/{userId}

/api/v1/user/login

/api/v1/user/sso/session

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

/api/v1/user/token

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

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

/api/v1/user/sessions

/api/v1/user/sessions/terminate

Add a new user

The new password must meet the password policy. A rejected password returns 400 stating the exact limit.

Auth

Request Body

object	object
role
fullName	string
userName	string
password	string
email	string

POST /api/v1/users

Responses

200

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

400

Bad Request

Response

Get users

Auth

Query String

Type	integer
StartIndex		pattern: `^-?(?:0\|[1-9]\d*)$`
Count		pattern: `^-?(?:0\|[1-9]\d*)$`
SearchTerm	string

GET /api/v1/users

Responses

200

object	object
enumerateUsersDto2 fields	object
entries7 fields	array[object]
userId	string
username	string
fullName	string
email	string
role
showTutorial	boolean
tablePreferences2 fields	array[object]
tableId	string
columns3 fields	array[object]
columnKey	string
isVisible	boolean
order		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
totalCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
responseKey	string
responseMessage	string

400

Bad Request

Response

Update a user

Auth

Request Body

object	object
userId	string
role
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

Register a new pending user

The new password must meet the password policy. A rejected password returns 400 stating the exact limit.

Auth

Request Body

object	object
fullName	string
userName	string
password	string
email	string

POST /api/v1/users/register

Responses

200

object	object
userDto
responseKey	string
responseMessage	string

400

Bad Request

Response

Approve a pending user

Auth

Path Params

userId string

Request Body

object	object
role	integer

POST /api/v1/users/{userId}/approve

Responses

200

No response body

400

Bad Request

403

Forbidden

404

Not Found

409

Conflict

Response

Reject a pending user

Auth

Path Params

userId string

POST /api/v1/users/{userId}/reject

Responses

200

No response body

400

Bad Request

404

Not Found

409

Conflict

Response

Get current user

Auth

GET /api/v1/user

Responses

200

object	object
userDto
responseKey	string
responseMessage	string

400

Bad Request

Response

Update the current user's own profile

The new password must meet the password policy. A rejected password returns 400 stating the exact limit.

Auth

Request Body

object	object
fullName	string
email	string
currentPassword	string
newPassword	string
showTutorial	boolean
tablePreferences2 fields	array[object]
tableId	string
columns3 fields	array[object]
columnKey	string
isVisible	boolean
order		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer

PUT /api/v1/user

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

Get the calling principal's permission claims

Auth

GET /api/v1/user/permissions

Responses

200

array array[string]

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
responseKey	string
responseMessage	string

400

Bad Request

429

Too Many Requests

Response

Turns an identity-service session into an MDSSC one. The SSO callback leaves the platform token readable by the page, but MDSSC's own session lives in an HttpOnly cookie that script cannot write, so the exchange has to happen here.

Auth

Request Body

object	object
accessToken	string

POST /api/v1/user/sso/session

Responses

200

No response body

403

Forbidden

404

Not Found

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

PUT /api/v1/user/token

Responses

200

object	object
jwtToken
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

The new password must meet the password policy. A rejected password returns 400 stating the exact limit.

Auth

Request Body

object	object
newPassword	string
newPasswordConfirmation	string
secureToken	string
userId	string

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

Responses

200

object	object
user
responseKey	string
responseMessage	string

Response

List the current user's active sessions

Auth

GET /api/v1/user/sessions

Responses

200

array	array[object]
id	string
signedInAt	date-time
lastActiveAt	date-time
expiresAt	date-time
isCurrent	boolean

403

Forbidden

Response

Terminate the current user's sessions

Supply CurrentPassword to confirm the request.

Auth

Request Body

object	object
sessionId	string
includeCurrent	boolean
currentPassword	string

POST /api/v1/user/sessions/terminate

Responses

200

object	object
terminatedCount		pattern: `^-?(?:0\|[1-9]\d*)$`
integer	integer
currentSessionEnded	boolean

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

Response

Manage Versions

Get application version

Auth

Query String

api-version string

GET /api/version

Responses

200

object	object
version	string
responseKey	string
responseMessage	string

Response

Get application version

Auth

GET /api/v1/version

Responses

200

object	object
version	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}