Search
K
Konnect Service Catalog

SimpleSchema

object
typestringrequired

Allowed values:simple

definitionobjectrequired
Example

CatalogServiceRef

object

Short-hand descriptor of a catalog service.

idstring(uuid)required

The service ID.

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

namestringrequired

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

Example:user-svc

display_namestringrequired

The display name of the service.

Example:User Service

Example

IntegrationRef

object

Short-hand descriptor of an integration installed within the catalog.

namestringrequired

Example:gateway-manager

display_namestringrequired

Example:gateway-manager

instanceobjectrequired

Short-hand descriptor of an integration instance.

Show Child Parameters
Example

IntegrationRefWithoutInstance

object

Short-hand descriptor of an integration that omits instance metadata.

namestringrequired

Example:gateway-manager

display_namestringrequired

Example:gateway-manager

Example

IntegrationInstanceRef

object

Short-hand descriptor of an integration instance.

idstring(uuid)required

The integration instance ID.

Example:772b9caf-ddbc-4f4f-8aa4-8dfbbe420351

namestringrequired

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

Match pattern:^[0-9a-z.-]+$

Example:aws-lambda-prod

display_namestringrequired

The display name of the integration instance.

Example:AWS (prod)

Example