List Scorecard Criteria
Lists criteria, including passing service counts, belonging to a scorecard.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of criteria belonging to a scorecard.
Show Child Parameters
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
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
application/json
Response
A paginated list response for a collection of criteria belonging to a scorecard.
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
List Scorecard Criteria Services
Lists services targeted by a scorecard criteria with evaluation results per-service.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of services targeted by a scorecard criteria.
Show Child Parameters
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
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
The id of the criteria.
Example:5c1121f9-3f3a-47c7-9bb6-c81a51128714
Response
application/json
Response
A paginated list response for a collection of services targeted by a scorecard criteria.
returns the pagination information
Show Child Parameters
Service object that includes its evaluation result for the given scorecard criteria.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
List Catalog Service Scorecards
Returns a paginated collection of scorecards targeting the given service.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of scorecards.
Show Child Parameters
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
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A paginated list response for a collection of scorecards targeting a service.
returns the pagination information
Show Child Parameters
Representation of a scorecard.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get a Catalog Service Scorecard
Fetches the given scorecard targeting the service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
application/json
Response
A response containing a scorecard targeting a service.
CatalogServiceScorecard
Representation of a scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
The human-readable name of the scorecard.
Example:Incident Response
Example:Governs key metrics pertaining to teams' incident response practices.
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
One OfSelector 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"}}
One OfEntity selector that includes all entities of the given type within the catalog.
Show Child Parameters
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
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Show Child Parameters
Authentication
Path Parameters
Catalog Service API Mappings
Service API mappings represent the link between Service and API entities.
Once an API is mapped to a Service, a rich view of the linked APIs will be presented on the APIs tab of the Catalog Service.
Similarly, Services mapped to an API will be listed on the API overview page under Catalog.
An API may be mapped to multiple services, but it cannot be mapped to the same service twice.
If a mapped API is unlinked from a Service, the mapping will be deleted.