suggestedResourceActionIdstringrequired
ID of the suggested resource action.
Example:76ca0689-f08e-4c04-b2a6-4c992d89d554
Update Suggested Resource Action
Updates the given suggested resource.
patch
Path Parameters
Body
application/json
Body
application/json
Request body schema for updating a suggested resource action.
UpdateSuggestedResourceAction
Payload to update a suggested resource action.
* Additional properties are NOT allowed.
ignoredbooleanrequired
Determines if this suggested action has been ignored or not.
true: Suggested action has been ignoredfalse: Suggested action is ready to be accepted or ignored
Example:false
Response
application/json
Response
application/json
A response containg a suggested resource action object.
SuggestedResourceAction
Contains information about a suggested resource action
idstringrequired
The suggested resource action rule ID.
Example:76ca0689-f08e-4c04-b2a6-4c992d89d554
integrationobjectrequired
Short-hand descriptor of an integration installed within the catalog.
Show Child Parameters
suggestion_rule_idstring | null(uuid)required
The identifier of the suggestion rule that generated this suggested resource action.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
entity_namestringrequired
The entity name of the discovered entity associated to this suggested action.
Example:My Service
service_idstring | null(uuid)required
The identifier of the service this suggested resource action may act on.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ignoredbooleanrequired
Determines if this suggested action has been ignored or not.
true: Suggested action has been ignoredfalse: Suggested action is ready to be accepted or ignored
Example:false
action
One Ofrequired
ArchiveActionPayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)read-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
patch/suggested-resource-actions/{suggestedResourceActionId}
Authentication
Path Parameters
Body
{
"ignored": false
}
application/json
Vulnerabilities
Retrieving, analyzing, and managing software vulnerabilities.
List Vulnerability Scans
Returns a paginated collection of vulnerability scans.
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.
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 vulnerability scans.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
Show Child Parameters
get/vulnerability-scans
Authentication
Query Parameters
application/json
Create Vulnerability Scan
Create a vulnerability scan, to be broken down into a set of vulnerabilities.
post
Body
application/json
Body
application/json
Request body schema for uploading a vulnerability scan.
UploadVulnerabilityScan
* Additional properties are NOT allowed.
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
descriptionstring | nullrequired
raw_scan_reportobjectrequired
* Additional properties are allowed.
catalog_reference
One Ofobjectrequired
CreateServiceVulnerabilityScanCatalogReferenceobject
* Additional properties are NOT allowed.
Show Child Parameters
environmentstring | nullrequired
Example:prod
regionstring | nullrequired
Example:us-east-2
source_correlation_keystring
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
attributesobjectrequired
Example:{"org.kong.enterprise.source.version":"v1"}
tsstring(date-time)
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
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
post/vulnerability-scans
Authentication
Body
{
"scan_key": "namespaces/foo:pods/bar-api",
"tool": "trivy",
"description": "description",
"raw_scan_report": {},
"catalog_reference": {},
"environment": "prod",
"region": "us-east-2",
"attributes": {
"org.kong.enterprise.source.version": "v1"
}
}
application/json
Get a Vulnerability Scan
Returns vulnerability scan by ID.
get
Path Parameters
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/vulnerability-scans/{scanId}
Authentication
Path Parameters
application/json