Create Vulnerability Scan
Create a vulnerability scan, to be broken down into a set of vulnerabilities.
Body
application/json
Body
Request body schema for uploading a vulnerability scan.
UploadVulnerabilityScan
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
Allowed values:grypetrivy
Example:trivy
One OfShow Child Parameters
Example:prod
Example:us-east-2
Optional key used to correlate vulnerabilities found in this scan with the same vulnerabilities found across different sources.
This allows tracking the same vulnerability in two sources as one vulnerability instance.
When omitted, this will inherit the value of scan_key.
Example:kong/repo-id
Example:{"org.kong.enterprise.source.version":"v1"}
Optional RFC-3339 timestamp indicating when the vulnerability scan was run.
If provided, this value will be used as the authoritative scan time.
If omitted, the system will attempt to extract a timestamp from the uploaded scan report.
If no timestamp can be extracted, the server’s current time at ingestion will be used.
Example:2025-01-01T00:00:00Z
Response
application/json
Response
Response object containing a single vulnerability scan, without its catalog mapping.
VulnerabilityScan
Example:0ca46543-e6a3-4a8b-8e2c-205935a1bb3a
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
Allowed values:grypetrivy
Example:trivy
Show Child Parameters
One OfShow Child Parameters
Example:prod
Example:us-east-2
Example:kong/repo-id
Example:{"org.kong.enterprise.source.version":"v1"}
Date the vulnerability scan occurred at.
Example:2025-01-01T00:00:00Z
Allowed values:in_progresscompletedfailed
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Body
Get a Vulnerability Scan
Returns vulnerability scan by ID.
Path Parameters
ID of the vulnerability scan.
Response
application/json
Response
Response object containing a single vulnerability scan, without its catalog mapping.
VulnerabilityScan
Example:0ca46543-e6a3-4a8b-8e2c-205935a1bb3a
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
Allowed values:grypetrivy
Example:trivy
Show Child Parameters
One OfShow Child Parameters
Example:prod
Example:us-east-2
Example:kong/repo-id
Example:{"org.kong.enterprise.source.version":"v1"}
Date the vulnerability scan occurred at.
Example:2025-01-01T00:00:00Z
Allowed values:in_progresscompletedfailed
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
List Vulnerability Scan Vulnerabilities
Returns a paginated collection of vulnerabilities for a given vulnerability scan.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of vulnerabilities for a given vulnerability scan.
Show Child Parameters
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
ID of the vulnerability scan.
Response
application/json
Response
A paginated list response for a collection of vulnerabilities, for a given vulnerability scan.
returns the pagination information
Show Child Parameters
Authentication
Path Parameters
Query Parameters
List Service Vulnerability Scans
Returns a paginated collection of vulnerability scans for a given service.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of vulnerability scans, for a given service.
Show Child Parameters
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
ID of the service.
Response
application/json
Response
A paginated list response for a collection of vulnerability scans.
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get a Service Vulnerability Scan
Returns vulnerability scan, for a given service, by ID.
Path Parameters
ID of the service.
ID of the vulnerability scan.
Response
application/json
Response
Response object containing a single vulnerability scan, without its catalog mapping.
VulnerabilityScan
Example:0ca46543-e6a3-4a8b-8e2c-205935a1bb3a
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
Allowed values:grypetrivy
Example:trivy
Show Child Parameters
One OfShow Child Parameters
Example:prod
Example:us-east-2
Example:kong/repo-id
Example:{"org.kong.enterprise.source.version":"v1"}
Date the vulnerability scan occurred at.
Example:2025-01-01T00:00:00Z
Allowed values:in_progresscompletedfailed
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z