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
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:kong_best_practices, null

Response

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

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

criteriaarray[object]required
Show Child Parameters
post/scorecards

Body

{ "name": "Incident Response", "description": "Governs key metrics pertaining to teams' incident response practices.", "entity_selector": {}, "criteria": [ { "enabled": true, "template_name": "time_to_restore_service", "template_parameters": { "measure": "median", "threshold": { "unit": "hours", "value": 6 }, "window": { "unit": "months", "value": 3 } } } ] }
 
201 application/json

List Scorecards

Returns a paginated collection of scorecards.

get

Query Parameters

filterobject

Filters a collection of scorecards.

sort

Sorts a collection of scorecards. Supported sort attributes are:

  • name
  • score.value
  • score.raw_value

Default sort is name in ascending order.

Response

200 application/json

A paginated list response for a collection of scorecards.

* Additional properties are NOT allowed.
metarequired
dataarray[object]required

Representation of a scorecard.

Show Child Parameters
get/scorecards
 
200 application/json

Fetch Scorecard

Fetches a scorecard.

get

Path Parameters

idstring(uuid)required

The id of the scorecard.

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

Response

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

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

criteriaarray[object]required
Show Child Parameters
get/scorecards/{id}
 
200 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
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.

Response

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

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

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

Body

{ "name": "Incident Response", "description": "Governs key metrics pertaining to teams' incident response practices.", "entity_selector": {}, "criteria": [ {} ] }
 
200 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

204

Scorecard was deleted successfully.

delete/scorecards/{id}
 
204