Vulnerabilities

Get Vulnerability Terms Data

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
term_namestringRequired
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
or
nullOptional
package_nameany ofOptional
stringOptional
or
nullOptional
package_versionany ofOptional
stringOptional
or
nullOptional
fix_statusstring · enumOptionalDefault: activePossible values:
Responses
chevron-right
200

Successful Response

application/json
or
or
or
or
get
/api/vulnerabilities/_terms/data

Get Vulnerability Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
or
nullOptional
fix_statusstring · enumOptionalDefault: activePossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/api/vulnerabilities/_terms

Get Vulnerabilities

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fix_statusstring · enumOptionalDefault: activePossible values:
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/vulnerabilities

Get Vulnerabilities

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fix_statusstring · enumOptionalDefault: activePossible values:
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/vulnerabilities

Get Vulnerability Overview

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
vuln_idstringRequired
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
vuln_idstringRequired
titleany ofRequired
stringOptional
or
nullOptional
descriptionany ofRequired
stringOptional
or
nullOptional
riskstring · enumRequiredPossible values:
vulnerability_severityany ofRequired
string · enumOptionalPossible values:
or
nullOptional
cvss_scoreany ofRequired
numberOptional
or
nullOptional
cvss_vectorany ofRequired
stringOptional
or
nullOptional
epss_scoreany ofRequired
numberOptional
or
nullOptional
epss_percentileany ofRequired
numberOptional
or
nullOptional
publishedany ofRequired
string · date-timeOptional
or
nullOptional
last_modifiedstring · date-timeRequired
sourcestringRequired
cwestring[]Required
referencesstring[]Required
packageany ofRequired
stringOptional
or
nullOptional
vulnerable_versionsstring[]Required
fix_versionsstring[]Required
remediationintegerRequired
first_seenany ofRequired
string · date-timeOptional
or
nullOptional
last_seenany ofRequired
string · date-timeOptional
or
nullOptional
exploit_threatstring · enumRequiredPossible values:
idsinteger[]Required
code_root_idsany ofRequired
integer[]Optional
or
nullOptional
affected_versionsstring[]Required
remediation_versionsstring[]Required
introduced_atany ofRequired
string · date-timeOptional
or
nullOptional
fixed_atany ofRequired
string · date-timeOptional
or
nullOptional
found_in_codeany ofRequired
booleanOptional
or
nullOptional
found_at_runtimeany ofRequired
booleanOptional
or
nullOptional
remediated_atany ofRequired
string · date-timeOptional
or
nullOptional
slo_due_dateany ofRequired
string · date-timeOptional
or
nullOptional
autofixableany ofRequired
booleanOptional
or
nullOptional
autofixedany ofRequired
booleanOptional
or
nullOptional
get
/api/vulnerabilities/{vuln_id}/overview

Get Vulnerability Counts

post

Get vulnerability instance counts broken down by priority. Returns counts of individual vulnerability instances (not unique CVEs).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fix_statusstring · enumOptionalDefault: activePossible values:
filter_remediation_existsbooleanOptionalDefault: false
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
Other propertiesintegerOptional
post
/api/vulnerabilities/counts

Get Vulnerability Finding Instances

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
or
nullOptional
package_nameany ofOptional
stringOptional
or
nullOptional
package_versionany ofOptional
stringOptional
or
nullOptional
fix_statusstring · enumOptionalDefault: activePossible values:
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/vulnerabilities/finding_instances

Get Vulnerability Finding Instances

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
or
nullOptional
package_nameany ofOptional
stringOptional
or
nullOptional
package_versionany ofOptional
stringOptional
or
nullOptional
fix_statusstring · enumOptionalDefault: activePossible values:
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/vulnerabilities/finding_instances

Get Vulnerability Remediations

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
vuln_idstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/vulnerabilities/{vuln_id}/remediations

Get Vulnerability Remediations

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
vuln_idstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/vulnerabilities/{vuln_id}/remediations

Get Vulnerability Modules Affected

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
vuln_idstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/vulnerabilities/{vuln_id}/modules

Get Vulnerability Modules Affected

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
vuln_idstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/vulnerabilities/{vuln_id}/modules

Get Vulnerability Deployments Affected

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
vuln_idstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/vulnerabilities/{vuln_id}/deployments

Get Vulnerability Deployments Affected

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
vuln_idstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/vulnerabilities/{vuln_id}/deployments

Get Vulnerability Remediations Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful Response

application/json
get
/api/vulnerabilities/remediations/_terms

Get Vulnerability Remediations Terms

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful Response

application/json
post
/api/vulnerabilities/remediations/_terms

Get Vulnerability Modules Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful Response

application/json
get
/api/vulnerabilities/modules/_terms

Last updated

Was this helpful?