Konnect Service Catalog

List Scorecard Criteria Services

Lists services targeted by a scorecard criteria with evaluation results per-service.

get

Query Parameters

filterobject

Filters a collection of services targeted by a scorecard criteria.

Show Child Parameters
sort

Sorts a collection of services targeted by a scorecard criteria. Supported sort attributes are:

  • display_name
  • name
  • evaluation.is_passing
  • evaluation.successfully_evaluated_at
  • evaluation.attempted_at

Default sort is display_name in ascending order.

Path Parameters

scorecardIdstring(uuid)required

The id of the scorecard.

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

criteriaIdstring(uuid)required

The id of the criteria.

Example:5c1121f9-3f3a-47c7-9bb6-c81a51128714

Response

200 application/json

A paginated list response for a collection of services targeted by a scorecard criteria.

* Additional properties are NOT allowed.
metarequired
dataarrayrequired

Service object that includes its evaluation result for the given scorecard criteria.

Show Child Parameters
get/scorecards/{scorecardId}/criteria/{criteriaId}/services
 
200 application/json

List Catalog Service Scorecards

Returns a paginated collection of scorecards targeting the given service.

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.

Path Parameters

idstringrequired

The id of the service.

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

Response

200 application/json

A paginated list response for a collection of scorecards targeting a service.

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

Representation of a scorecard.

Show Child Parameters
get/services/{id}/scorecards
 
200 application/json

Fetch Catalog Service Scorecard

Fetches the given scorecard targeting the service.

get

Path Parameters

serviceIdstringrequired

The id of the service.

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

scorecardIdstring(uuid)required

The id of the scorecard.

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

Response

200 application/json

A response containing a scorecard targeting a service.

CatalogServiceScorecard

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/services/{serviceId}/scorecards/{scorecardId}
 
200 application/json

CreateCatalogService

object
* Additional properties are NOT allowed.
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

descriptionstring

Optionally provide a description of the Service.

<= 2048 characters

labels
custom_fieldsobject

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

Example

UpdateCatalogService

object
* Additional properties are NOT allowed.
namestring

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_namestring

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstring

Optionally provide a description of the Service.

<= 2048 characters

labels
custom_fieldsobject

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

Example