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 Customization API

APIs related to customization of Konnect Developer Portals.

Kong Portal Customization 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 Customization. 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 15 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 15 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 Customization 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 Customization 3

APIs related to customization of Konnect Developer Portals.

GET
/v3/portals/{portalId}/customization
Get Customization
get-portal-customization 1 param → 200401403404
PUT
/v3/portals/{portalId}/customization
Replace Customization
replace-portal-customization 1 param body → 200400401403404
PATCH
/v3/portals/{portalId}/customization
Update Customization
update-portal-customization 1 param body → 200400401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PortalCustomization (6 properties), InvalidParameterMinimumLength (5 properties), BaseError (5 properties), InvalidParameterMaximumLength (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
PortalFooterMenuSection
object
2 properties 2 required
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
ForbiddenError
UnauthorizedError
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
PortalCustomization
object
The custom settings of this portal
6 properties
PortalMenuItem
object
4 properties 4 required
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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