MetaDefender Software Supply Chain API 3.1.0 3.1.0

/api/v1/audit

List audit events

Auth

Query String

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

GET /api/v1/audit

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/audit' \ --data Start={Start} \ --data Count={Count} \ --data LogType={LogType} \ --data CategoryType={CategoryType} \ --data LogLevel={LogLevel} \ --data SearchText={SearchText}
Copy

Responses

200

object	object
entries	array[object]
id	string
level	integer
properties	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

xxxxxxxxxx
 
{ "entries": [  {   "id": "{string}",   "level": "{integer}",   "properties": {    "logType": "{integer}",    "category": "{integer}",    "eventTimestamp": "{date-time}",    "userId": "{string}",    "userName": "{string}"   },   "renderedMessage": "{string}"  } ], "totalCount": "{int64}", "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Manage Export

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

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

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

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

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

Export a CycloneDX report for repository

Auth

Path Params

repoId string

Query String

Reference

string

pattern: ^[0-9]*$

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/export/cyclonedx/%7BrepoId%7D' \ --data Reference={Reference}
Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag	object
tag	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "fileStream": "{file}", "contentType": "{string}", "fileDownloadName": "{string}", "lastModified": "{date-time}", "entityTag": {  "tag": {   "buffer": "{string}",   "offset": "{int32}",   "length": "{int32}",   "value": "{string}",   "hasValue": "{boolean}"  },  "isWeak": "{boolean}" }, "enableRangeProcessing": "{boolean}"}
Copy

Export an SPDX v3 report for repository

Auth

Path Params

scanId string

Query String

format	string
version	string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/export/spdx/%7BscanId%7D' \ --data format={format} \ --data version={version}
Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag	object
tag	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "fileStream": "{file}", "contentType": "{string}", "fileDownloadName": "{string}", "lastModified": "{date-time}", "entityTag": {  "tag": {   "buffer": "{string}",   "offset": "{int32}",   "length": "{int32}",   "value": "{string}",   "hasValue": "{boolean}"  },  "isWeak": "{boolean}" }, "enableRangeProcessing": "{boolean}"}
Copy

Export a PDF report for all scans

Auth

Query String

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

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/export/pdf/all-scans' \ --data ProductAddress={ProductAddress} \ --data Type={Type} \ --data TimeFrame={TimeFrame} \ --data Vulnerabilities={Vulnerabilities} \ --data LicenseRisks={LicenseRisks} \ --data Status={Status} \ --data TriggerEvent={TriggerEvent} \ --data Workflow={Workflow} \ --data Connection={Connection} \ --data Secrets={Secrets} \ --data Threats={Threats} \ --data Search={Search} \ --data ConnectionType={ConnectionType}
Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag	object
tag	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "fileStream": "{file}", "contentType": "{string}", "fileDownloadName": "{string}", "lastModified": "{date-time}", "entityTag": {  "tag": {   "buffer": "{string}",   "offset": "{int32}",   "length": "{int32}",   "value": "{string}",   "hasValue": "{boolean}"  },  "isWeak": "{boolean}" }, "enableRangeProcessing": "{boolean}"}
Copy

Export a PDF overview report for repository

Auth

Path Params

scanId string

Query String

ProductAddress

string

pattern: ^[0-9]*$

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/export/pdf/overview/%7BscanId%7D' \ --data ProductAddress={ProductAddress}
Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag	object
tag	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "fileStream": "{file}", "contentType": "{string}", "fileDownloadName": "{string}", "lastModified": "{date-time}", "entityTag": {  "tag": {   "buffer": "{string}",   "offset": "{int32}",   "length": "{int32}",   "value": "{string}",   "hasValue": "{boolean}"  },  "isWeak": "{boolean}" }, "enableRangeProcessing": "{boolean}"}
Copy

Export a PDF SBOM report for repository

Auth

Path Params

scanId string

Query String

ProductAddress

string

pattern: ^[0-9]*$

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/export/pdf/sbom/%7BscanId%7D' \ --data ProductAddress={ProductAddress}
Copy

Responses

200

object	object
fileStream	file
contentType	string
fileDownloadName	string
lastModified	date-time
entityTag	object
tag	object
buffer	string
offset	int32
length	int32
value	string
hasValue	boolean
isWeak	boolean
enableRangeProcessing	boolean

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "fileStream": "{file}", "contentType": "{string}", "fileDownloadName": "{string}", "lastModified": "{date-time}", "entityTag": {  "tag": {   "buffer": "{string}",   "offset": "{int32}",   "length": "{int32}",   "value": "{string}",   "hasValue": "{boolean}"  },  "isWeak": "{boolean}" }, "enableRangeProcessing": "{boolean}"}
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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/externallogger'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No response
Copy

Add an external logger

Auth

Request Body

object	object
connectionSettings	object
serverAddress	string
port	int32
facility	integer
format	integer

POST /api/v1/externallogger

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/externallogger' \ --data '{  "connectionSettings": {    "serverAddress": "{string}",    "port": "{int32}",    "facility": "{integer}",    "format": "{integer}"  }}'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update an external logger

Auth

Path Params

id string

Request Body

object	object
connectionSettings	object
serverAddress	string
port	int32
facility	integer
format	integer

PUT /api/v1/externallogger/{id}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/externallogger/%7Bid%7D' \ --data '{  "connectionSettings": {    "serverAddress": "{string}",    "port": "{int32}",    "facility": "{integer}",    "format": "{integer}"  }}'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete an external logger

Auth

Path Params

id string

DELETE /api/v1/externallogger/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/externallogger/%7Bid%7D'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No 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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/global-label-keys'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "globalKeys": [  {   "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}"}
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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/global-label-keys' \ --data '{  "name": "{string}",  "description": "{string}",  "valueType": "{string}",  "options": [    "{array[string]...}"  ]}'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "globalKey": {  "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}"}
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}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/global-label-keys/%7Bid%7D' \ --data '{  "name": "{string}",  "description": "{string}",  "valueType": "{string}",  "options": [    "{array[string]...}"  ]}'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "globalKey": {  "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}"}
Copy

Deletes an global label key

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/global-label-keys/%7Bid%7D'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Manage Licenses

/api/v1/licenses/online

Activate an online license

Auth

Request Body

object	object
key	string

POST /api/v1/licenses/online

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/licenses/online' \ --data '{  "key": "{string}"}'
Copy

Responses

200

object	object
result	integer
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseMessage": "{string}"}
Copy

Get licenses

Auth

GET /api/v1/licenses

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/licenses'
Copy

Responses

200

object	object
result	integer
license	object
productId	string
productName	string
expiration	int64
deploymentId	string
activationKey	string
licenseContent	string
maxDevelopers	int32
responseMessage	string

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "license": {  "productId": "{string}",  "productName": "{string}",  "expiration": "{int64}",  "deploymentId": "{string}",  "activationKey": "{string}",  "licenseContent": "{string}",  "maxDevelopers": "{int32}" }, "responseMessage": "{string}"}
Copy

Remove licenses

Auth

DELETE /api/v1/licenses

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/licenses'
Copy

Responses

200

object	object
result	integer
responseMessage	string

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseMessage": "{string}"}
Copy

Manage Opswat Central Management Ocm

Get an OCM instance

Auth

GET /api/v1/ocm

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/ocm'
Copy

Responses

200

object	object
ocmInformation	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
enrollStatus	integer
lastServerConnection	int64
lastConfigurationSync	int64
connectionStatus	integer
createdAt	date-time
lastUpdated	date-time
tenantId	string
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "ocmInformation": {  "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}",  "enrollStatus": "{integer}",  "lastServerConnection": "{int64}",  "lastConfigurationSync": "{int64}",  "connectionStatus": "{integer}",  "createdAt": "{date-time}",  "lastUpdated": "{date-time}",  "tenantId": "{string}" }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Update an OCM instance

Auth

Request Body

object	object
serverApi	string
regCode	string

PUT /api/v1/ocm

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/ocm' \ --data '{  "serverApi": "{string}",  "regCode": "{string}"}'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Delete an OCM instance

Auth

DELETE /api/v1/ocm

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/ocm'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Manage Packages

/api/v1/packages

/api/v1/packages/versions

/api/v1/packages/{id}

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

/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 list of packages based on search criteria

Auth

Query String

Name	string	pattern: `^[0-9]*$`
Ecosystem	string	pattern: `^[0-9]*$`
Version	string	pattern: `^[0-9]*$`
Vulnerabilities	array
LicenseRisks	array
Connection	string	pattern: `^[0-9]*$`
Repository	string	pattern: `^[0-9]*$`
Reference	string	pattern: `^[0-9]*$`
ScanId	string	pattern: `^[0-9]*$`
StepSha256	string	pattern: `^[0-9]*$`
Search	string	pattern: `^[0-9]*$`

GET /api/v1/packages

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/packages' \ --data Name={Name} \ --data Ecosystem={Ecosystem} \ --data Version={Version} \ --data Vulnerabilities={Vulnerabilities} \ --data LicenseRisks={LicenseRisks} \ --data Connection={Connection} \ --data Repository={Repository} \ --data Reference={Reference} \ --data ScanId={ScanId} \ --data StepSha256={StepSha256} \ --data Search={Search}
Copy

Responses

200

object	object
packages	array[object]
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
licenses	object
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
repositories	array[object]
connection	string
repository	string
repositoryId	string
reference	string
scanned	date-time
scanIds	array[string]
stepSha256s	array[string]
hashes	array[object]
sha256	string
fileName	string
vulnerabilities	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
dependencies	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
vulnerabilityCounts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
supplierName	string
releaseDate	date-time
labels	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
responseKey	string
responseMessage	string

Expand

Response

xxxxxxxxxx
 
{
 "packages": [...],
 "responseKey": "{string}", "responseMessage": "{string}"}
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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/packages/versions' \ --data ecosystem={ecosystem} \ --data packageName={packageName}
Copy

Responses

200

object	object
packageName	string
ecosystem	string
versions	array[object]
version	string
vulnerabilities	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
supplierName	string
releaseDate	date-time
dependencies	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
vulnerabilityCounts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses	object
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
responseKey	string
responseMessage	string

Expand

Response

xxxxxxxxxx
 
{ "packageName": "{string}", "ecosystem": "{string}", "versions": [  {   "version": "{string}",   "vulnerabilities": [    {     "id": "{string}",     "fixedVersions": [      "{array[string]...}"     ],     "severity": "{integer}",     "source": "{string}",     "cwes": [      "{array[string]...}"     ]    }   ],   "supplierName": "{string}",   "releaseDate": "{date-time}",   "dependencies": [    {     "ecosystem": "{string}",     "group": "{string}",     "packageName": "{string}",     "packageVersion": "{string}",     "vulnerabilities": [      {       "id": "{string}",       "severity": "{string}",       "source": "{string}",       "fixedVersions": [        "{array[string]...}"       ],       "cwes": [        "{array[string]...}"       ],       "type": "{string}"      }     ],     "vulnerabilityCounts": {      "critical": "{int32}",      "high": "{int32}",      "medium": "{int32}",      "low": "{int32}",      "unknown": "{int32}"     }    }   ],   "licenses": {    "allowed": [     {      "id": "{string}",      "url": "{string}",      "category": "{string}",      "usageRestriction": {       "permissions": [        "{array[string]...}"       ],       "conditions": [        "{array[string]...}"       ],       "limitations": [        "{array[string]...}"       ]      }     }    ],    "blocked": [     "{array...}"    ]   }  } ], "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Expand

Retrieves a package by ID

Auth

Path Params

id string

GET /api/v1/packages/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/packages/%7Bid%7D'
Copy

Responses

200

object	object
package	object
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
licenses	object
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
repositories	array[object]
connection	string
repository	string
repositoryId	string
reference	string
scanned	date-time
scanIds	array[string]
stepSha256s	array[string]
hashes	array[object]
sha256	string
fileName	string
vulnerabilities	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
dependencies	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
vulnerabilityCounts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
supplierName	string
releaseDate	date-time
labels	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
responseKey	string
responseMessage	string

Expand

Response

xxxxxxxxxx
 
{
 "package": {...},
 "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Retrieves CVEs associated with a specific package

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/packages/%7Bid%7D/cves'
Copy

Responses

200

object	object
cves	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "cves": [  {   "id": "{string}",   "fixedVersions": [    "{array[string]...}"   ],   "severity": "{integer}",   "source": "{string}",   "cwes": [    "{array[string]...}"   ]  } ], "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Retrieves all labels for a specific package

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/packages/%7Bid%7D/labels'
Copy

Responses

200

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

Response

xxxxxxxxxx
 
{ "labels": [  {   "Key": "{string}",   "Value": "{string}",   "ValueType": "{string}",   "Created": "{date-time}",   "Updated": "{date-time}"  } ], "responseKey": "{string}", "responseMessage": "{string}"}
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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/packages/%7Bid%7D/labels' \ --data '{  "Key": "{string}",  "Value": "{string}",  "ValueType": "{string}",  "Created": "{date-time}",  "Updated": "{date-time}"}'
Copy

Responses

200

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

Response

xxxxxxxxxx
 
{ "label": {  "Key": "{string}",  "Value": "{string}",  "ValueType": "{string}",  "Created": "{date-time}",  "Updated": "{date-time}" }, "responseKey": "{string}", "responseMessage": "{string}"}
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}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/packages/%7Bid%7D/labels/%7Bkey%7D' \ --data '{  "value": "{string}",  "valueType": "{string}"}'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Deletes a label from a package

Auth

Path Params

id	string
key	string

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/packages/%7Bid%7D/labels/%7Bkey%7D'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Searches for packages by label key and optionally value

Auth

Query String

key	string
value	string

GET /api/v1/packages/search/labels

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/packages/search/labels' \ --data key={key} \ --data value={value}
Copy

Responses

200

object	object
packages	array[object]
id	string
name	string
version	string
ecosystem	string
archive	boolean
executable	boolean
uid	string
licenses	object
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
repositories	array[object]
connection	string
repository	string
repositoryId	string
reference	string
scanned	date-time
scanIds	array[string]
stepSha256s	array[string]
hashes	array[object]
sha256	string
fileName	string
vulnerabilities	array[object]
id	string
fixedVersions	array[string]
severity	integer
source	string
cwes	array[string]
dependencies	array[object]
ecosystem	string
group	string
packageName	string
packageVersion	string
vulnerabilities	array[object]
id	string
severity	string
source	string
fixedVersions	array[string]
cwes	array[string]
type	string
vulnerabilityCounts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
supplierName	string
releaseDate	date-time
labels	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
responseKey	string
responseMessage	string

Expand

Response

xxxxxxxxxx
 
{
 "packages": [...],
 "responseKey": "{string}", "responseMessage": "{string}"}
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

List projects

Auth

GET /api/v1/projects

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/projects'
Copy

Responses

200

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

Response

xxxxxxxxxx
 
[ {  "id": "{string}",  "name": "{string}",  "workflowIds": [   "{array[string]...}"  ],  "storageIds": [   "{array[string]...}"  ] }]
Copy

Create a project

Auth

Request Body

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

POST /api/v1/projects

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/projects' \ --data '{  "name": "{string}",  "workflowIds": [    "{array[string]...}"  ],  "storageIds": [    "{array[string]...}"  ]}'
Copy

Responses

200

object	object
project	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "project": {  "id": "{string}",  "name": "{string}",  "workflowIds": [   "{array[string]...}"  ],  "storageIds": [   "{array[string]...}"  ] }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Get a project by ID

Auth

Path Params

id string

GET /api/v1/projects/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/projects/%7Bid%7D'
Copy

Responses

200

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

404

Not Found

Response

xxxxxxxxxx
 
{ "id": "{string}", "name": "{string}", "workflowIds": [  "{array[string]...}" ], "storageIds": [  "{array[string]...}" ]}
Copy

Update a project

Auth

Path Params

id string

Request Body

object	object
name	string	maxLength: 50

PUT /api/v1/projects/{id}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/projects/%7Bid%7D' \ --data '{  "name": "{string}"}'
Copy

Responses

200

object	object
project	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "project": {  "id": "{string}",  "name": "{string}",  "workflowIds": [   "{array[string]...}"  ],  "storageIds": [   "{array[string]...}"  ] }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Delete a project

Auth

Path Params

id string

DELETE /api/v1/projects/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/projects/%7Bid%7D'
Copy

Responses

200

object	object
project	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "project": {  "id": "{string}",  "name": "{string}",  "workflowIds": [   "{array[string]...}"  ],  "storageIds": [   "{array[string]...}"  ] }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Attach workflows to a project

Auth

Path Params

id string

Request Body

object	object
ids	array[string]

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/projects/%7Bid%7D/workflows/attach' \ --data '{  "ids": [    "{array[string]...}"  ]}'
Copy

Responses

200

object	object
project	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "project": {  "id": "{string}",  "name": "{string}",  "workflowIds": [   "{array[string]...}"  ],  "storageIds": [   "{array[string]...}"  ] }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Detach workflows from a project

Auth

Path Params

id string

Request Body

object	object
ids	array[string]

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/projects/%7Bid%7D/workflows/detach' \ --data '{  "ids": [    "{array[string]...}"  ]}'
Copy

Responses

200

object	object
project	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "project": {  "id": "{string}",  "name": "{string}",  "workflowIds": [   "{array[string]...}"  ],  "storageIds": [   "{array[string]...}"  ] }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/projects/%7Bid%7D/storages/attach' \ --data '{  "ids": [    "{array[string]...}"  ]}'
Copy

Responses

200

object	object
project	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "project": {  "id": "{string}",  "name": "{string}",  "workflowIds": [   "{array[string]...}"  ],  "storageIds": [   "{array[string]...}"  ] }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/projects/%7Bid%7D/storages/detach' \ --data '{  "ids": [    "{array[string]...}"  ]}'
Copy

Responses

200

object	object
project	object
id	string
name	string
workflowIds	array[string]
storageIds	array[string]
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "project": {  "id": "{string}",  "name": "{string}",  "workflowIds": [   "{array[string]...}"  ],  "storageIds": [   "{array[string]...}"  ] }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/realtime/%7BstorageId%7D/enable' \ --data '{  "repositories": [    {      "repositoryId": "{string}",      "repositoryName": "{string}"    }  ],  "connection": "{string}",  "workflowId": "{string}"}'
Copy

Responses

207

Multi-Status

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

400

Bad Request

409

Conflict

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Disable real-time protection for connection

Auth

Path Params

storageId string

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

xxxxxxxxxx
 
curl --request PATCH \ --url 'https://opswat.developerhub.io/api/v1/realtime/%7BstorageId%7D/disable'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No response
Copy

Disable real-time protection for repository

Auth

Path Params

storageId	string
repositoryId	string

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

xxxxxxxxxx
 
curl --request PATCH \ --url 'https://opswat.developerhub.io/api/v1/realtime/%7BstorageId%7D/%7BrepositoryId%7D/disable'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No response
Copy

List connections with real-time protection enabled

Auth

GET /api/v1/realtime

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/realtime'
Copy

Responses

200

object	object
storages	array[object]
id	string
name	string
storageType	object
name	string
categoryType	integer
protocolType	integer
vendorType	integer
storageStatus	object
message	string
statusType	integer

Response

xxxxxxxxxx
 
{ "storages": [  {   "id": "{string}",   "name": "{string}",   "storageType": {    "name": "{string}",    "categoryType": "{integer}",    "protocolType": "{integer}",    "vendorType": "{integer}"   },   "storageStatus": {    "message": "{string}",    "statusType": "{integer}"   }  } ]}
Copy

List ongoing real-time protection scans for connection

Auth

Path Params

storageId string

GET /api/v1/realtime/{storageId}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/realtime/%7BstorageId%7D'
Copy

Responses

200

object	object
storageId	string
realTimeScans	array[object]
scanId	string
repositoryId	string
repositoryName	string
scanningState	integer
workflowId	string
scanInformation	object
totalFiles	int32
malware	int32
secret	int32
blockedFiles	int32
vulnerabilityIssues	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses	object
blockedLicensesCount	int32
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
package	object
totalPackages	int32
vulnerablePackages	int32

Expand

Response

xxxxxxxxxx
 
{ "storageId": "{string}", "realTimeScans": [  {   "scanId": "{string}",   "repositoryId": "{string}",   "repositoryName": "{string}",   "scanningState": "{integer}",   "workflowId": "{string}"  } ], "scanInformation": {  "totalFiles": "{int32}",  "malware": "{int32}",  "secret": "{int32}",  "blockedFiles": "{int32}",  "vulnerabilityIssues": {   "critical": "{int32}",   "high": "{int32}",   "medium": "{int32}",   "low": "{int32}",   "unknown": "{int32}"  },  "licenses": {   "blockedLicensesCount": "{int32}",   "allowed": [    {     "id": "{string}",     "url": "{string}",     "category": "{string}",     "usageRestriction": {      "permissions": [       "{array[string]...}"      ],      "conditions": [       "{array[string]...}"      ],      "limitations": [       "{array[string]...}"      ]     }    }   ],   "blocked": [    "{array...}"   ]  },  "package": {   "totalPackages": "{int32}",   "vulnerablePackages": "{int32}"  } }}
Copy

Expand

Delete real-time scan protection for connection

Auth

Path Params

storageId string

Query String

forceDelete boolean

DELETE /api/v1/realtime/{storageId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/realtime/%7BstorageId%7D' \ --data forceDelete={forceDelete}
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete real-time scan protection for repository

Auth

Path Params

storageId	string
repositoryId	string

Query String

forceDelete boolean

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/realtime/%7BstorageId%7D/%7BrepositoryId%7D' \ --data forceDelete={forceDelete}
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No response
Copy

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}

Get all scan configurations

Auth

GET /api/v1/scan-configurations

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scan-configurations'
Copy

Responses

200

object	object
Workflows	array[object]
id	string
scanPoolId	string
rules	array[string]
type	integer
name	string
scanPool	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances	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
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Expand

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "Workflows": [  {   "id": "{string}",   "scanPoolId": "{string}",   "rules": [    "{array[string]...}"   ],   "type": "{integer}",   "name": "{string}",   "scanPool": {    "id": "{string}",    "name": "{string}",    "scanPoolType": "{integer}",    "isDefault": "{boolean}",    "scanInstances": [     {      "id": "{string}",      "scanPoolId": "{string}",      "url": "{string}",      "apiKey": "{string}",      "timeout": "{string}"     }    ]   },   "userAgent": "{string}",   "filters": {    "id": "{string}",    "minimumSize": "{int64}",    "maximumSize": "{int64}",    "minimumDateTime": "{date-time}",    "maximumDateTime": "{date-time}"   }  } ], "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/scan-configurations' \ --data '{  "name": "{string}",  "scanPoolId": "{string}",  "rules": [    "{array[string]...}"  ],  "userAgent": "{string}"}'
Copy

Responses

200

object	object
id	string
scanPoolId	string
rules	array[string]
type	integer
name	string
scanPool	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances	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
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time

Expand

400

Bad Request

502

Bad Gateway

Response

xxxxxxxxxx
 
{ "id": "{string}", "scanPoolId": "{string}", "rules": [  "{array[string]...}" ], "type": "{integer}", "name": "{string}", "scanPool": {  "id": "{string}",  "name": "{string}",  "scanPoolType": "{integer}",  "isDefault": "{boolean}",  "scanInstances": [   {    "id": "{string}",    "scanPoolId": "{string}",    "url": "{string}",    "apiKey": "{string}",    "timeout": "{string}"   }  ] }, "userAgent": "{string}", "filters": {  "id": "{string}",  "minimumSize": "{int64}",  "maximumSize": "{int64}",  "minimumDateTime": "{date-time}",  "maximumDateTime": "{date-time}" }}
Copy

Get a scan configuration by ID

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scan-configurations/%7Bid%7D'
Copy

Responses

200

object	object
Workflow	object
id	string
scanPoolId	string
rules	array[string]
type	integer
name	string
scanPool	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances	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
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Expand

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "Workflow": {  "id": "{string}",  "scanPoolId": "{string}",  "rules": [   "{array[string]...}"  ],  "type": "{integer}",  "name": "{string}",  "scanPool": {   "id": "{string}",   "name": "{string}",   "scanPoolType": "{integer}",   "isDefault": "{boolean}",   "scanInstances": [    {     "id": "{string}",     "scanPoolId": "{string}",     "url": "{string}",     "apiKey": "{string}",     "timeout": "{string}"    }   ]  },  "userAgent": "{string}",  "filters": {   "id": "{string}",   "minimumSize": "{int64}",   "maximumSize": "{int64}",   "minimumDateTime": "{date-time}",   "maximumDateTime": "{date-time}"  } }, "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

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}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/scan-configurations/%7Bid%7D' \ --data '{  "name": "{string}",  "scanPoolId": "{string}",  "rules": [    "{array[string]...}"  ],  "userAgent": "{string}"}'
Copy

Responses

200

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

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Delete a scan configuration

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/scan-configurations/%7Bid%7D'
Copy

Responses

200

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

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get all scan configurations by scan pool ID

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scan-configurations/scan-pools/%7Bid%7D'
Copy

Responses

200

object	object
Workflows	array[object]
id	string
scanPoolId	string
rules	array[string]
type	integer
name	string
scanPool	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances	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
filters	object
id	string
minimumSize	int64
maximumSize	int64
minimumDateTime	date-time
maximumDateTime	date-time
result	integer
responseKey	string
responseMessage	string
responseMessageParams	object
*	string

Expand

400

Bad Request

Response

xxxxxxxxxx
 
{ "Workflows": [  {   "id": "{string}",   "scanPoolId": "{string}",   "rules": [    "{array[string]...}"   ],   "type": "{integer}",   "name": "{string}",   "scanPool": {    "id": "{string}",    "name": "{string}",    "scanPoolType": "{integer}",    "isDefault": "{boolean}",    "scanInstances": [     {      "id": "{string}",      "scanPoolId": "{string}",      "url": "{string}",      "apiKey": "{string}",      "timeout": "{string}"     }    ]   },   "userAgent": "{string}",   "filters": {    "id": "{string}",    "minimumSize": "{int64}",    "maximumSize": "{int64}",    "minimumDateTime": "{date-time}",    "maximumDateTime": "{date-time}"   }  } ], "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/scan-instances' \ --data '{  "scanPoolId": "{string}",  "url": "{string}",  "apiKey": "{string}",  "timeout": "{string}",  "scanInstanceType": "{integer}"}'
Copy

Responses

200

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

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "scanInstanceId": "{string}", "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get a scan instance by ID

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scan-instances/%7Bid%7D'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "scanInstance": {  "id": "{string}",  "scanPoolId": "{string}",  "url": "{string}",  "apiKey": "{string}",  "timeout": "{string}" }, "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

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}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/scan-instances/%7Bid%7D' \ --data '{  "url": "{string}",  "apiKey": "{string}",  "timeout": "{string}"}'
Copy

Responses

200

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

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Delete a scan instance

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/scan-instances/%7Bid%7D'
Copy

Responses

200

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

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Manage Scan Pools

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

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

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

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

Get scan pools

Auth

GET /api/v1/scan-pools

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scan-pools'
Copy

Responses

200

object	object
scanPools	array[object]
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances	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

xxxxxxxxxx
 
{ "scanPools": [  {   "id": "{string}",   "name": "{string}",   "scanPoolType": "{integer}",   "isDefault": "{boolean}",   "scanInstances": [    {     "id": "{string}",     "scanPoolId": "{string}",     "url": "{string}",     "apiKey": "{string}",     "timeout": "{string}"    }   ]  } ], "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Add a new scan pool

Auth

Request Body

object	object
name	string
scanPoolType	integer

POST /api/v1/scan-pools

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/scan-pools' \ --data '{  "name": "{string}",  "scanPoolType": "{integer}"}'
Copy

Responses

200

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

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "scanPoolId": "{string}", "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get a scan pool by ID

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scan-pools/%7Bid%7D'
Copy

Responses

200

object	object
scanPool	object
id	string
name	string
scanPoolType	integer
isDefault	boolean
scanInstances	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

xxxxxxxxxx
 
{ "scanPool": {  "id": "{string}",  "name": "{string}",  "scanPoolType": "{integer}",  "isDefault": "{boolean}",  "scanInstances": [   {    "id": "{string}",    "scanPoolId": "{string}",    "url": "{string}",    "apiKey": "{string}",    "timeout": "{string}"   }  ] }, "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Update an existing scan pool

Auth

Path Params

id string

Request Body

object	object
name	string

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

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/scan-pools/%7Bid%7D' \ --data '{  "name": "{string}"}'
Copy

Responses

200

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

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Delete a scan pool

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/scan-pools/%7Bid%7D'
Copy

Responses

200

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

400

Bad Request

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get all rules from a scan pool

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scan-pools/%7Bid%7D/rules'
Copy

Responses

200

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

400

Bad Request

Response

xxxxxxxxxx
 
[ {  "name": "{string}",  "user_agents": [   "{array[string]...}"  ] }]
Copy

Manage Scans

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

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

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

/api/v1/scans/schedules

/api/v1/scans/cleanup

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

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

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

Enumerate scan results

Auth

Query String

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

GET /api/v1/scans

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans' \ --data Type={Type} \ --data TimeFrame={TimeFrame} \ --data Vulnerabilities={Vulnerabilities} \ --data LicenseRisks={LicenseRisks} \ --data Status={Status} \ --data TriggerEvent={TriggerEvent} \ --data Workflow={Workflow} \ --data Connection={Connection} \ --data Secrets={Secrets} \ --data Threats={Threats} \ --data Search={Search} \ --data ConnectionType={ConnectionType}
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/scans' \ --data '{  "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}"}'
Copy

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

xxxxxxxxxx
 
{ "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}"}
Copy

Delete multiple scans by their scan IDs

Auth

Request Body

array array[string]

DELETE /api/v1/scans

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/scans' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

No response body

400

Bad Request

500

Internal Server Error

Response

xxxxxxxxxx
 
No response
Copy

Get scan results by scan ID

Auth

Path Params

id string

GET /api/v1/scans/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/%7Bid%7D'
Copy

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})?$`
vulnerabilityIssues	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
scanStatus	integer
discoveryStatus	integer
errors	array[string]
blockedLicensesCount	int32
infectedFiles	int32
filesWithSecrets	int32

Expand

404

Not Found

Response

xxxxxxxxxx
 
{ "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}", "vulnerabilityIssues": {  "critical": "{int32}",  "high": "{int32}",  "medium": "{int32}",  "low": "{int32}",  "unknown": "{int32}" }, "scanStatus": "{integer}", "discoveryStatus": "{integer}", "errors": [  "{array[string]...}" ], "blockedLicensesCount": "{int32}", "infectedFiles": "{int32}", "filesWithSecrets": "{int32}"}
Copy

Stop a scan

Auth

Path Params

id string

POST /api/v1/scans/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/scans/%7Bid%7D'
Copy

Responses

200

object	object
statusCode	int32

Response

xxxxxxxxxx
 
{ "statusCode": "{int32}"}
Copy

Enumerate all latest scan results

Auth

Query String

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

GET /api/v1/scans/latest

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/latest' \ --data Type={Type} \ --data TimeFrame={TimeFrame} \ --data Vulnerabilities={Vulnerabilities} \ --data LicenseRisks={LicenseRisks} \ --data Status={Status} \ --data TriggerEvent={TriggerEvent} \ --data Workflow={Workflow} \ --data Connection={Connection} \ --data Secrets={Secrets} \ --data Threats={Threats} \ --data Search={Search} \ --data ConnectionType={ConnectionType}
Copy

Responses

200

array	array[object]
scanId	string
repository	object
connectionId	string
connectionName	string
protocolType	integer
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryMetadata	string
scanInformation	object
malware	boolean
secret	boolean
vulnerabilityIssues	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses	object
blockedLicensesCount	int32
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow	object
workflowId	string
workflowName	string
workflowType	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]
scanStatus	object
scanningState	string
uploadProgress	int32
scanProgress	int32

Expand

404

Not Found

Response

xxxxxxxxxx
 
[ {  "scanId": "{string}",  "repository": {   "connectionId": "{string}",   "connectionName": "{string}",   "protocolType": "{integer}",   "repositoryId": "{string}",   "repositoryName": "{string}",   "repositoryReference": "{string}",   "repositoryMetadata": "{string}"  },  "scanInformation": {   "malware": "{boolean}",   "secret": "{boolean}",   "vulnerabilityIssues": {    "critical": "{int32}",    "high": "{int32}",    "medium": "{int32}",    "low": "{int32}",    "unknown": "{int32}"   },   "licenses": {    "blockedLicensesCount": "{int32}",    "allowed": [     {      "id": "{string}",      "url": "{string}",      "category": "{string}",      "usageRestriction": {       "permissions": [        "{array[string]...}"       ],       "conditions": [        "{array[string]...}"       ],       "limitations": [        "{array[string]...}"       ]      }     }    ],    "blocked": [     "{array...}"    ]   },   "workflow": {    "workflowId": "{string}",    "workflowName": "{string}",    "workflowType": "{string}",    "workflowIsDeleted": "{boolean}",    "remediations": [     {      "isEnabled": "{boolean}",      "type": "{string}",      "config": "{}"     }    ]   },   "package": {    "totalPackages": "{int32}",    "vulnerablePackages": "{int32}"   },   "scannedOn": "{date-time}",   "stopTime": "{date-time}",   "triggerEvent": "{string}",   "errors": [    "{array[string]...}"   ]  },  "scanStatus": {   "scanningState": "{string}",   "uploadProgress": "{int32}",   "scanProgress": "{int32}"  } }]
Copy

Expand

Enumerate all latest scan results by service ID

Auth

Path Params

serviceId string

Query String

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

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/%7BserviceId%7D/latest' \ --data Type={Type} \ --data TimeFrame={TimeFrame} \ --data Vulnerabilities={Vulnerabilities} \ --data LicenseRisks={LicenseRisks} \ --data Status={Status} \ --data TriggerEvent={TriggerEvent} \ --data Workflow={Workflow} \ --data Connection={Connection} \ --data Secrets={Secrets} \ --data Threats={Threats} \ --data Search={Search} \ --data ConnectionType={ConnectionType}
Copy

Responses

200

object	object
scanId	string
repository	object
connectionId	string
connectionName	string
protocolType	integer
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryMetadata	string
scanInformation	object
malware	boolean
secret	boolean
vulnerabilityIssues	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses	object
blockedLicensesCount	int32
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow	object
workflowId	string
workflowName	string
workflowType	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]
scanStatus	object
scanningState	string
uploadProgress	int32
scanProgress	int32

Expand

Response

xxxxxxxxxx
 
{ "scanId": "{string}", "repository": {  "connectionId": "{string}",  "connectionName": "{string}",  "protocolType": "{integer}",  "repositoryId": "{string}",  "repositoryName": "{string}",  "repositoryReference": "{string}",  "repositoryMetadata": "{string}" }, "scanInformation": {  "malware": "{boolean}",  "secret": "{boolean}",  "vulnerabilityIssues": {   "critical": "{int32}",   "high": "{int32}",   "medium": "{int32}",   "low": "{int32}",   "unknown": "{int32}"  },  "licenses": {   "blockedLicensesCount": "{int32}",   "allowed": [    {     "id": "{string}",     "url": "{string}",     "category": "{string}",     "usageRestriction": {      "permissions": [       "{array[string]...}"      ],      "conditions": [       "{array[string]...}"      ],      "limitations": [       "{array[string]...}"      ]     }    }   ],   "blocked": [    "{array...}"   ]  },  "workflow": {   "workflowId": "{string}",   "workflowName": "{string}",   "workflowType": "{string}",   "workflowIsDeleted": "{boolean}",   "remediations": [    {     "isEnabled": "{boolean}",     "type": "{string}",     "config": "{}"    }   ]  },  "package": {   "totalPackages": "{int32}",   "vulnerablePackages": "{int32}"  },  "scannedOn": "{date-time}",  "stopTime": "{date-time}",  "triggerEvent": "{string}",  "errors": [   "{array[string]...}"  ] }, "scanStatus": {  "scanningState": "{string}",  "uploadProgress": "{int32}",  "scanProgress": "{int32}" }}
Copy

Expand

Get scan overview by scan ID

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/%7Bid%7D/overview'
Copy

Responses

200

array	array[object]
scanId	string
repository	object
connectionId	string
connectionName	string
protocolType	integer
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryMetadata	string
scanInformation	object
malware	boolean
secret	boolean
vulnerabilityIssues	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses	object
blockedLicensesCount	int32
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow	object
workflowId	string
workflowName	string
workflowType	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]
scanStatus	object
scanningState	string
uploadProgress	int32
scanProgress	int32

Expand

Response

xxxxxxxxxx
 
[ {  "scanId": "{string}",  "repository": {   "connectionId": "{string}",   "connectionName": "{string}",   "protocolType": "{integer}",   "repositoryId": "{string}",   "repositoryName": "{string}",   "repositoryReference": "{string}",   "repositoryMetadata": "{string}"  },  "scanInformation": {   "malware": "{boolean}",   "secret": "{boolean}",   "vulnerabilityIssues": {    "critical": "{int32}",    "high": "{int32}",    "medium": "{int32}",    "low": "{int32}",    "unknown": "{int32}"   },   "licenses": {    "blockedLicensesCount": "{int32}",    "allowed": [     {      "id": "{string}",      "url": "{string}",      "category": "{string}",      "usageRestriction": {       "permissions": [        "{array[string]...}"       ],       "conditions": [        "{array[string]...}"       ],       "limitations": [        "{array[string]...}"       ]      }     }    ],    "blocked": [     "{array...}"    ]   },   "workflow": {    "workflowId": "{string}",    "workflowName": "{string}",    "workflowType": "{string}",    "workflowIsDeleted": "{boolean}",    "remediations": [     {      "isEnabled": "{boolean}",      "type": "{string}",      "config": "{}"     }    ]   },   "package": {    "totalPackages": "{int32}",    "vulnerablePackages": "{int32}"   },   "scannedOn": "{date-time}",   "stopTime": "{date-time}",   "triggerEvent": "{string}",   "errors": [    "{array[string]...}"   ]  },  "scanStatus": {   "scanningState": "{string}",   "uploadProgress": "{int32}",   "scanProgress": "{int32}"  } }]
Copy

Expand

Enumerate all scan results by repository ID

Auth

Path Params

serviceId	string
repositoryId	string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/%7BserviceId%7D/%7BrepositoryId%7D'
Copy

Responses

200

array	array[object]
scanId	string
repository	object
connectionId	string
connectionName	string
protocolType	integer
repositoryId	string
repositoryName	string
repositoryReference	string
repositoryMetadata	string
scanInformation	object
malware	boolean
secret	boolean
vulnerabilityIssues	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
licenses	object
blockedLicensesCount	int32
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
workflow	object
workflowId	string
workflowName	string
workflowType	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]
scanStatus	object
scanningState	string
uploadProgress	int32
scanProgress	int32

Expand

Response

xxxxxxxxxx
 
[ {  "scanId": "{string}",  "repository": {   "connectionId": "{string}",   "connectionName": "{string}",   "protocolType": "{integer}",   "repositoryId": "{string}",   "repositoryName": "{string}",   "repositoryReference": "{string}",   "repositoryMetadata": "{string}"  },  "scanInformation": {   "malware": "{boolean}",   "secret": "{boolean}",   "vulnerabilityIssues": {    "critical": "{int32}",    "high": "{int32}",    "medium": "{int32}",    "low": "{int32}",    "unknown": "{int32}"   },   "licenses": {    "blockedLicensesCount": "{int32}",    "allowed": [     {      "id": "{string}",      "url": "{string}",      "category": "{string}",      "usageRestriction": {       "permissions": [        "{array[string]...}"       ],       "conditions": [        "{array[string]...}"       ],       "limitations": [        "{array[string]...}"       ]      }     }    ],    "blocked": [     "{array...}"    ]   },   "workflow": {    "workflowId": "{string}",    "workflowName": "{string}",    "workflowType": "{string}",    "workflowIsDeleted": "{boolean}",    "remediations": [     {      "isEnabled": "{boolean}",      "type": "{string}",      "config": "{}"     }    ]   },   "package": {    "totalPackages": "{int32}",    "vulnerablePackages": "{int32}"   },   "scannedOn": "{date-time}",   "stopTime": "{date-time}",   "triggerEvent": "{string}",   "errors": [    "{array[string]...}"   ]  },  "scanStatus": {   "scanningState": "{string}",   "uploadProgress": "{int32}",   "scanProgress": "{int32}"  } }]
Copy

Expand

Enumerate all scan schedules

Auth

GET /api/v1/scans/schedules

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/schedules'
Copy

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
workflow	object
id	string
name	string
description	string
userId	string
scanConfigurationId	string
deleted	boolean
type	integer
scanSources	array[object]
serviceId	string
serviceName	string
repositories	array[object]
repositoryId	string
repositoryName	string
type	string
connection	string
packageType	string
organization	string
registry	string
referencesToScan	array[string]
remediations
_t	string	Enum: `EmailRemediation`
emailRecipients	array[string]
isEnabled	boolean
malware	boolean
secret	boolean
recurrencePattern	object
type	integer
hourlyRecurrence	object
everyNumberOfHours	int32
dailyRecurrence	object
everyNumberOfDays	int32
weeklyRecurrence	object
daysOfWeek	array[integer]
everyNumberOfWeeks	int32
monthlyRecurrence	object
everyNumberOfMonths	int32
dayOfMonth	int32
scanSchedules	array
createdAt	date-time
lastUpdated	date-time
tenantId	string
scans	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
scanStatistics	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
allowedLicenses	array[object]
id	string
url	string
category	string
usage_restriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blockedLicenses	array
scan	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

Expand

Response

xxxxxxxxxx
 
[
 {...}
]
Copy

Clean up historical scan results older than the specified time frame

Auth

Request Body

object	object
timeFrame	integer

POST /api/v1/scans/cleanup

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/scans/cleanup' \ --data '{  "timeFrame": "{integer}"}'
Copy

Responses

200

object	object
deletedScansCount	int32
totalScansFound	int32
responseKey	string
responseMessage	string

207

Multi-Status

400

Bad Request

500

Internal Server Error

Response

xxxxxxxxxx
 
{ "deletedScansCount": "{int32}", "totalScansFound": "{int32}", "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Enumerate files by scan ID

Auth

Path Params

scanId string

Query String

page	integer
pageSize	integer
search	string
includeArchives	boolean

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/%7BscanId%7D/files' \ --data page={page} \ --data pageSize={pageSize} \ --data search={search} \ --data includeArchives={includeArchives}
Copy

Responses

200

array	array[object]
objectIdentityId	string
objectIdentityHash	string
scanResultId	string
progressUpload	int32
progressScan	int32
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	int32
coreEngines	array[object]
engineId	string
engineName	string
engineVersion	string
dbVersion	string
definitionTime	string
objectTriggeredActions	array[object]
actionStatus	integer
triggeredActionType	integer
createdAt	date-time
lastUpdated	date-time
tenantId	string
objectRemediationActions	array[object]
id	string
objectActionType	integer
objectActionState	integer
exceptions	array[string]
fileId	string
fileScanCompletedTime	date-time
remediationId	string
createdAt	date-time
lastUpdated	date-time
tenantId	string
file	object
versions	array[object]
url	string
fileId	string
fileScanCompletedTime	date-time
scanResultId	string
objectIdentityId	string
objectIdentityHash	string
progressScan	int32
progressUpload	int32
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	int32
coreEngines	array
lastUpdated	date-time
createdAt	date-time
tenantId	string
objectIdentity	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]
scanResult	object
coreEnginesHash	string
objectIdentityId	string
objectIdentityHash	string
objectIdentity	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	int32
totalDetections	int32
vulnerabilities	int32
dlpVerdict	int64
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
pathForDisplay	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
pathForDisplay	string

Expand

404

Not Found

Response

xxxxxxxxxx
 
[
 {...}
]
Copy

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

Auth

Path Params

scanResultId string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/%7BscanResultId%7D/core-result'
Copy

Responses

200

object	object
extracted_files	object
data_id	string
scan_result_i	int32
detected_by	int32
files_in_archive	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_info	object
post_processing	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_results	object
scan_details	object
*	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_info	object
file_size	int64
upload_timestamp	string
md5	string
sha1	string
sha256	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_info	object
post_processing	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_info	object
verdict	int64
sbom_info	object
final_verdict	object
blocked	boolean
licensing_package_counts	object
allowed	int32
blocked	int32
unknown	int32
unsupported	int32
total_package_count	int32
verdict	string
verdict_explanation	array[string]
vulnerability_counts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
vulnerable_package_count	int32
overview_report	object
is_partial_report	boolean
os_info	object
os_name	string
os_version	string
scan_mode	string
steps	array[object]
command	string
license_status	string
licensing_package_counts	object
allowed	int32
blocked	int32
unknown	int32
unsupported	int32
packages	array[object]
authors	string
release_date	string
arch	string
ecosystem	string
group	string
archive	boolean
executable	boolean
uid	string
licenses	object
allowed	array[object]
id	string
url	string
category	string
usage_restriction	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
vulnerabilities	array[object]
id	string
source	string
fixed_versions	string
cwes	array[string]
type	string
vulnerability_counts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies	array[object]
uid	string
ecosystem	string
group	string
package_name	string
package_version	string
vulnerabilities	array
vulnerability_counts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
package_type	string
up_to_date	boolean
step	int32
vulnerability_count	int32
vulnerability_counts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies_vulnerability_count	int32
dependencies_vulnerability_counts	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
packages	array[object]
authors	string
release_date	string
ecosystem	string
group	string
archive	boolean
executable	boolean
uid	string
licenses	object
allowed	array[object]
id	string
url	string
category	string
usage_restriction	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_counts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies	array
package_type	string
up_to_date	boolean
dependencies_package_count	int32
dependencies_vulnerability_count	int32
dependencies_vulnerability_counts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
vulnerability_count	int32
vulnerability_counts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
has_pe_info	boolean
package_count	int32
timestamp	string
vulnerable_dependencies_package_count	int32
vulnerable_package_count	int32
result_template_hash	string
vulnerability_info	object
result	object
code	int64
hash	string
method	int64
timestamp	string
timing	int64
detected_product	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_data	object
count_behind	int64
feed_id	int64
version	string
vulnerabilities	array[object]
description	string
details	object
cpe	string
cve	string
cvss	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_0	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
*	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

Expand

Response

xxxxxxxxxx
 
{
 "extracted_files": {...},
 "scan_results": {...},
 "file_info": {...},
 "process_info": {...},
 "data_id": "{string}", "source": "{string}", "scanned_on": "{string}", "dlp_info": {...},
 "sbom_info": {...},
 "vulnerability_info": {...},
 "engine_stat": {}, "sessionCookie": "{string}", "isFailed": "{boolean}"}
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/scans/%7BscanResultId%7D/archive' \ --data count={count} \ --data offset={offset}
Copy

Responses

200

object	object
coreScanResults	array[object]
extractedFiles	object
dataId	string
scanResultI	int32
detectedBy	int32
filesInArchive	array[object]
displayName	string
dataId	string
fileType	string
fileTypeDescription	string
scanResultI	int32
scanAllResultI	int32
detectedBy	int32
scannedWith	int32
progressPercentage	int32
fileSize	int64
processInfo	object
postProcessing	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
scanResults	object
scanDetails	object
*	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
fileInfo	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
processInfo	object
postProcessing	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
dlpInfo	object
hits	object
displayName	string
hits	array[object]
after	string
before	string
hit	string
certainty	string
certaintyScore	int64
severity	integer
verdict	int64
sbomInfo	object
finalVerdict	object
blocked	boolean
severity	integer
verdict	string
overviewReport	object
steps	array[object]
command	string
packages	array[object]
authors	string
arch	string
ecosystem	string
group	string
archive	boolean
executable	boolean
uid	string
licenses	object
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
osName	string
latest	object
version	string
hashes	array[object]
sha256	string
vulnerabilities	array[object]
id	string
source	string
cwes	array[string]
type	string
vulnerabilityCounts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies	array[object]
ecosystem	string
group	string
vulnerabilityCounts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
upToDate	boolean
step	int32
sha256	string
severity	integer
packages	array[object]
authors	string
ecosystem	string
group	string
archive	boolean
executable	boolean
uid	string
licenses	object
allowed	array[object]
id	string
url	string
category	string
usageRestriction	object
permissions	array[string]
conditions	array[string]
limitations	array[string]
blocked	array
target	string
latest	object
version	string
hashes	array
vulnerabilities	array
vulnerabilityCounts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
dependencies	array
upToDate	boolean
vulnerabilityCount	int32
vulnerabilityCounts	object
critical	int32
high	int32
medium	int32
low	int32
unknown	int32
hasPeInfo	boolean
timestamp	string
vulnerabilityInfo	object
vulnerabilityInfoResult	object
code	int64
hash	string
method	int64
timeStamp	string
timing	int64
detectedProduct	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
versionData	object
countBehind	int64
feedId	int64
version	string
vulnerabilities	array[object]
description	string
details	object
cpe	string
cve	string
cvss	object
accessComplexity	string
accessVector	string
authentication	string
availabilityImpact	string
confidentialityImpact	string
generatedOnEpoch	string
integrityImpact	string
score	string
source	string
cvss3	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
*	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

Expand

Response

xxxxxxxxxx
 
{
 "coreScanResults": [...],
 "hasMore": "{boolean}"}
Copy

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}/{repositoryId}/references

/api/v1/services/references

Get all services

Auth

Query String

content	boolean
type	array

GET /api/v1/services

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/services' \ --data content={content} \ --data type={type}
Copy

Responses

200

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

xxxxxxxxxx
 
{ "serviceDtos": [  {   "id": "{string}",   "credentialsType": "{int32}",   "scanWorkflowId": "{string}",   "domain": "{string}",   "realTimeStatus": "{integer}",   "name": "{string}",   "source": "{}",   "vendorType": "{integer}",   "protocolType": "{integer}"  } ], "statusMessage": "{string}"}
Copy

Add a service

Auth

Request Body

object	object
credentials	string
name	string
vendorType	integer
protocolType	integer

POST /api/v1/services

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/services' \ --data '{  "credentials": "{string}",  "name": "{string}",  "source": "{}",  "vendorType": "{integer}",  "protocolType": "{integer}"}'
Copy

Responses

200

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

400

Bad Request

Response

xxxxxxxxxx
 
{ "id": "{string}", "name": "{string}", "type": {  "name": "{string}",  "categoryType": "{integer}",  "protocolType": "{integer}",  "vendorType": "{integer}" }, "details": "{}", "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get a service by ID

Auth

Path Params

serviceId string

Query String

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

GET /api/v1/services/{serviceId}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/services/%7BserviceId%7D' \ --data content={content} \ --data Search={Search} \ --data Page={Page} \ --data PageSize={PageSize} \ --data FilterValue={FilterValue} \ --data Cursor={Cursor} \ --data PrioritizedRepositoriesReference={PrioritizedRepositoriesReference}
Copy

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

xxxxxxxxxx
 
{ "id": "{string}", "credentialsType": "{int32}", "scanWorkflowId": "{string}", "domain": "{string}", "realTimeStatus": "{integer}", "name": "{string}", "source": "{}", "vendorType": "{integer}", "protocolType": "{integer}"}
Copy

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}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/services/%7BserviceId%7D' \ --data '{  "name": "{string}",  "credentials": "{string}",  "hasNewCredentials": "{boolean}"}'
Copy

Responses

200

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

400

Bad Request

Response

xxxxxxxxxx
 
{ "id": "{string}", "name": "{string}", "type": {  "name": "{string}",  "categoryType": "{integer}",  "protocolType": "{integer}",  "vendorType": "{integer}" }, "details": "{}", "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Delete a service by ID

Auth

Path Params

serviceId string

DELETE /api/v1/services/{serviceId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/services/%7BserviceId%7D'
Copy

Responses

200

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

404

Not Found

Response

xxxxxxxxxx
 
{ "result": "{integer}", "responseKey": "{string}", "responseMessage": "{string}", "responseMessageParams": {}}
Copy

Get service references by service ID

Auth

Path Params

serviceId string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/services/%7BserviceId%7D/references'
Copy

Responses

200

object	object
serviceId	string
serviceName	string
repositoryReferenceInfoArray	array[object]
repositoryId	string
defaultReference	string
references	array[string]

404

Not Found

Response

xxxxxxxxxx
 
{ "serviceId": "{string}", "serviceName": "{string}", "repositoryReferenceInfoArray": [  {   "repositoryId": "{string}",   "defaultReference": "{string}",   "references": [    "{array[string]...}"   ]  } ]}
Copy

Get service resources by service ID

Auth

Path Params

serviceId string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/services/%7BserviceId%7D/resources'
Copy

Responses

200

object	object
resources	array[string]

404

Not Found

Response

xxxxxxxxxx
 
{ "resources": [  "{array[string]...}" ]}
Copy

Get service references by service ID and repository ID

Auth

Path Params

serviceId	string
repositoryId	string

Query String

Page	integer
PageSize	integer
FilterValue	string	pattern: `^[0-9]*$`
Cursor	string	pattern: `^[0-9]*$`

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/services/%7BserviceId%7D/%7BrepositoryId%7D/references' \ --data Page={Page} \ --data PageSize={PageSize} \ --data FilterValue={FilterValue} \ --data Cursor={Cursor}
Copy

Responses

200

object	object
references	array[string]
totalReferences	uint32

404

Not Found

Response

xxxxxxxxxx
 
{ "references": [  "{array[string]...}" ], "totalReferences": "{uint32}"}
Copy

Add service references

Auth

Request Body

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

POST /api/v1/services/references

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/services/references' \ --data '[  {    "serviceId": "{string}",    "repositoryIds": [      "{array[string]...}"    ]  }]'
Copy

Responses

200

array	array[object]
serviceId	string
serviceName	string
repositoryReferenceInfoArray	array[object]
repositoryId	string
defaultReference	string
references	array[string]

204

No Content

404

Not Found

Response

xxxxxxxxxx
 
[ {  "serviceId": "{string}",  "serviceName": "{string}",  "repositoryReferenceInfoArray": [   {    "repositoryId": "{string}",    "defaultReference": "{string}",    "references": [     "{array[string]...}"    ]   }  ] }]
Copy

Manage Settings

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

Get a SMTP configuration

Auth

GET /api/v1/smtp

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/smtp'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "smtp": {  "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}"}
Copy

Update 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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/smtp' \ --data '{  "host": "{string}",  "baseUrl": "{string}",  "port": "{int32}",  "senderAddress": "{string}",  "senderName": "{string}",  "domain": "{string}",  "username": "{string}",  "password": "{string}",  "secureSocketOption": "{integer}",  "ignoreCertWarnings": "{boolean}",  "isEnabled": "{boolean}"}'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Get all Jira configurations

Auth

GET /api/v1/jira

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/jira'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "jiraEntries": [  {   "id": "{string}",   "name": "{string}",   "apiKey": "{string}",   "baseAddress": "{string}",   "productAddress": "{string}",   "username": "{string}",   "tenantId": "{string}",   "createdAt": "{date-time}",   "lastUpdated": "{date-time}"  } ], "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Add a Jira configuration

Auth

Request Body

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

POST /api/v1/jira

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/jira' \ --data '{  "name": "{string}",  "apiKey": "{string}",  "baseAddress": "{string}",  "productAddress": "{string}",  "username": "{string}"}'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Get a Jira configuration by ID

Auth

Path Params

id string

GET /api/v1/jira/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/jira/%7Bid%7D'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "jira": {  "id": "{string}",  "name": "{string}",  "apiKey": "{string}",  "baseAddress": "{string}",  "productAddress": "{string}",  "username": "{string}",  "tenantId": "{string}",  "createdAt": "{date-time}",  "lastUpdated": "{date-time}" }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/jira/%7Bid%7D' \ --data '{  "name": "{string}",  "apiKey": "{string}",  "baseAddress": "{string}",  "productAddress": "{string}",  "username": "{string}"}'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Delete a Jira configuration by ID

Auth

Path Params

id string

DELETE /api/v1/jira/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/jira/%7Bid%7D'
Copy

Responses

200

object	object
jiraId	string
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "jiraId": "{string}", "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Get Jira projects

Auth

Path Params

id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/jira/%7Bid%7D/projects'
Copy

Responses

200

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

404

Not Found

Response

xxxxxxxxxx
 
{ "projects": [  {   "id": "{string}",   "name": "{string}"  } ], "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Get all Teams configurations

Auth

GET /api/v1/teams

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/teams'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "teamsConnections": [  {   "name": "{string}",   "apiKey": "{string}",   "webhookUrl": "{string}",   "productAddress": "{string}",   "createdAt": "{date-time}",   "lastUpdated": "{date-time}",   "id": "{string}",   "tenantId": "{string}"  } ], "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Add a Teams configuration

Auth

Request Body

object	object
name	string
apiKey	string
webhookUrl	string
productAddress	string

POST /api/v1/teams

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/teams' \ --data '{  "name": "{string}",  "apiKey": "{string}",  "webhookUrl": "{string}",  "productAddress": "{string}"}'
Copy

Responses

201

Created

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Get a Teams configuration by ID

Auth

Path Params

id string

GET /api/v1/teams/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/teams/%7Bid%7D'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "teams": {  "name": "{string}",  "apiKey": "{string}",  "webhookUrl": "{string}",  "productAddress": "{string}",  "createdAt": "{date-time}",  "lastUpdated": "{date-time}",  "id": "{string}",  "tenantId": "{string}" }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/teams/%7Bid%7D' \ --data '{  "name": "{string}",  "apiKey": "{string}",  "webhookUrl": "{string}",  "productAddress": "{string}"}'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Delete a Teams configuration by ID

Auth

Path Params

id string

DELETE /api/v1/teams/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/teams/%7Bid%7D'
Copy

Responses

200

object	object
teamsId	string
responseKey	string
responseMessage	string

404

Not Found

Response

xxxxxxxxxx
 
{ "teamsId": "{string}", "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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

Get users

Auth

Query String

Type	string	pattern: `^[0-9]*$`
StartIndex	integer
Count	integer
SearchTerm	string	pattern: `^[0-9]*$`

GET /api/v1/users

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/users' \ --data Type={Type} \ --data StartIndex={StartIndex} \ --data Count={Count} \ --data SearchTerm={SearchTerm}
Copy

Responses

200

object	object
enumerateUsersDto	object
entries	array[object]
userId	string
username	string
fullName	string
email	string
role	integer
showTutorial	boolean
totalCount	int64
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "enumerateUsersDto": {  "entries": [   {    "userId": "{string}",    "username": "{string}",    "fullName": "{string}",    "email": "{string}",    "role": "{integer}",    "showTutorial": "{boolean}"   }  ],  "totalCount": "{int64}" }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/users' \ --data '{  "userId": "{string}",  "role": "{integer}",  "userName": "{string}",  "fullName": "{string}",  "email": "{string}",  "currentPassword": "{string}",  "newPassword": "{string}",  "showTutorial": "{boolean}"}'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Add a new user

Auth

Request Body

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

POST /api/v1/users

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/users' \ --data '{  "role": "{integer}",  "fullName": "{string}",  "userName": "{string}",  "password": "{string}",  "email": "{string}"}'
Copy

Responses

200

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

400

Bad Request

Response

xxxxxxxxxx
 
{ "createUserParameters": {  "role": "{integer}",  "fullName": "{string}",  "userName": "{string}",  "password": "{string}",  "email": "{string}" }, "currentUserId": "{string}"}
Copy

Get current user

Auth

GET /api/v1/user

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/user'
Copy

Responses

200

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

400

Bad Request

Response

xxxxxxxxxx
 
{ "userDto": {  "userId": "{string}",  "username": "{string}",  "fullName": "{string}",  "email": "{string}",  "role": "{integer}",  "showTutorial": "{boolean}" }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Delete a user

Auth

Path Params

userId string

DELETE /api/v1/users/{userId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/users/%7BuserId%7D'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Login user

Auth

Request Body

object	object
username	string
password	string

POST /api/v1/user/login

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/user/login' \ --data '{  "username": "{string}",  "password": "{string}"}'
Copy

Responses

200

object	object
jwtToken	object
token	string
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "jwtToken": {  "token": "{string}" }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Remove all tokens for an user

Auth

Path Params

userId string

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/v1/user/login/%7BuserId%7D'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Get a new Access Token

Auth

Request Body

object	object
accessToken	string

PUT /api/v1/user/token

xxxxxxxxxx
 
curl --request PUT \ --url 'https://opswat.developerhub.io/api/v1/user/token' \ --data '{  "accessToken": "{string}"}'
Copy

Responses

200

object	object
jwtToken	object
token	string
responseKey	string
responseMessage	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "jwtToken": {  "token": "{string}" }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Request a password reset

Auth

Request Body

object	object
emailInput	string

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/user/password/request-reset' \ --data '{  "emailInput": "{string}"}'
Copy

Responses

200

object	object
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/user/password/new-password' \ --data '{  "newPassword": "{string}",  "newPasswordConfirmation": "{string}",  "secureToken": "{string}",  "userId": "{string}"}'
Copy

Responses

200

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

Response

xxxxxxxxxx
 
{ "user": {  "userId": "{string}",  "username": "{string}",  "fullName": "{string}",  "email": "{string}",  "role": "{integer}",  "showTutorial": "{boolean}" }, "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Manage Versions

Get application version

Auth

Query String

api-version

string

pattern: ^[0-9]*$

GET /api/version

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/version' \ --data api-version={api-version}
Copy

Responses

200

object	object
version	string
lastSupportedConfigVersion	string
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "version": "{string}", "lastSupportedConfigVersion": "{string}", "responseKey": "{string}", "responseMessage": "{string}"}
Copy

Get application version

Auth

GET /api/v1/version

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/v1/version'
Copy

Responses

200

object	object
version	string
lastSupportedConfigVersion	string
responseKey	string
responseMessage	string

Response

xxxxxxxxxx
 
{ "version": "{string}", "lastSupportedConfigVersion": "{string}", "responseKey": "{string}", "responseMessage": "{string}"}
Copy

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}

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/webhook/hmac/%7BrouteParameter%7D'
Copy

Responses

200

No response body

400

Bad Request

500

Internal Server Error

Response

xxxxxxxxxx
 
No response
Copy

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}

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/v1/webhook/%7BrouteParameter%7D'
Copy

Responses

200

No response body

400

Bad Request

500

Internal Server Error

Response

xxxxxxxxxx
 
No response
Copy

Manage Workflows

/api/v1/workflows/{id}

/api/v1/workflows/{id}

/api/v1/workflows/{id}

/api/v1/workflows/{id}/scan-source