List Integration Instances
Returns a paginated collection of integration instances.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of integration instances.
Show Child Parameters
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Response
application/json
Response
A paginated list response for a collection of integration instances.
returns the pagination information
Show Child Parameters
Information about an integration instance.
Show Child Parameters
Authentication
Query Parameters
Get an Integration Instance
Fetches a integration instance.
Path Parameters
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Response
application/json
Response
A response containing a single integration instance object.
IntegrationInstance
Information about an integration instance.
The integration instance ID.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
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
The display name of the integration instance.
>= 1 characters<= 120 characters
Example:AWS (prod)
The description of the integration instance.
<= 2048 characters
Short-hand descriptor of an integration that omits instance metadata.
Show Child Parameters
Denotes whether the integration instance has been authorized within the catalog.
Example:true
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Integration Instance
Updates an integration instance.
Path Parameters
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Body
application/json
Body
UpdateIntegrationInstance
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
The display name of the integration instance.
>= 1 characters<= 120 characters
Example:AWS (prod)
Optionally provide a description of the integration instance.
<= 2048 characters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
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"}
Response
application/json
Response
A response containing a single integration instance object.
IntegrationInstance
Information about an integration instance.
The integration instance ID.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
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
The display name of the integration instance.
>= 1 characters<= 120 characters
Example:AWS (prod)
The description of the integration instance.
<= 2048 characters
Short-hand descriptor of an integration that omits instance metadata.
Show Child Parameters
Denotes whether the integration instance has been authorized within the catalog.
Example:true
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete Integration Instance
Deletes an integration instance.
Path Parameters
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Response
Response
Integration Instance was deleted successfully.
Authentication
Path Parameters
Integration Instance Auth Credentials
Represents the credentials use to authorize an integration instance.
You will want to configure the integration instance settings and authorization configuration before authorizing the instance.
This will inform the authorization process on how to reach and authorize the account.
Once the integration instance is authorized, the system will automatically discover all the relevant resources from the account.
The integration instance’s auth credentials can be removed or updated while retaining all resources which have already been discovered.