integrationstringrequired
The name of the integration.
Example:jira
Delete Integration
Deletes a catalog integration.
delete
Path Parameters
Response
Response
Catalog Integration was deleted successfully.
delete/integrations/{integration}
Authentication
Path Parameters
Integration Instances
An integration instance represents a specific account of the integration which contains the resources used to manage and support your services.
Some integrations provide configuration options to customize how it should behave once authorized (see the integration’s manifest for details).
Konnect-internal integrations are built-in and do not need to be installed.
Once an integration instance is created, authorize the instance to allow the Service Catalog to discover its resources.
Note that deleting an integration instance is a destructive operation.
When an integration instance is deleted, all its resources and mappings will be deleted from the service catalog.
In cases where the integration instance’s credentials need to be updated, you may re-authorize the instance to retain all currently discovered resources and mappings.
To set up and view a list of all the integrations we support, please view our documentation.
Create Integration Instance
Creates an integration instance.
post
Body
application/json
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
application/json
Response
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.
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
post/integration-instances
Authentication
Body
{
"integration_name": "swaggerhub",
"name": "swaggerhub-internal",
"display_name": "SwaggerHub (Internal)",
"description": "Swaggerhub account which hosts internal APIs only.",
"config": {}
}
application/json
List Integration Instances
Returns a paginated collection of integration instances.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[number]integer
Determines which page of the entities to retrieve.
Example:1
filterobject
Filters a collection of integration instances.
Show Child Parameters
sortstring
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
application/json
A paginated list response for a collection of integration instances.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
Information about an integration instance.
Show Child Parameters
get/integration-instances
Authentication
Query Parameters
application/json
Get an Integration Instance
Fetches a integration instance.
get
Path Parameters
idstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Response
application/json
Response
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.
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
get/integration-instances/{id}
Authentication
Path Parameters
application/json