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

APIs related to configuration of Konnect Developer Portal developer teams.

Kong Portal Teams 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 Teams. 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 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}.

5 operations 2 paths 20 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 Portal Teams 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.

Portal Teams 5

APIs related to configuration of Konnect Developer Portal developer teams.

GET
/v3/portals/{portalId}/teams
List Teams
list-portal-teams 4 params → 200401403404
POST
/v3/portals/{portalId}/teams
Create Team
create-portal-team 1 param body → 201400401403404
GET
/v3/portals/{portalId}/teams/{teamId}
Get Team
get-portal-team 2 params → 200401403404
PATCH
/v3/portals/{portalId}/teams/{teamId}
Update Team
update-portal-team 2 params body → 200401403404
DELETE
/v3/portals/{portalId}/teams/{teamId}
Delete Team
delete-portal-team 2 params → 204401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are PortalTeamResponse (6 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties), StringFieldFilter (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
InvalidParameterMaximumLength
object
5 properties 4 required
ForbiddenError
UnauthorizedError
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
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
PortalTeamResponse
object
Details about a developer team.
6 properties
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
ListPortalTeamsResponse
object
A paginated list of teams in a portal.
2 properties 2 required
PortalCreateTeamRequest
object
Details about a team to create.
3 properties 1 required
PortalUpdateTeamRequest
object
Properties to update on a team.
3 properties
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-portal-teams-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