Search
K
Konnect Service Catalog

CatalogIntegrationEvents

object

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

IntegrationResourceEvents

object

Defines the event types for a given resource type belonging to the integration that will be ingested in the catalog.

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

IntegrationResourceEvent

object

Defines a registered event type for a given resource.

display_namestringrequired

User-friendly display name for the event type.

descriptionstringrequired

Optional, brief description of the integration event type.

events_feedobjectrequired
Show Child Parameters
Example

CreateCatalogIntegration

One Of
visibilitystringrequired

Allowed values:private

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"}},"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}","integration_data_schema":null},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}},"resource_id_template":"{{dashboard_id}}","integration_data_schema":null}}

descriptionstringrequired

Description of the integration.

<= 2048 characters

display_namestringrequired

The display name of the integration.

>= 1 characters<= 120 characters

Example:My Integration

Example

CreatePrivateCatalogIntegration

object
* Additional properties are NOT allowed.
visibilitystringrequired

Allowed values:private

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"}},"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}","integration_data_schema":null},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}},"resource_id_template":"{{dashboard_id}}","integration_data_schema":null}}

descriptionstringrequired

Description of the integration.

<= 2048 characters

display_namestringrequired

The display name of the integration.

>= 1 characters<= 120 characters

Example:My Integration

Example