scanIdstring(uuid)required
ID of the vulnerability scan.
Get a Vulnerability Scan
Returns vulnerability scan by ID.
get
Path Parameters
Response
application/json
Response
application/json
Response object containing a single vulnerability scan, without its catalog mapping.
VulnerabilityScan
idstring(uuid)required
Example:0ca46543-e6a3-4a8b-8e2c-205935a1bb3a
scan_keystringrequired
Machine-usable value to correlate scans (and their vulnerabilities) on a given resource. This value is then
used to determine vulnerabilities resolved/fixed between subsequent scans on the same resource.
Example:namespaces/foo:pods/bar-api
toolstringrequired
Allowed values:grypetrivy
Example:trivy
tool_metadataobjectrequired
Show Child Parameters
descriptionstring | nullrequired
catalog_reference
One Ofobjectrequired
ServiceVulnerabilityScanCatalogReferenceobject
* Additional properties are NOT allowed.
Show Child Parameters
environmentstring | nullrequired
Example:prod
regionstring | nullrequired
Example:us-east-2
source_correlation_keystring | nullrequired
Example:kong/repo-id
attributesobjectrequired
Example:{"org.kong.enterprise.source.version":"v1"}
tsstring(date-time)required
Date the vulnerability scan occurred at.
Example:2025-01-01T00:00:00Z
statusstringrequired
Allowed values:in_progresscompletedfailed
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
get/vulnerability-scans/{scanId}
Authentication
Path Parameters
application/json
List Vulnerability Scan Vulnerabilities
Returns a paginated collection of vulnerabilities for a given vulnerability scan.
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
filterobject
Filters a collection of vulnerabilities for a given vulnerability scan.
Show Child Parameters
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
Path Parameters
scanIdstring(uuid)required
ID of the vulnerability scan.
Response
application/json
Response
application/json
A paginated list response for a collection of vulnerabilities, for a given vulnerability scan.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
get/vulnerability-scans/{scanId}/vulnerabilities
Authentication
Path Parameters
Query Parameters
application/json
List Service Vulnerability Scans
Returns a paginated collection of vulnerability scans 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
filterobject
Filters a collection of vulnerability scans, for a given service.
Show Child Parameters
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
Path Parameters
serviceIdstringrequired
ID of the service.
Response
application/json
Response
application/json
A paginated list response for a collection of vulnerability scans.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
Show Child Parameters
get/catalog-services/{serviceId}/vulnerability-scans
Authentication
Path Parameters
Query Parameters
application/json
Get a Service Vulnerability Scan
Returns vulnerability scan, for a given service, by ID.
get
Path Parameters
serviceIdstringrequired
ID of the service.
scanIdstring(uuid)required
ID of the vulnerability scan.
Response
application/json
Response
application/json
Response object containing a single vulnerability scan, without its catalog mapping.
VulnerabilityScan
idstring(uuid)required
Example:0ca46543-e6a3-4a8b-8e2c-205935a1bb3a
scan_keystringrequired
Machine-usable value to correlate scans (and their vulnerabilities) on a given resource. This value is then
used to determine vulnerabilities resolved/fixed between subsequent scans on the same resource.
Example:namespaces/foo:pods/bar-api
toolstringrequired
Allowed values:grypetrivy
Example:trivy
tool_metadataobjectrequired
Show Child Parameters
descriptionstring | nullrequired
catalog_reference
One Ofobjectrequired
ServiceVulnerabilityScanCatalogReferenceobject
* Additional properties are NOT allowed.
Show Child Parameters
environmentstring | nullrequired
Example:prod
regionstring | nullrequired
Example:us-east-2
source_correlation_keystring | nullrequired
Example:kong/repo-id
attributesobjectrequired
Example:{"org.kong.enterprise.source.version":"v1"}
tsstring(date-time)required
Date the vulnerability scan occurred at.
Example:2025-01-01T00:00:00Z
statusstringrequired
Allowed values:in_progresscompletedfailed
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
get/catalog-services/{serviceId}/vulnerability-scans/{scanId}
Authentication
Path Parameters
application/json
List Vulnerabilities
Returns a paginated collection of vulnerabilities.
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
filterobject
Filters a collection of catalog-wide vulnerabilities.
Show Child Parameters
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
Response
application/json
Response
application/json
A paginated list response for a collection of catalog-wide vulnerabilities.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
get/vulnerabilities
Authentication
Query Parameters
application/json