Konnect Service Catalog

VulnerabilityService

Service representation that includes attributes for the related vulnerability.

idstring(uuid)requiredread-only

The service ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Match pattern:^[0-9a-z.-]+$

>= 1 characters<= 120 characters

Example:user-svc

display_namestringrequired

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstringrequired

Optionally provide a description of the Service.

<= 2048 characters

custom_fieldsobjectrequired

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

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

vulnerabilityobjectrequired

Service-specific attributes of a given vulnerability.

* Additional properties are NOT allowed.
Show Child Parameters
Example

VulnerabilityInstanceFilterParameters

object
stateOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
environmentOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
regionOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
source_correlation_keyOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
service.idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
Example

ServiceVulnerabilityInstanceFilterParameters

object
stateOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
environmentOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
regionOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
source_correlation_keyOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
Example

PutVulnerabilityOverride

object
* Additional properties are NOT allowed.
commentstringrequired

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

Example

PutVulnerabilityDismissal

object
* Additional properties are NOT allowed.
commentstringrequired

A human-readable comment associated with the vulnerability dismissal, to add further context and description.

Example:Acceptable risk.

reasonstringrequired

The reason the vulnerability was dismissed.

Example:acceptable_risk

Example