Search
K
Konnect Service Catalog

UpdateCatalogService

object
* Additional properties are NOT allowed.
namestring

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

display_namestring

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstring

Optionally provide a description of the Service.

<= 2048 characters

labels
custom_fieldsobject

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"}}

Example

CatalogServiceFilterParameters

object
id
name
display_name
custom_fields

Filter 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]=kong
  • filter[custom_fields.dashboard.link][contains]=https
labels
Example

CatalogService

object

The service object contains information about a Service Catalog service.

idstring(uuid)requiredread-only

The service ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

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

display_namestringrequired

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstringrequired

Optionally provide a description of the Service.

<= 2048 characters

custom_fieldsobjectrequired

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"}}

labelsrequired
Example

CatalogIntegrationFilterParameters

object
name
Example

CatalogIntegration

object
namestringrequiredread-only

The machine name of the integration that uniquely identifies it within the catalog.

Example:gateway-manager

display_namestringrequiredread-only

The display name of the integration.

Example:Gateway Manager

descriptionstringread-only

The description of the integration.

built_inbooleanrequiredread-only

Denotes whether the integration is built-in to the catalog.
Built-in integrations are always connected and available by default.

Example:true

versionstringrequiredread-only

The integration version.

Example:v1

authorizationOne Of
required
CatalogIntegrationAuthorization

Defines the authorization strategy for an integration.

config_schemarequired

Defines the configuration schema for the integration.

Example:{"base_url":{"type":"string","display_name":"Base URL","description":"The customer-specific API URL","required":true}}

resource_typesobjectrequired

Defines the resource types that the integration manages within the catalog.

This schema is a key-value object where:

  • Keys are globally unique, machine-readable identifiers for each resource type.
  • Values are objects describing metadata about the resource type.

This declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.
By registering resource types, integrations communicate the kinds of entities they will ingest and maintain,
allowing the catalog to enforce consistency, validation, and visibility across all integrations.

Example:{"gateway_svc":{"display_name":"Gateway Service","schema":{"type":"simple","definition":{"control_plane_id":"string","gatway_service_id":"string"}}},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}}}}

discoveryobjectrequired

Defines how the integration participates in Discovery.
Discovery enables integrations to automatically ingest and update resources in the catalog.

Show Child Parameters
api_spec_providerobjectrequired

Defines how an integration behaves as a source provider of Catalog Service API specs.
API specs are entities that can be attached to Catalog Services.
When an integration implements this capability, it can act as a source type for API spec contents.
In this role, the integration becomes the source of truth for the spec.
When a spec is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the spec data.
A null value indicates the given integration does not act as a source provider of API specs.

Show Child Parameters
eventsobjectrequired

Defines the event types across all resource types belonging to the integration that will be ingested into the catalog.

  • Keys are the machine-readable, globally unique names of resource types registered by this integration.
  • Values are a map of event type definitions.

Example:{"gateway_svc":{"plugin_added":{"display_name":"Plugin Added","description":"Event triggered when a new plugin is added to a gateway service.","events_feed":{"enabled":true}}}}

Example