serviceIdstringrequired
ID of the service.
vulnerabilityIdstring(uuid)required
ID of the vulnerability.
Get Service Vulnerability
Returns vulnerability instance, for a given service, by ID.
get
Path Parameters
Response
application/json
Response
application/json
Response object containing a single vulnerability.
Vulnerability
Vulnerabilityobject
* Additional properties are NOT allowed.
get/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}
Authentication
Path Parameters
application/json
List Service Vulnerability Instances
Returns a paginated collection of vulnerability instances for a given service.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[number]integer
Determines which page of the entities to retrieve.
Example:1
sortstring
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
filterobject
Filters a collection of vulnerability instances for a given service.
Show Child Parameters
Path Parameters
serviceIdstringrequired
ID of the service.
vulnerabilityIdstring(uuid)required
ID of the vulnerability.
Response
application/json
Response
application/json
A paginated list response for a collection of vulnerability instances.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}/instances
Authentication
Path Parameters
Query Parameters
application/json
Put Service Vulnerability Severity Override
Overrides a vulnerability severity for a given service.
put
Path Parameters
serviceIdstringrequired
ID of the service.
vulnerabilityIdstring(uuid)required
ID of the vulnerability.
Body
application/json
Body
application/json
Request body schema for overriding a vulnerability severity.
PutVulnerabilityOverride
* Additional properties are NOT allowed.
commentstring | nullrequired
A human-readable comment associated with the vulnerability override, to add further context and description.
Example:Severity bumped to high due to business impact.
severitystringrequired
Allowed values:lowmediumhighcritical
Example:low
Response
application/json
Response
application/json
Response object containing a single vulnerability.
Vulnerability
Vulnerabilityobject
* Additional properties are NOT allowed.
put/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}/severity
Authentication
Path Parameters
Body
{
"comment": "Severity bumped to high due to business impact.",
"severity": "low"
}
application/json
Delete Vulnerability Severity Override
Deletes the severity override on a vulnerability for a given service.
delete
Path Parameters
serviceIdstringrequired
ID of the service.
vulnerabilityIdstring(uuid)required
ID of the vulnerability.
Response
Response
No Content
delete/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}/severity
Authentication
Path Parameters
Put Service Vulnerability Dismissal
Dismisses a vulnerability for a given service.
put
Path Parameters
serviceIdstringrequired
ID of the service.
vulnerabilityIdstring(uuid)required
ID of the vulnerability.
Body
application/json
Body
application/json
Request body schema for dismissing a vulnerability.
PutVulnerabilityDismissal
* Additional properties are NOT allowed.
commentstring | nullrequired
A human-readable comment associated with the vulnerability dismissal, to add further context and description.
Example:Acceptable risk.
reasonstring | nullrequired
The reason the vulnerability was dismissed.
Example:acceptable_risk
Response
application/json
Response
application/json
Response object containing a single vulnerability.
Vulnerability
Vulnerabilityobject
* Additional properties are NOT allowed.
put/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}/dismissal
Authentication
Path Parameters
Body
{
"comment": "Acceptable risk.",
"reason": "acceptable_risk"
}
application/json