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

APIs related to configuration of Konnect Developer Portals.

Kong Portals 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 Portals. 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 24 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}.

5 operations 2 paths 24 schemas 1 DELETE2 GET1 PATCH1 POST

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 Portals 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 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.

Portals 5

APIs related to configuration of Konnect Developer Portals.

GET
/v3/portals
List Portals
list-portals 4 params → 200400401403
POST
/v3/portals
Create Portal
create-portal body → 201400401403
GET
/v3/portals/{portalId}
Get a Portal
get-portal 1 param → 200401403404
PATCH
/v3/portals/{portalId}
Update Portal
update-portal 1 param body → 200400401403404409
DELETE
/v3/portals/{portalId}
Delete Portal
delete-portal 2 params → 204401403404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are PortalFilterParameters (12 properties), StringFieldFilter (5 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
ConflictError
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
UUID
string
Contains a unique identifier used for this resource.
PortalFilterParameters
object
12 properties
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,…
ForbiddenError
UnauthorizedError
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…
PaginatedMeta
object
returns the pagination information
1 property 1 required
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.
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
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-portals-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