How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Scorecards API

A scorecard helps you evaluate services based on its criteria.Scorecards help you detect issues, like whether there are services in the catalog that don't have an on-call engineer assigned, or if you have GitHub repositories with stale pull requests that aren't getting reviewed or closed.From the scorecard, you can view details on either a per-service or per-criteria basis.Learn more about scorecards by visiting our [documentation](https://developer.konghq.com/service-catalog/scorecards/).

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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

11 operations 8 paths 78 schemas 1 DELETE8 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Scorecards API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 8 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Scorecards 11

A scorecard helps you evaluate services based on its criteria. Scorecards help you detect issues, like whether there are services in the catalog that don't have an on-call enginee…

GET
/v1/catalog-services/{id}/scorecards
List Catalog Service Scorecards
list-catalog-service-scorecards 5 params → 200400401403404
GET
/v1/catalog-services/{serviceId}/scorecards/{scorecardId}
Get a Catalog Service Scorecard
fetch-catalog-service-scorecard 2 params → 200400401403404
GET
/v1/scorecard-templates
List Scorecard Templates
list-scorecard-templates 4 params → 200400401403
POST
/v1/scorecards
Create Scorecard
create-scorecard body → 201400401403
GET
/v1/scorecards
List Scorecards
list-scorecards 4 params → 200400401403
GET
/v1/scorecards/{id}
Get a Scorecard
fetch-scorecard 1 param → 200401403404
PUT
/v1/scorecards/{id}
Update Scorecard
update-scorecard 1 param body → 200400401403404
DELETE
/v1/scorecards/{id}
Delete Scorecard
delete-scorecard 1 param → 204401403404
GET
/v1/scorecards/{id}/catalog-services
List Scorecard Services
list-scorecard-services 5 params → 200401403404
GET
/v1/scorecards/{id}/criteria
List Scorecard Criteria
list-scorecard-criteria 5 params → 200401403404
GET
/v1/scorecards/{scorecardId}/criteria/{criteriaId}/catalog-services
List Scorecard Criteria Services
list-scorecard-criteria-services 6 params → 200401403404

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are CatalogServiceScorecardCriteria (11 properties), ScorecardCriteriaWithEvaluation (11 properties), ScorecardCriteria (10 properties), ScorecardCriteriaServiceFilterParameters (10 properties). Each schema is shown below with its type and property counts.

CatalogServiceScorecard
object
Representation of a scorecard.
9 properties 9 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
ScorecardCriteriaServiceFilterParameters
object
10 properties
StringSelectorOperator
string
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
LabelsFieldFilter
NotFoundError
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
HasDocsSelector
object
Entity selector to include entities by attached documentation.
2 properties 2 required
InvalidParameterMaximumLength
object
5 properties 4 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NumericCustomField
number
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameters
array
invalid parameters
ScorecardWithCriteria
object
Representation of a scorecard.
9 properties 9 required
ScorecardEntitySelector
object
Selector used to dynamically target catalog entities that will be included in the given scorecard's evaluated score.
CriteriaTemplateName
string
Reference to the unique name of the criteria template.
ByDisplayNameSelector
object
Entity selector that includes entities by displayname.
2 properties 2 required
Scorecard
object
Representation of a scorecard.
8 properties 8 required
HasLabelKeySelector
object
Entity selector that includes entities by inclusion of a label key.
2 properties 2 required
ByCustomFieldSelector
object
Entity selector that include entities by a custom field.
2 properties 2 required
InvalidRules
string
invalid parameters rules
ScorecardServiceFilterParameters
object
9 properties
BadRequestError
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
BooleanSelectorOperator
string
ScorecardCriteriaFilterParameters
object
1 property
UrlCustomField
object
2 properties 2 required
ScorecardTemplateFilterParameters
object
2 properties
CatalogServiceScorecardCriteria
object
11 properties 11 required
HasApisSelector
object
Entity selector that includes services by attached APIs.
2 properties 2 required
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).
CreateScorecardCriteria
object
5 properties 4 required
ScorecardFilterParameters
object
3 properties
CreateScorecard
object
5 properties 5 required
ByNameSelector
object
Entity selector that includes entities by name.
2 properties 2 required
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…
ForbiddenError
UpdateScorecardCriteria
object
6 properties 5 required
ScorecardCriteriaWithEvaluation
object
11 properties 11 required
ByLabelSelector
object
Entity selector that includes entities by label value.
2 properties 2 required
StringFieldSelectorParams
object
2 properties 2 required
BaseError
object
standard error
5 properties 4 required
CriteriaEvaluationErrorResult
object
2 properties 2 required
PaginatedMeta
object
returns the pagination information
1 property 1 required
UnauthorizedError
ScorecardCriteriaEvaluation
object
1 property 1 required
HasRelationshipSelectorOperator
string
CatalogResourceType
string
The resource type. Available resource types are compiled from the integrations installed within the catalog.
ByIDsSelector
object
Entity selector that includes entities contained within a list of IDs.
2 properties 2 required
CriteriaEvaluationResultDetails
object
Provides additional metadata about the criteria evaluation result.
2 properties 2 required
TimeValue
object
Represents a time value inclusive of units.
2 properties 2 required
CriteriaEvaluationRelationResult
object
3 properties 3 required
ServiceSelector
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,…
NumberSelectorOperator
string
HasResourcesSelector
object
Entity selector that includes services by mapped resources.
2 properties 2 required
ScorecardTemplate
object
Representation of a scorecard template.
4 properties 4 required
ScorecardTemplateName
string
Well-known name of the template. Uniquely identifies the template.
AllEntitiesSelector
object
Entity selector that includes all entities of the given type within the catalog.
2 properties 2 required
InvalidParameterDependentItem
object
5 properties 4 required
ScorecardTemplateCriteria
object
4 properties 4 required
CustomFields
object
Map of customizable, catalog-defined fields providing information about a service.
ScorecardCriteria
object
10 properties 10 required
InvalidParameterMinimumLength
object
5 properties 4 required
CriteriaEvaluationRelationMap
object
3 properties 3 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
BooleanCustomField
boolean
UpdateScorecard
object
5 properties 5 required
NumericFieldFilter
Filter by a numeric value.
HasSelectorParams
object
2 properties 2 required
InvalidParameterStandard
object
4 properties 2 required
TextCustomField
string
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
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
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…
ScorecardService
object
Service object that includes its score for the given scorecard.
9 properties 9 required
ScorecardCriteriaService
object
Service object that includes its evaluation result for the given scorecard criteria.
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-scorecards-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API
Where this information came from

This is an independent, third-party profile of Kong Scorecards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.