Search
K
Konnect Service Catalog

Create Scorecard

Creates a scorecard.

post

Body

application/json

CreateScorecard

* Additional properties are NOT allowed.
namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstring | nullrequired

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

entity_selectorOne Of
object | nullrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

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

Show Child Parameters
criteriaarray[object]required

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters
scorecard_templatestring | nullrequired

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

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

Response

application/json

A response containing a single scorecard.

ScorecardWithCriteria

Representation of a scorecard.

idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstring | nullrequired

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

scoreobject | nullrequired

The current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.

Show Child Parameters
entity_selectorOne Of
object | nullrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

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

Show Child Parameters
scorecard_templatestring | nullrequired

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

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

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

criteriaarray[object]required
Show Child Parameters
post/scorecards

Body

{ "name": "Kong Best Practices", "description": "Best practices that we encourage users to follow when using other Konnect applications.", "scorecard_template": "kong_best_practices", "criteria": [ { "enabled": true, "template_name": "gateway_manager_error_rate", "template_parameters": { "relative_window": "30d", "threshold": 10 }, "section_name": "Gateway Observability" }, { "enabled": true, "template_name": "gateway_manager_response_latency", "template_parameters": { "metric": "response_latency_p95", "relative_window": "30d", "threshold": 30 }, "section_name": "Gateway Observability" }, { "enabled": true, "template_name": "gateway_manager_has_plugin", "template_parameters": { "category": "Authentication" }, "section_name": "Plugin Enforcement" } ], "entity_selector": { "selector": "all", "selector_parameters": null } }
 
application/json

List Scorecards

Returns a paginated collection of scorecards.

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

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

A paginated list response for a collection of scorecards.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Representation of a scorecard.

Show Child Parameters
get/scorecards
 
application/json

Get a Scorecard

Fetches a scorecard.

get

Path Parameters

idstring(uuid)required

The id of the scorecard.

Example:f3704e4c-104d-4f21-998a-20d4364c893f

Response

application/json

A response containing a single scorecard.

ScorecardWithCriteria

Representation of a scorecard.

idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstring | nullrequired

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

scoreobject | nullrequired

The current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.

Show Child Parameters
entity_selectorOne Of
object | nullrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

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

Show Child Parameters
scorecard_templatestring | nullrequired

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

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

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

criteriaarray[object]required
Show Child Parameters
get/scorecards/{id}
 
application/json

Update Scorecard

Updates a scorecard.

put

Path Parameters

idstring(uuid)required

The id of the scorecard.

Example:f3704e4c-104d-4f21-998a-20d4364c893f

Body

application/json

UpdateScorecard

* Additional properties are NOT allowed.
namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstring | nullrequired

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

entity_selectorOne Of
object | nullrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

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

Show Child Parameters
criteriaOne Of
arrayrequired

>= 1 items

UpdateScorecardCriteriaobject
* Additional properties are NOT allowed.
Show Child Parameters
scorecard_templatestring | nullrequired

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

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

Response

application/json

A response containing a single scorecard.

ScorecardWithCriteria

Representation of a scorecard.

idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstring | nullrequired

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

scoreobject | nullrequired

The current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.

Show Child Parameters
entity_selectorOne Of
object | nullrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

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

Show Child Parameters
scorecard_templatestring | nullrequired

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

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

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

criteriaarray[object]required
Show Child Parameters
put/scorecards/{id}

Body

{ "name": "Kong Best Practices", "description": "Best practices that we encourage users to follow when using other Konnect applications.", "scorecard_template": "kong_best_practices", "criteria": [ { "enabled": true, "template_name": "gateway_manager_error_rate", "template_parameters": { "relative_window": "30d", "threshold": 10 }, "section_name": "Gateway Observability" }, { "enabled": true, "template_name": "gateway_manager_response_latency", "template_parameters": { "metric": "response_latency_p95", "relative_window": "30d", "threshold": 30 }, "section_name": "Gateway Observability" }, { "enabled": true, "template_name": "gateway_manager_has_plugin", "template_parameters": { "category": "Authentication" }, "section_name": "Plugin Enforcement" } ], "entity_selector": { "selector": "all", "selector_parameters": null } }
 
application/json

Delete Scorecard

Deletes a scorecard.

delete

Path Parameters

idstring(uuid)required

The id of the scorecard.

Example:f3704e4c-104d-4f21-998a-20d4364c893f

Response

Scorecard was deleted successfully.

delete/scorecards/{id}