Kong Integration Instances API
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](https://developer.konghq.com/service-catalog/integrations/).
Kong Integration Instances API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Integration Instances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes 5 operations across 2 paths, and defines 30 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Kong Integration Instances API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Kong-Admin-Token (adminToken).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
An integration instance represents a specific account of the integration which contains the resources used to manage and support your services. Some integrations provide configura…
Schemas 30
The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are IntegrationInstance (10 properties), IntegrationInstanceFilterParameters (8 properties), CreateIntegrationInstance (6 properties), InvalidParameterDependentItem (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kong 12
Other APIs Kong publishes across the network.