Kong Scorecards API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Scorecards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes
11 operations
across 8 paths,
and defines 78 schemas.
It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
The identity and technical contract details declared by the specification.
ScorecardTemplate
object
Representation of a scorecard template.
4 properties
4 required
InvalidParameterChoiceItem
object
5 properties
4 required
ByLabelSelector
object
Entity selector that includes entities by label value.
2 properties
2 required
ScorecardServiceFilterParameters
object
9 properties
HasSelectorParams
object
2 properties
2 required
ScorecardService
object
Service object that includes its score for the given scorecard.
9 properties
9 required
CreateScorecardCriteria
object
5 properties
4 required
ByDisplayNameSelector
object
Entity selector that includes entities by displayname.
2 properties
2 required
Labels
object
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,…
CriteriaParameters
object
Input parameters for the given criteria template. The available parameters, and its schema, are found on the criteria template definition via the schema proper…
ByNameSelector
object
Entity selector that includes entities by name.
2 properties
2 required
NumericCustomField
number
AllEntitiesSelector
object
Entity selector that includes all entities of the given type within the catalog.
2 properties
2 required
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).
CriteriaEvaluationRelationMap
object
3 properties
3 required
StringSelectorOperator
string
ScorecardTemplateCriteria
object
4 properties
4 required
CatalogServiceScorecard
object
Representation of a scorecard.
9 properties
9 required
ScorecardWithCriteria
object
Representation of a scorecard.
9 properties
9 required
Scorecard
object
Representation of a scorecard.
8 properties
8 required
InvalidParameterMinimumLength
object
5 properties
4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterMaximumLength
object
5 properties
4 required
HasDocsSelector
object
Entity selector to include entities by attached documentation.
2 properties
2 required
HasResourcesSelector
object
Entity selector that includes services by mapped resources.
2 properties
2 required
ScorecardScore
object
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.
2 properties
2 required
ScorecardCriteriaFilterParameters
object
1 property
ScorecardCriteriaService
object
Service object that includes its evaluation result for the given scorecard criteria.
9 properties
9 required
PaginatedMeta
object
returns the pagination information
1 property
1 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties
4 required
ByCustomFieldSelector
object
Entity selector that include entities by a custom field.
2 properties
2 required
BooleanSelectorOperator
string
ByIDsSelector
object
Entity selector that includes entities contained within a list of IDs.
2 properties
2 required
TimeValue
object
Represents a time value inclusive of units.
2 properties
2 required
CatalogServiceScorecardCriteria
object
11 properties
11 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties
3 required
UpdateScorecardCriteria
object
6 properties
5 required
ScorecardEntitySelector
object
Selector used to dynamically target catalog entities that will be included in the given scorecard's evaluated score.
CriteriaEvaluationResultDetails
object
Provides additional metadata about the criteria evaluation result.
2 properties
2 required
ScorecardCriteriaEvaluation
object
1 property
1 required
CatalogResourceType
string
The resource type. Available resource types are compiled from the integrations installed within the catalog.
CustomFields
object
Map of customizable, catalog-defined fields providing information about a service.
ScorecardCriteriaServiceEvaluation
object
Evaluation for a scorecard criteria relative to the given service service. Has a null value when the criteria has not yet been evaluated for the service.
6 properties
6 required
ScorecardTemplateName
string
Well-known name of the template. Uniquely identifies the template.
SortQuery
string
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 provi…
InvalidRules
string
invalid parameters rules
ScorecardCriteriaServiceFilterParameters
object
10 properties
HasApisSelector
object
Entity selector that includes services by attached APIs.
2 properties
2 required
InvalidParameters
array
invalid parameters
HasRelationshipSelectorOperator
string
BooleanCustomField
boolean
UrlCustomField
object
2 properties
2 required
ScorecardCriteriaWithEvaluation
object
11 properties
11 required
StringFieldSelectorParams
object
2 properties
2 required
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
HasLabelKeySelector
object
Entity selector that includes entities by inclusion of a label key.
2 properties
2 required
ScorecardFilterParameters
object
3 properties
CriteriaEvaluationErrorResult
object
2 properties
2 required
ScorecardTemplateFilterParameters
object
2 properties
UpdateScorecard
object
5 properties
5 required
InvalidParameterDependentItem
object
5 properties
4 required
CriteriaEvaluationRelationResult
object
3 properties
3 required
ScorecardCriteria
object
10 properties
10 required
NumericFieldFilter
Filter by a numeric value.
InvalidParameterStandard
object
4 properties
2 required
NumberSelectorOperator
string
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
CriteriaTemplateName
string
Reference to the unique name of the criteria template.
CreateScorecard
object
5 properties
5 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kong publishes across the network.
