Search
K
Konnect Service Catalog

IntegrationInstanceFilterParameters

object

IntegrationInstance

object

Information about an integration instance.

idstring(uuid)requiredread-only

The integration instance ID.

Example:3f51fa25-310a-421d-bd1a-007f859021a3

namestringrequired

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

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

>= 1 characters<= 120 characters

Example:aws-lambda-prod

display_namestringrequired

The display name of the integration instance.

>= 1 characters<= 120 characters

Example:AWS (prod)

descriptionstringrequired

The description of the integration instance.

<= 2048 characters

integrationobjectrequired

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

Show Child Parameters
authorizedbooleanrequiredread-only

Denotes whether the integration instance has been authorized within the catalog.

Example:true

configobjectrequired

JSON object representing configuration specific to the integration instance.
The expected schema depends on the integration type and is dynamically registered at runtime.

Default:{}

Example:{"account_region":"eu"}

* Additional properties are allowed.
Example

IntegrationInstanceConfig

object

JSON object representing configuration specific to the integration instance.
The expected schema depends on the integration type and is dynamically registered at runtime.

Default:{}

* Additional properties are allowed.
Example

CreateIntegrationInstanceAuthCredential

One Of
typestringrequired

Allowed values:oauth

configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

IntegrationInstanceAuthCredential

Object containing metadata for an integration instance auth credential.

One Of
idstring(base64url)required

The resource ID.

>= 16 characters<= 16 characters

Example:4UdXnoaDYYJsH_Ir

integration_instanceobjectrequired

Short-hand descriptor of an integration instance.

Show Child Parameters
missing_permissionsarray[object]required

List of detected missing permissions required to enable the full functionality of the given integration instance.

Show Child Parameters
taintedbooleanrequired

Indicates that the credential is no longer valid and must be replaced with a new valid credential.

expires_atstring(date-time)required

Timestamp denoting when the when the credential will expire in RFC-3339 format with a “T” character separating date from time within the field value.
When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.

A null value indicates no known expiration time.

Example:2025-04-01T07:20:50Z

created_atrequired
typestringrequired

Allowed values:oauth

Example