Integrations are applications, either Konnect-internal or external, which extend the functionality of the Service Catalog.Install and authorize an integration to discover the resources across your organization which support your services.Map relevant resources to your services to provide a rich view of cataloged services.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 Catalog Integrations 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 Catalog Integrations. 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
1 operation
across 1 path,
and defines 33 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}.
1 operations1 paths33 schemas1 GET
Metadata
The identity and technical contract details declared by the specification.
Kong Catalog Integrations 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 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Catalog Integrations 1
Integrations are applications, either Konnect-internal or external, which extend the functionality of the Service Catalog. Install and authorize an integration to discover the res…
GET
/v1/integrations
List Integrations
list-catalog-integrations4 params→ 200400401403
Schemas 33
The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are CatalogIntegration (12 properties), EnumConfigFieldSchema (7 properties), StringConfigFieldSchema (6 properties), BooleanConfigFieldSchema (6 properties). Each schema is shown below with its type and property counts.
InvalidParameterMinimumLength
object
5 properties4 required
GitHubAppInstallationAuth
object
Defines the GitHub App authorization strategy used by the GitHub integration. This strategy enables secure access to GitHub APIs using app installation tokens.…
2 properties2 required
CatalogIntegrationConfigSchema
Defines the configuration schema for the integration.
CatalogIntegrationFilterParameters
object
2 properties
InvalidParameterChoiceItem
object
5 properties4 required
StringConfigFieldSchema
object
Defines a string value integration config field.
6 properties1 required
InvalidParameterMaximumLength
object
5 properties4 required
ForbiddenError
UnauthorizedError
MultiKeyAuth
object
Defines an authentication strategy based on one or more API keys passed via HTTP headers. This strategy supports integrations that require custom headers for c…
2 properties2 required
CatalogIntegrationResourceTypes
object
Defines the resource types that the integration manages within the catalog. This schema is a key-value object where: - Keys are globally unique, machine-readab…
BooleanConfigFieldSchema
object
Defines a boolean value integration config field.
6 properties1 required
PaginatedMeta
object
returns the pagination information
1 property1 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
IntegrationResourceEvent
object
Defines a registered event type for a given resource.
3 properties3 required
CatalogIntegration
object
12 properties11 required
CatalogIntegrationEvents
object
Defines the event types across all resource types belonging to the integration that will be ingested into the catalog. - Keys are the machine-readable, globall…
BaseError
object
standard error
5 properties4 required
InvalidParameterDependentItem
object
5 properties4 required
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…
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
OAuth
object
Defines the OAuth 2.0 authorization strategy used by an integration. This schema provides all necessary information for the platform to initiate and manage OAu…
3 properties2 required
CatalogIntegrationApiSpecProvider
object
Defines how an integration behaves as a source provider of Catalog Service API specs. API specs are entities that can be attached to Catalog Services. When an…
5 properties5 required
MutableCondition
string
Defines the condition under which this configuration field is allowed to be modified. When specified, the platform will restrict updates to this field unless t…
InvalidParameterStandard
object
4 properties2 required
CatalogIntegrationDiscovery
object
Defines how the integration participates in Discovery. Discovery enables integrations to automatically ingest and update resources in the catalog.
1 property1 required
IntegrationResourceEvents
object
Defines the event types for a given resource type belonging to the integration that will be ingested in the catalog. - Keys are the machine-readable, globally…
EnumConfigFieldSchema
object
Defines an enum value integration config field.
7 properties2 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
CatalogIntegrationAuthorization
Defines the authorization strategy for an integration.
SimpleSchema
object
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
