Search
K
Konnect Service Catalog

UpdateIntegrationInstance

object
* Additional properties are NOT allowed.
namestring

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_namestring

The display name of the integration instance.

>= 1 characters<= 120 characters

Example:AWS (prod)

descriptionstring

Optionally provide a description of the integration instance.

<= 2048 characters

configobject

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

IntegrationInstanceFilterParameters

object
nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
display_nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.display_nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
authorizedboolean

Filter by a boolean value (true/false).

created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

updated_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

Example

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.
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

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