Search
K
Konnect Service Catalog

List Scorecard Services

Lists services targeted by a scorecard.

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 services targeted by a scorecard.

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

Path Parameters

idstring(uuid)required

The id of the scorecard.

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

Response

application/json

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

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Service object that includes its score for the given scorecard.

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

List Scorecard Criteria

Lists criteria, including passing service counts, belonging to a scorecard.

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 criteria belonging to a scorecard.

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

Path Parameters

idstring(uuid)required

The id of the scorecard.

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

Response

application/json

A paginated list response for a collection of criteria belonging to a scorecard.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

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

List Scorecard Criteria Services

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

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 services targeted by a scorecard criteria.

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

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

application/json

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

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

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

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

List Catalog Service Scorecards

Returns a paginated collection of scorecards targeting the given service.

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

Path Parameters

idstringrequired

The id of the service.

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

Response

application/json

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

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Representation of a scorecard.

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

Get a 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

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