serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
scorecardIdstring(uuid)required
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Get a Catalog Service Scorecard
Fetches the given scorecard targeting the service.
get
Path Parameters
Response
application/json
Response
application/json
A response containing a scorecard targeting a service.
CatalogServiceScorecard
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 Ofobject | nullrequired
Selector 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"}}
ServiceSelector
One OfAllEntitiesSelectorobject
Entity selector that includes all entities of the given type within the catalog.
Show Child Parameters
scorecard_templatestring | nullrequired
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
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
criteriaarray[object]required
Show Child Parameters
get/catalog-services/{serviceId}/scorecards/{scorecardId}
Authentication
Path Parameters
application/json
Resource Ingestion
Get details and trigger resource ingestion from authorized integrations.
Resource ingestion allows for manually syncing resources from authorized integrations.
It provides details on when the resources were last synced from an authorized integration.
Schedule Resource Ingestion
Schedules a resource ingestion job for the given integration instance.
put
Path Parameters
integrationInstanceIdstringrequired
The id of the integration instance.
Example:004d6d17-d21f-4518-89a2-b9177cb5485c
Body
application/json
Body
application/json
ScheduleResourceIngestion
* Additional properties are NOT allowed.
ingest_fromstring(date-time)
A timestamp indicating when to start ingestion from.
RFC-3339 format is used with a “T” character separating date from time within the field value.
Omitting this property indicates ingestion will be triggered from the beginning of time until the present.
Response
application/json
Response
application/json
A response containing the resource ingestion status.
ResourceIngestionStatus
The resource ingestion status.
* Additional properties are NOT allowed.
last_scheduledstring | null(date-time)required
The timestamp denoting when the last ingestion job was run.
RFC-3339 format is used with a “T” character separating date from time within the field value.
A null value denotes that ingestion for the given integration was never run.
put/integration-instances/{integrationInstanceId}/resource-ingestion
Authentication
Path Parameters
Body
{
"ingest_from": "2025-07-01T00:00:00Z"
}
application/json
Get a Resource Ingestion
Fetches a resource ingestion job for the given integration instance.
get
Path Parameters
integrationInstanceIdstringrequired
The id of the integration instance.
Example:004d6d17-d21f-4518-89a2-b9177cb5485c
Response
application/json
Response
application/json
A response containing the resource ingestion status.
ResourceIngestionStatus
The resource ingestion status.
* Additional properties are NOT allowed.
last_scheduledstring | null(date-time)required
The timestamp denoting when the last ingestion job was run.
RFC-3339 format is used with a “T” character separating date from time within the field value.
A null value denotes that ingestion for the given integration was never run.
get/integration-instances/{integrationInstanceId}/resource-ingestion
Authentication
Path Parameters
application/json
Resource Actions
Resource actions provides an overview of actions taken on resources.
It provides information on when one of the following actions are taken on a resource:
- Map
- Unmap
- Archive
- Restore