Kong Event Gateway Virtual Cluster Consume Policies API
Consume policies operate on Kafka messages as they are read from a Kafka cluster.Transformations may be applied at consume time, but they are applied once per Consumer. Where possible, transofmrations should be applied as a Produce policy
Kong Event Gateway Virtual Cluster Consume Policies 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 Event Gateway Virtual Cluster Consume Policies. 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
9 operations
across 4 paths,
and defines 47 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.
9 operations4 paths47 schemas1 DELETE3 GET1 PATCH2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Kong Event Gateway Virtual Cluster Consume Policies 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 9
Across 4 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Event Gateway Virtual Cluster Consume Policies 9
Consume policies operate on Kafka messages as they are read from a Kafka cluster. Transformations may be applied at consume time, but they are applied once per Consumer. Where pos…
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are EventGatewayPolicy (11 properties), EventGatewayParsedRecordDecryptFieldsPolicyCreate (8 properties), EventGatewayModifyHeadersPolicyCreate (8 properties), EventGatewayModifyHeadersPolicy (7 properties). Each schema is shown below with its type and property counts.
EventGatewayModifyHeaderSetAction
object
An action that sets a header key and value.
3 properties3 required
BadRequestError
BaseError
object
standard error
5 properties4 required
InvalidParameterMinimumLength
object
5 properties4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
DecryptionRecordPart
string
key - decrypt the record key value - decrypt the record value
EncryptionFailureMode
string
Describes how to handle failing encryption or decryption. Use error if the record should be rejected if encryption or decryption fails. Use passthrough to igno…
EventGatewayPolicy
object
A policy associated with an Event Gateway.
11 properties4 required
SchemaValidationType
string
How to validate the schema and parse the record. confluentschemaregistry - validates against confluent schema registry. json - simple JSON parsing without the…
EventGatewayDecryptPolicyConfig
object
The configuration of the decrypt policy.
3 properties3 required
EventGatewayStaticKeySource
object
A key source that uses static symmetric keys.
1 property1 required
UnauthorizedError
NotFoundError
EventGatewayModifyHeadersPolicy
object
A policy that modifies headers for requests.
7 properties2 required
EventGatewayModifyHeaderRemoveAction
object
An action that removes a header by key.
2 properties2 required
ConsumeFailureMode
string
Describes how to handle a failure in a policy applied to consumed records. error - the batch is not delivered to the client. Use sparingly: erroring on a batch…
EventGatewayParsedRecordDecryptFieldsPolicy
object
Decrypts fields of parsed Kafka records using AES256GCM. Keys are therefore 256 bits long. Note this policy can only be used as a child of a EventGatewayConsum…
7 properties2 required
InvalidParameterMaximumLength
object
5 properties4 required
InvalidParameterStandard
object
4 properties2 required
EventGatewayPolicyPatch
object
The schema of the policy to patch it.
5 properties
MoveEventGatewayPolicy
object
Defines the position of a policy relative to the policy chain.
1 property1 required
EventGatewayKeySource
A key source that describes how to find a symmetric key for encryption or decryption. It can be an AWS KMS key source that uses a KMS to find a symmetric key,…
EventGatewayConsumePolicyUpdate
The typed schema of the consume policy to modify it.
EventGatewayParsedRecordDecryptFieldsPolicyCreate
object
Decrypts fields of parsed Kafka records using AES256GCM. Keys are therefore 256 bits long. Note this policy can only be used as a child of a EventGatewayConsum…
8 properties3 required
InvalidParameterChoiceItem
object
5 properties4 required
ConsumeKeyValidationAction
string
Defines a behavior when record key is not valid. mark - marks a record with kong/server header and client ID value to help to identify the clients violating sc…
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,…
SchemaRegistryReferenceById
object
1 property1 required
EventGatewaySkipRecordPolicyCreate
object
A policy that skips processing of a record.
7 properties1 required
EventGatewayPolicyReference
string
The unique identifier of the policy.
InvalidParameters
array
invalid parameters
ForbiddenError
EventGatewayModifyHeadersPolicyCreate
object
A policy that modifies headers for requests.
8 properties2 required
SchemaRegistryReference
A reference to a schema Registry.
InvalidParameterDependentItem
object
5 properties4 required
EventGatewayDecryptPolicy
object
Decrypts Kafka records or keys using AES256GCM. Keys are therefore 256 bits long.
7 properties2 required
SchemaRegistryReferenceByName
object
Reference a schema registry by its unique name.
1 property1 required
EventGatewayAWSKeySource
object
A key source that uses an AWS KMS to find a symmetric key. Load KMS credentials from the environment. See [aws docs](https://docs.aws.amazon.com/sdk-for-rust/l…
1 property1 required
EventGatewayParsedRecordDecryptFieldsConfig
object
The configuration of the decrypt parsed record fields policy.
3 properties3 required
EventGatewayConsumeSchemaValidationPolicy
object
A policy that validates consume messages against a schema registry.
7 properties2 required
ConsumeValueValidationAction
string
Defines a behavior when record value is not valid. mark - marks a record with kong/server header and client ID value to help to identify the clients violating…
EventGatewayModifyHeaderAction
An action that modifies a header.
InvalidRules
string
invalid parameters rules
EventGatewaySkipRecordPolicy
object
A policy that skips processing of a record.
6 properties1 required
EventGatewayConsumePolicyCreate
The typed schema of the consume policy to modify it.
EventGatewayParsedRecordDecryptionSelector
object
Selects fields of a parsed record for decryption.
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Kong Event Gateway Virtual Cluster Consume Policies 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.
