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

Group routes

Kong Groups 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 Groups. 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 6 operations across 3 paths, and defines 3 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}.

6 operations 3 paths 3 schemas 2 DELETE1 GET2 POST1 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 Groups 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 6

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

Groups 6

Group routes

POST
/groups
Create a new Group
create-group body → 201401
DELETE
/groups/{GroupId}
Delete a Group
delete-group 2 params → 204401
GET
/groups/{GroupId}
Get a Group
get-group 1 param → 200401404
PUT
/groups/{GroupId}
Upsert a Group
upsert-group 1 param body → 200401
DELETE
/groups/{GroupId}/roles
Delete a Group’s Role
delete-groups-group_id_or_name-roles 3 params → 204401
POST
/groups/{GroupId}/roles
Create Group's Roles
create-groups-group_id_or_name-roles 1 param body → 201401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Group (5 properties), GroupRole (5 properties), GatewayUnauthorizedError (2 properties). Each schema is shown below with its type and property counts.

GroupRole
object
5 properties
Group
object
5 properties 1 required
GatewayUnauthorizedError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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