Search
K
Konnect Service Catalog

Create Vulnerability Scan

Create a vulnerability scan, to be broken down into a set of vulnerabilities.

post

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_referenceOne Of
objectrequired
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 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_referenceOne Of
objectrequired
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

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 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_referenceOne Of
objectrequired
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}
 
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

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
 
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

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
 
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 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_referenceOne Of
objectrequired
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}
 
application/json