CatalogServiceScorecard
objectRepresentation 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
ScorecardEntitySelector
objectSelector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.
One OfOne OfEntity selector that includes all entities of the given type within the catalog.
Show Child Parameters
ScorecardScore
objectThe current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.
The human-readable score value coverted to the Scorecard’s assigned grading system.
Example:88%
The raw, numeric score calculated during evaluation of the scorecard.
Rounded to 3 decimal places.
>= 0<= 100
Example:87.5
ScorecardServiceFilterParameters
objectFilter using one of the following operators: eq, oeq, neq
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter by custom fields using dot-notation to specify the custom field.
Filter operators are dictated by the custom field type. For example:
filter[custom_fields.owner]filter[custom_fields.owner][neq]=kongfilter[custom_fields.dashboard.link][contains]=https
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
One OfOne OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfOne OfFilter by a numeric value.
Value strictly equals the given numeric value.
Example:21
ScorecardService
objectService object that includes its score for the given scorecard.
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
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"}}
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
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
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.