How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

5 operations 2 paths 30 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Integration Instances API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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.

Integration Instances 5

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…

POST
/v1/integration-instances
Create Integration Instance
create-integration-instance body → 201400401403
GET
/v1/integration-instances
List Integration Instances
list-integration-instances 4 params → 200400401403
GET
/v1/integration-instances/{id}
Get an Integration Instance
fetch-integration-instance 1 param → 200401403404
PATCH
/v1/integration-instances/{id}
Update Integration Instance
update-integration-instance 1 param body → 200400401403404409
DELETE
/v1/integration-instances/{id}
Delete Integration Instance
delete-integration-instance 1 param → 204400401403404

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), InvalidParameterChoiceItem (5 properties). Each schema is shown below with its type and property counts.

BadRequestError
BaseError
object
standard error
5 properties 4 required
InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
PaginatedMeta
object
returns the pagination information
1 property 1 required
UnauthorizedError
NotFoundError
LabelsFieldFilter
IntegrationInstanceConfig
object
JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered…
IntegrationInstanceFilterParameters
object
8 properties
LabelsUpdate
object
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 me…
CreateIntegrationInstance
object
6 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
InvalidParameterStandard
object
4 properties 2 required
IntegrationRefWithoutInstance
object
Short-hand descriptor of an integration that omits instance metadata.
2 properties 2 required
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).
InvalidParameterChoiceItem
object
5 properties 4 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
Labels
object
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,…
IntegrationInstance
object
Information about an integration instance.
10 properties 9 required
InvalidParameters
array
invalid parameters
ConflictError
ForbiddenError
SortQuery
string
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 provi…
InvalidParameterDependentItem
object
5 properties 4 required
UpdateIntegrationInstance
object
5 properties
InvalidRules
string
invalid parameters rules

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-integration-instances-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API
Where this information came from

This is an independent, third-party profile of Kong Integration Instances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.