idstring(uuid)required
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Fetch Scorecard
Fetches a scorecard.
get
Path Parameters
Response
200 application/json
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_selector
One Ofrequired
Variant 1
One OfAllEntitiesSelectorobject
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}
Path Parameters
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
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_selector
One Ofrequired
Variant 1
One OfAllEntitiesSelectorobject
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
criteria
One Ofarrayrequired
>= 1 items
UpdateScorecardCriteriaobject
* Additional properties are NOT allowed.
Response
200 application/json
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_selector
One Ofrequired
Variant 1
One OfAllEntitiesSelectorobject
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}
Path Parameters
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
Response
204
Scorecard was deleted successfully.
delete/scorecards/{id}
Path Parameters
204
List Scorecard Services
Lists services targeted by a scorecard.
get
Query Parameters
filterobject
Filters a collection of services targeted by a scorecard.
Show Child Parameters
sort
Sorts a collection of services targeted by a scorecard. Supported sort attributes are:
display_namenamescore.valuescore.raw_value
Default sort is display_name in ascending order.
Path Parameters
idstring(uuid)required
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
200 application/json
Response
200 application/json
A paginated list response for a collection of services targeted by a scorecard.
* Additional properties are NOT allowed.
metarequired
dataarrayrequired
Service object that includes its score for the given scorecard.
Show Child Parameters
get/scorecards/{id}/services
Path Parameters
Query Parameters
200 application/json
List Scorecard Criteria
Lists criteria, including passing service counts, belonging to a scorecard.
get
Query Parameters
filterobject
Filters a collection of criteria belonging to a scorecard.
sort
Sorts a collection of criteria belonging to a scorecard. Supported sort attributes are:
evaluation.passing_services_count
By default, criteria will be returned in the order that they are configured in the scorecard.
Path Parameters
idstring(uuid)required
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
200 application/json
Response
200 application/json
A paginated list response for a collection of criteria belonging to a scorecard.
* Additional properties are NOT allowed.
metarequired
dataarrayrequired
Show Child Parameters
get/scorecards/{id}/criteria
Path Parameters
Query Parameters
200 application/json