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

The consumer object represents a consumer - or a user - of a service.You can either rely on Kong Gateway as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong Gateway and your existing primary datastore.

Kong Consumers 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 Consumers. 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 13 operations across 6 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 3.14.0.

Requests are made against 5 base URLs: {protocol}://{hostname}:{port}{path}, https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

13 operations 6 paths 6 schemas 4 DELETE4 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 5

Kong Consumers API declares 5 security schemes for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). 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).

  • 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 13

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

Consumers 13

The consumer object represents a consumer - or a user - of a service. You can either rely on Kong Gateway as the primary datastore, or you can map the consumer list with your data…

POST
/{workspace}/consumers
Create a new Consumer
create-consumer 1 param body → 201401
DELETE
/{workspace}/consumers/{ConsumerIdOrUsername}
Delete a Consumer
delete-consumer 3 params → 204401
GET
/{workspace}/consumers/{ConsumerIdOrUsername}
Get a Consumer
get-consumer 2 params → 200401404
PUT
/{workspace}/consumers/{ConsumerIdOrUsername}
Upsert a Consumer
upsert-consumer 2 params body → 200401
GET
/v2/control-planes/{controlPlaneId}/core-entities/consumers
List all Consumers
list-consumer 7 params → 200401
POST
/v2/control-planes/{controlPlaneId}/core-entities/consumers
Create a new Consumer
create-consumer 1 param body → 201401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}
Delete a Consumer
delete-consumer 3 params → 204401
GET
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}
Get a Consumer
get-consumer 2 params → 200401404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}
Upsert a Consumer
upsert-consumer 2 params body → 200401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}/consumer_groups
Remove consumer from all consumer groups
remove-consumer-from-all-consumer-groups 2 params → 204404
GET
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}/consumer_groups
List all Consumer Groups a Consumer belongs to
list-consumer-groups-for-consumer 5 params → 200
POST
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}/consumer_groups
Add consumer to a specific consumer group
add-consumer-to-specific-consumer-group 2 params body → 201
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}/consumer_groups/{ConsumerGroupId}
Remove consumer from consumer group
remove-consumer-from-consumer-group 3 params → 204

Schemas 6

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

Consumer
object
The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list wi…
6 properties
GatewayUnauthorizedError
object
2 properties 2 required
Consumer_2
object
The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list wi…
6 properties
PaginationNextResponse
string
URI to the next page (may be null)
PaginationOffsetResponse
string
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
ConsumerGroup
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-consumers-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
Where this information came from

This is an independent, third-party profile of Kong Consumers 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.