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 HMAC-auth credentials API

The HMAC-auth credentials API from Kong — 6 operation(s) for hmac-auth credentials.

Kong HMAC-auth credentials 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 HMAC-auth credentials. 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 10 operations across 6 paths, and defines 7 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}.

10 operations 6 paths 7 schemas 2 DELETE5 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 HMAC-auth credentials 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 10

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

HMAC-auth credentials 10
POST
/{workspace}/consumers/{ConsumerIdForNestedEntities}/hmac-auth
Create a new HMAC-auth credential associated with a Consumer
create-hmac-auth-with-consumer 2 params body → 201
DELETE
/{workspace}/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}
Delete a a HMAC-auth credential associated with a Consumer
delete-hmac-auth-with-consumer 3 params → 204
GET
/{workspace}/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}
Get a HMAC-auth credential associated with a Consumer
get-hmac-auth-with-consumer 3 params → 200404
GET
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth
List all HMAC-auth credentials associated with a Consumer
list-hmac-auth-with-consumer 5 params → 200
POST
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth
Create a new HMAC-auth credential associated with a Consumer
create-hmac-auth-with-consumer 2 params body → 201
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}
Delete a a HMAC-auth credential associated with a Consumer
delete-hmac-auth-with-consumer 3 params → 204
GET
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}
Get a HMAC-auth credential associated with a Consumer
get-hmac-auth-with-consumer 3 params → 200404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}
Upsert a HMAC-auth credential associated with a Consumer
upsert-hmac-auth-with-consumer 3 params body → 200
GET
/v2/control-planes/{controlPlaneId}/core-entities/hmac-auths
List all HMAC-auth credentials
list-hmac-auth 4 params → 200401
GET
/v2/control-planes/{controlPlaneId}/core-entities/hmac-auths/{HMACAuthId}
Get a HMAC-auth credential
get-hmac-auth 2 params → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are HMACAuthWithoutParents_2 (6 properties), HMACAuthWithoutParents (6 properties), HMACAuth (6 properties), HMACAuth_2 (6 properties). Each schema is shown below with its type and property counts.

HMACAuth_2
object
6 properties 1 required
PaginationOffsetResponse
string
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
GatewayUnauthorizedError
object
2 properties 2 required
HMACAuth
object
6 properties 1 required
HMACAuthWithoutParents
object
6 properties 1 required
HMACAuthWithoutParents_2
object
6 properties 1 required
PaginationNextResponse
string
URI to the next page (may be null)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-hmac-auth-credentials-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