Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Portal Integrations API

APIs to configure Konnect Developer Portal integrations.

Kong Portal 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 Portal 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 3 operations across 1 path, and defines 20 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}.

3 operations 1 paths 20 schemas 1 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Portal 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 3

Across 1 path, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Portal Integrations 3

APIs to configure Konnect Developer Portal integrations.

GET
/v3/portals/{portalId}/integrations
Get Portal Integration Configurations
get-portal-integrations 1 param → 200401403404
PUT
/v3/portals/{portalId}/integrations
Replace Integration Configurations
upsert-portal-integrations 1 param body → 200400401403404
PATCH
/v3/portals/{portalId}/integrations
Update Integration Configurations
update-portal-integrations 1 param body → 200400401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are GoogleTagManagerIntegrationConfigProperties (9 properties), InvalidParameterDependentItem (5 properties), InvalidParameterChoiceItem (5 properties), InvalidParameterMinimumLength (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
InvalidParameterChoiceItem
object
5 properties 4 required
UpdatePortalIntegrations
object
Partially update configuration data for Dev Portal integrations
2 properties
InvalidParameterMaximumLength
object
5 properties 4 required
PortalIntegrations
object
Configuration data for Dev Portal integrations
2 properties
ForbiddenError
UnauthorizedError
GoogleTagManagerIntegration
object
Google Tag Manager integration configuration
3 properties 3 required
GoogleAnalytics4Integration
object
Google Analytics integration configuration
3 properties 3 required
GoogleTagManagerIntegrationConfigProperties
object
Configuration data for the Google Tag Manager integration
9 properties
GoogleAnalytics4IntegrationConfigProperties
object
Configuration data for the Google Analytics integration
2 properties
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
UpdateGoogleAnalytics4Integration
object
Partially update Google Analytics 4 integration configuration
3 properties
InvalidParameterStandard
object
4 properties 2 required
NotFoundError
UpdateGoogleTagManagerIntegration
object
Partially update Google Tag Manager integration configuration
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-portal-integrations-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