List Integrations
Returns a paginated collection of all catalog integrations available to connect. Each integration represents a built-in connector that extends the platform's capabilities; enabling discovery, resource management, event ingestion, and more. Integrations expose metadata that describes how they authenticate, what configuration they require, and how they interact with catalog entities like Resources and Services.
Currently, integrations are platform-defined and cannot be extend or registered by customers.
Query parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Determines which page of the entities to retrieve.
Filters a collection of integrations.
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').
Sorts a collection of integrations. Supported sort attributes are:
- display_name
- name
Default sort is display_name in ascending order.
Response
A paginated list response for a collection of integrations.
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"name": "gateway-manager",
"display_name": "Gateway Manager",
"built_in": true,
"version": "v1",
"visibility": "public",
"authorization": {
"config": {
"client_id": "d745213a-b7e8-4998-abe3-41f164001970",
"authorization_endpoint": {
"url": "https://identity.service.com/oauth/authorize"
},
"token_endpoint": {
"url": "https://identity.service.com/oauth/token"
},
"scope": [
"read",
"write"
],
"rolling_refresh_exp_seconds": 15780000
}
},
"config_schema": {
"base_url": {
"type": "string",
"display_name": "Base URL",
"description": "The customer-specific API URL",
"required": true
}
},
"resource_types": {
"gateway_svc": {
"display_name": "Gateway Service",
"schema": {
"type": "simple",
"definition": {
"control_plane_id": "string",
"gatway_service_id": "string"
}
}
},
"analytics_dashboard": {
"display_name": "Dashboard",
"schema": {
"type": "simple",
"definition": {
"dashboard_id": "string"
}
}
}
},
"discovery": {
"resource_integration_data_examples": {
"gateway_service": {
"control_plane": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "dev-ext",
"labels": {
"env": "development"
}
},
"gateway_service": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "gateway-service",
"host": "konghq.com",
"path": "/example",
"type": "service",
"port": 443,
"protocol": "https",
"enabled": true
}
}
}
},
"api_spec_provider": {
"name": "konnect_api",
"display_name": "Konnect API",
"config_schema": {
"type": "simple",
"definition": {
"api_id": "string"
}
}
},
"events": {
"gateway_svc": {
"plugin_added": {
"display_name": "Plugin Added",
"description": "Event triggered when a new plugin is added to a gateway service.",
"events_feed": {
"enabled": true
}
}
}
}
}
]
}