How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 Portal. 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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

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.2.0
API Version
3.14.0
Base URL
https://global.api.konghq.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Portals API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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), InvalidParameterMinimumLength (5 properties), StringFieldFilter (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.

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

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 Add-Ons API
Kong API Attributes API
Kong API Documentation API
Kong API Image API
Kong API Implementation API
Where this information came from

This is an independent, third-party profile of Kong Portals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.