Search
K
Konnect Service Catalog

BooleanConfigFieldSchema

display_namestring

user-friendly name of the configuration field.

descriptionstring

Optional brief description of the configuration field.

requiredboolean

Denotes whether the config field is a required value.

Default:false

mutable_conditionstring

Defines the condition under which this configuration field is allowed to be modified.
When specified, the platform will restrict updates to this field unless the integration
meets the given condition.

For example, setting mutable_condition: unauthorized means the field can only be
changed while the integration is in an unauthorized state.

Allowed values:unauthorized

typestringrequired

The field type of the config value.

Allowed values:boolean

defaultboolean

The default value for the config field.

Example

BaseConfigFieldSchema

object
display_namestring

user-friendly name of the configuration field.

descriptionstring

Optional brief description of the configuration field.

requiredboolean

Denotes whether the config field is a required value.

Default:false

mutable_conditionstring

Defines the condition under which this configuration field is allowed to be modified.
When specified, the platform will restrict updates to this field unless the integration
meets the given condition.

For example, setting mutable_condition: unauthorized means the field can only be
changed while the integration is in an unauthorized state.

Allowed values:unauthorized

Example

MutableCondition

string

Defines the condition under which this configuration field is allowed to be modified.
When specified, the platform will restrict updates to this field unless the integration
meets the given condition.

For example, setting mutable_condition: unauthorized means the field can only be
changed while the integration is in an unauthorized state.

Allowed values:unauthorized

CatalogIntegrationResourceTypes

object

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

CatalogIntegrationDiscovery

object

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

resource_attribute_examplesobjectrequired

A map of example resource attributes payloads by resource type.

  • Keys are the machine-readable, globally unique names of resource types registered by this integration.
  • Values are example attributes payloads.

Example:{"gateway_service":{"control_plane":{"id":"00000000-0000-0000-0000-000000000000","name":"dev-ext","labels":{"env":"development"}},"gateway_service":{"id":"11111111-1111-1111-1111-111111111111","name":"gateway-service","host":"konghq.com","path":"/example","type":"service","port":443,"protocol":"https","enabled":true}}}

Example