Search
K
Konnect Service Catalog

List Resource Services

Returns a paginated collection of services the given resource is mapped to.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters a collection of services.

Show Child Parameters
sortstring

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 provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

Path Parameters

idstringrequired

The id of the resource.

Example:AflTNLY0tTQhv2my

Response

application/json

A paginated list response for a collection of services.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

The service object contains information about a Service Catalog service.

Show Child Parameters
get/resources/{id}/catalog-services
 
application/json

Criteria Templates

Several criteria templates are provided to help ensure your services adhere to industry best practices.
A criteria template is a collection of criteria grouped together to target various categories.

Criteria may require a specific type of integration be installed and authorized.
For example, criteria which evaluates the operation performance across incident management may require a integration related to incident management to be installed and authorized.
Learn more about scorecards by visiting our documentation.

List Criteria Templates

Returns a paginated collection of criteria templates.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters a collection of criteria templates.

Show Child Parameters
sortstring

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 provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

Response

application/json

A paginated list response for a collection of criteria templates.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Representation of a criteria template.

Show Child Parameters
get/criteria-templates
 
application/json

Scorecards

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.

List Scorecard Templates

Returns a paginated collection of scorecard templates.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters a collection of scorecard templates.

Show Child Parameters
sortstring

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 provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

Response

application/json

A paginated list response for a collection of scorecard templates.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Representation of a scorecard template.

Show Child Parameters
get/scorecard-templates
 
application/json