Create Scorecard
Creates a scorecard.
Body
application/json
Body
CreateScorecard
The human-readable name of the scorecard.
Example:Incident Response
Example:Governs key metrics pertaining to teams' incident response practices.
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
>= 1 items
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
Response
application/json
Response
A response containing a single scorecard.
ScorecardWithCriteria
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
Body
List Scorecards
Returns a paginated collection of scorecards.
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
Response
application/json
Response
A paginated list response for a collection of scorecards.
returns the pagination information
Show Child Parameters
Representation of a scorecard.
Show Child Parameters
Authentication
Query Parameters
Get a Scorecard
Fetches a scorecard.
Path Parameters
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
application/json
Response
A response containing a single scorecard.
ScorecardWithCriteria
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
Update Scorecard
Updates a scorecard.
Path Parameters
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Body
application/json
Body
UpdateScorecard
The human-readable name of the scorecard.
Example:Incident Response
Example:Governs key metrics pertaining to teams' incident response practices.
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
One Of>= 1 items
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
Response
application/json
Response
A response containing a single scorecard.
ScorecardWithCriteria
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
Body
Delete Scorecard
Deletes a scorecard.
Path Parameters
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
Response
Scorecard was deleted successfully.