Search
K
Konnect Service Catalog

ScorecardTemplate

object

Representation of a scorecard template.

namestringrequired

Well-known name of the template. Uniquely identifies the template.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

display_namestringrequired

Example:Kong Best Practices

descriptionstringrequired

Example:Best practices that we encourage users to follow when using other Konnect applications.

criteriaarray[object]required

Example:{"template_name":"gateway_manager_error_rate","template_parameters":{"relative_window":"30d"},"integration":"gateway_manager"}{"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","relative_window":"30d"},"integration":"gateway_manager"}{"template_name":"gateway_manager_has_plugin","template_parameters":{},"integration":"gateway_manager"}

Show Child Parameters
Example

ScorecardTemplateName

string

Well-known name of the template. Uniquely identifies the template.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example

ScorecardTemplateCriteria

object
integrationstringrequired

The integration name when it provides the criteria template. Otherwise null.

template_namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

template_parametersobjectrequired

Input parameters for the given criteria template.

Example:{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}}

* Additional properties are allowed.
Example

CreateScorecard

object
* Additional properties are NOT allowed.
namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

entity_selectorOne Of
required
Variant 1One Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

Show Child Parameters
criteriaarray[object]required

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters
scorecard_templatestring

The name of the scorecard template used to create the scorecard.
Otherwise, null.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example

UpdateScorecard

object
* Additional properties are NOT allowed.
namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

entity_selectorOne Of
required
Variant 1One Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

Show Child Parameters
criteriaOne Of
arrayrequired

>= 1 items

UpdateScorecardCriteriaobject
* Additional properties are NOT allowed.
Example