Search
K
Konnect Service Catalog

Create Integration Instance

Creates an integration instance.

post

Body

application/json

CreateIntegrationInstance

* Additional properties are NOT allowed.
integration_namestringrequired

The type of integration instance to create.

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

>= 1 characters<= 120 characters

Example:aws-lambda

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)

descriptionstring | null

Optionally provide a description of the integration instance.

<= 2048 characters

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.

Response

201 application/json

A response containing a single integration instance object.

IntegrationInstance

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)

descriptionstring | nullrequired

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.
post/integration-instances

Body

{ "integration_name": "aws-lambda", "name": "aws-lambda-prod", "display_name": "AWS (prod)", "config": { "account_region": "eu" } }
 
201 application/json

List Integration Instances

Returns a paginated collection of integration instances.

get

Query Parameters

filterobject

Filters a collection of integration instances.

sort

Sorts a collection of integration instances. Supported sort attributes are:

  • display_name
  • name
  • created_at
  • updated_at
  • integration.display_name

Default sort is integration.display_name in ascending order.

Response

200 application/json

A paginated list response for a collection of integration instances.

* Additional properties are NOT allowed.
metarequired
dataarray[object]required

Information about an integration instance.

Show Child Parameters
get/integration-instances
 
200 application/json

Fetch Integration Instance

Fetches a integration instance.

get

Path Parameters

idstringrequired

The id of the integration instance.

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

Response

200 application/json

A response containing a single integration instance object.

IntegrationInstance

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)

descriptionstring | nullrequired

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.
get/integration-instances/{id}
 
200 application/json

Update Integration Instance

Updates an integration instance.

patch

Path Parameters

idstringrequired

The id of the integration instance.

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

Body

application/json

UpdateIntegrationInstance

* 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 | null

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.

Response

200 application/json

A response containing a single integration instance object.

IntegrationInstance

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)

descriptionstring | nullrequired

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.
patch/integration-instances/{id}

Body

{}
 
200 application/json

Delete Integration Instance

Deletes an integration instance.

delete

Path Parameters

idstringrequired

The id of the integration instance.

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

Response

204

Integration Instance was deleted successfully.

delete/integration-instances/{id}
 
204