| Table of Contents |
|---|
| Info |
|---|
NOTES:
|
...
See /wiki/spaces/WD/pages/33816708.
Get Organization Policies
Get Product Policies
Get Project Policies
Add Organization Policy
Add Product Policy
Add Project Policies
Update Organization Policy
Update Product Policy
Update Project Policy
Remove Organization Policies
Remove Product Policies
Remove Project Policies
Reorder Organization Policy Priorities
Reorder Product Policy Priorities
Reorder Project Policy Priorities
Get Licenses
...
| Info |
|---|
For customers who have enabled vulnerability based alerting, there are several changes to API version 1.3. Refer here for details. |
Get all alerts for a given organization/product/project.
...
| Info |
|---|
For customers who have enabled Security Alerts: View By Vulnerability, there are several changes to API version 1.3. Refer here for details. |
| Code Block |
|---|
{
"requestType" : "getAlertsByProjectTag",
"userKey": "user_key",
"orgToken" : "orgToken",
"tagKey":"key1",
"tagValue":"value1"
} |
...
| Info |
|---|
For customers who have enabled Security Alerts: View By Vulnerability, there are several changes to API version 1.3. Refer here for details. |
Get a list of ignored alerts per scope (organization/product/project).
...
Field name | Value |
|---|---|
name | The id in the vulnerability DB (CVE or WS) |
type | Either CVE or WS |
severity | Severity of the CVSS 2 vulnerability (low, medium, high) |
score | The CVSS 2 base score [0.0 - 10.0] |
cvss3_severity | The score severity, if CVSS 3 score is between 0-3.9 - Low, if CVSS 3 score is between 4-6.9 - Medium, if CVSS 3 score is between 7-10 - High |
cvss3_score | The CVSS 3 base score [0.0 - 10.0] |
scoreMetadataVector | See specification link |
publishDate | Original release date |
url | URL of the CVE |
description | A short description of the security vulnerability |
topFix | Top recommended fix (when available) |
allFixes | List of all fixes (when available) |
fixResolutionText | The actual resolution text to display for the given fix. |
...
| Info |
|---|
For customers who have enabled Security Alerts: View By Vulnerability, there are several changes to API version 1.3. Refer here for details. |
Get all alerts of a certain type for a given organization / product / project.
...
Enables users with Organization Administrators , Product Administrators, and Alert Ignorers roles role to ignore alerts according to their unique identifier. You can use any alert-related API to get the alertUUID of a particular alert.
...
Enables users with Organization Administrators , Product Administrators, and Alert Ignorers roles role to set the status of alert(s) according to their unique identifier. This API can also be used to change the alert's comments.
...
| Info |
|---|
Response Parameters
|
Unmark In-House Libraries
Unmark libraries that were manually assigned as in-house.
This request is only in organization level, and therefore requires an org token.
Request
Organization Level
| Code Block |
|---|
{
"requestType": "unmarkManualInHouseLibrary",
"userKey": "user_key",
"orgToken": "organization_api_key",
"keyUuid" : "library_UUID"
} |
Response
| Code Block |
|---|
{
"message": "Successfully unmarked in-house library"
} |
Get Project Vitals
Get basic information regarding a project: name, token, creation date and last updated date.
...
Prioritize/ Effective Usage Analysis
See here for details.
Get Alerts Report
...
Content-Type = application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;'|
Content-Disposition: attachment; filename=<product name>-in-house-report.xlsx
...
| Code Block |
|---|
{
"requestType" : "getProductLibraryLocations",
"userKey": "user_key",
"productTokenprojectToken" : "productproject_token"
} |
Response Format
| Code Block |
|---|
"libraryLocations" : [
{
"name" : "library_name",
"keyId" : key_id,
"keyUuid" : "key_uuid",
"locations": [
{
"path" : "library_location_1\library_name",
"matchType": "SHA1"
},
{
"path": "library_location_2\\library_name",
"matchType": "FILENAME"
}
]
}
] |
...
| Code Block |
|---|
"libraryLocations" : [
{
"name" : "library_name",
"keyId" : key_id,
"keyUuid" : "key_uuid",
"locations": [
{
"path" : "library_location_1\library_name",
"dependencyFile" : "home/ubuntu/GiHubRepos/Samples123/pom.xml"
"matchType": "SHA1"
},
{
"path": "library_location_2\\library_name",
"dependencyFile" : "home/ubuntu/GiHubRepos/Samples234/pom.xml"
"matchType": "FILENAME"
}
]
}
] |
Get Policies
See /wiki/spaces/WD/pages/33816708Policies API for documentation.
Groups and Users
...
UNKNOWN - either orgToken or requestToken are invalid
IN_PROGRESS - update is in progress
UPDATED - inventory has been modified yet alerts have not been calculated yet
FINISHED - alerts have been calculated successfully
FAILED - an error has occurred during the update process
SKIPPED - when a scan for a project is requested while a scan for the same project is being executed simultaneously, the new scan is skipped
The timestamp field is in UTC format.
...
name - the name of the vulnerability (e.g. CVE-2008-0983).
severity - the CVSS severity (as taken from NVD), can be one of:
HIGH
MEDIUM
LOW
score - the CVSS score (as taken from NVD), values range from 0-10.
cvss3_score - the CVSS score 3 (as taken from NVD), values range from 0-10.
cvss3_severity - if cvss 3 score is between 0-3.9 - low, if cvss 3 score is between 4-6.9 - medium, if cvss 3 score is between 7-10 - high
scoreMetadataVector - a text representation of a set of CVSS metrics. See also related specification.
description - the vulnerability description.
publishDate - the publish date.
sourceFile - in case the vulnerability was matched to a source file, not the binary library, the sourceFile field will be populated (see details below).
Note: only libraries with type SOURCE_LIBRARY have source files.vulnerabilityFix - the top fix of the vulnerability (see details below).
fixResolutionText - the actual resolution text to display for the given fix.
...