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 Event Gateway Virtual Cluster Produce Policies API

Produce policies operate on Kafka messages before they are written to the Kafka cluster.Where possible, apply transformations to the data using produce policies rather than consume policies for maximum efficiency.

Kong Event Gateway Virtual Cluster Produce 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 Produce 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 50 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 operations 4 paths 50 schemas 1 DELETE3 GET1 PATCH2 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
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Event Gateway Virtual Cluster Produce 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 Produce Policies 9

Produce policies operate on Kafka messages before they are written to the Kafka cluster. Where possible, apply transformations to the data using produce policies rather than consu…

GET
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies
List Produce Policies for Virtual Cluster
list-event-gateway-virtual-cluster-produce-policies 3 params → 200401403
POST
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies
Create Produce Policy for Virtual Cluster
create-event-gateway-virtual-cluster-produce-policy 4 params body → 201400401403
GET
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies/{policyId}
Get a Produce Policy for Virtual Cluster
get-event-gateway-virtual-cluster-produce-policy 3 params → 200401403404
PUT
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies/{policyId}
Update Produce Policy for Virtual Cluster
update-event-gateway-virtual-cluster-produce-policy 3 params body → 200400401403
PATCH
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies/{policyId}
Patch Produce Policy for Virtual Cluster
patch-event-gateway-virtual-cluster-produce-policy 3 params body → 200400401403
DELETE
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies/{policyId}
Delete Produce Policy for Virtual Cluster
delete-event-gateway-virtual-cluster-produce-policy 3 params → 204401403404
POST
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies/{policyId}/move
Move Produce Policy
move-event-gateway-virtual-cluster-produce-policy 3 params body → 204400401403
GET
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policy-chain
Get Produce Policy Chain for Virtual Cluster
get-event-gateway-virtual-cluster-produce-policy-chain 2 params → 200401403
PUT
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policy-chain
Update Produce Policy Chain
update-event-gateway-virtual-cluster-produce-policy-chain 2 params body → 200400401403

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are EventGatewayPolicy (11 properties), EventGatewayModifyHeadersPolicyCreate (8 properties), EventGatewayParsedRecordEncryptFieldsPolicyCreate (8 properties), EventGatewayEncryptPolicy (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 properties 3 required
BadRequestError
BaseError
object
standard error
5 properties 4 required
InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
EventGatewayProduceSchemaValidationPolicyConfig
The configuration of the produce schema validation policy.
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
EncryptionRecordPart
string
key - encrypt the record key value - encrypt 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…
ProduceValueValidationAction
string
Defines a behavior when record value is not valid. reject - rejects a batch for topic partition. Only available for produce. mark - marks a record with kong/se…
EventGatewayParsedRecordEncryptFieldsPolicy
object
Encrypts 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 EventGatewayProduc…
7 properties 2 required
EventGatewayPolicy
object
A policy associated with an Event Gateway.
11 properties 4 required
UnauthorizedError
NotFoundError
EventGatewayModifyHeadersPolicy
object
A policy that modifies headers for requests.
7 properties 2 required
EventGatewayModifyHeaderRemoveAction
object
An action that removes a header by key.
2 properties 2 required
EncryptionKeyStaticReference
A static encryption key reference, either by ID or by value.
EventGatewayProduceSchemaValidationPolicyJsonConfig
object
The configuration of the produce schema validation policy when using JSON parsing without schema.
4 properties 1 required
EventGatewayProduceSchemaValidationPolicy
object
A policy that validates produce messages against a schema registry.
7 properties 2 required
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
EncryptionKeyAWS
object
The AWS KMS key to use for encryption.
2 properties 2 required
MoveEventGatewayPolicy
object
Defines the position of a policy relative to the policy chain.
1 property 1 required
EventGatewayProducePolicyUpdate
The typed schema of the produce policy to modify it.
EventGatewayParsedRecordEncryptFieldsConfig
object
The configuration of the encrypt parsed record policy.
2 properties 2 required
EventGatewayPolicyPatch
object
The schema of the policy to patch it.
5 properties
EncryptionKeyStaticReferenceById
object
A static encryption key reference by ID.
1 property 1 required
EventGatewayParsedRecordEncryptFieldsPolicyCreate
object
Encrypts 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 EventGatewayProduc…
8 properties 3 required
InvalidParameterChoiceItem
object
5 properties 4 required
EventGatewayParsedRecordEncryptionSelector
object
Selects fields of a parsed record for encryption and defines what key to encrypt them with.
2 properties 2 required
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,…
EventGatewayEncryptPolicy
object
Encrypts Kafka records or keys using AES256GCM. Keys are therefore 256 bits long.
7 properties 2 required
SchemaRegistryReferenceById
object
1 property 1 required
EventGatewayPolicyReference
string
The unique identifier of the policy.
InvalidParameters
array
invalid parameters
ProduceKeyValidationAction
string
Defines a behavior when record key is not valid. reject - rejects a batch for topic partition. Only available for produce. mark - marks a record with kong/serv…
ForbiddenError
EventGatewayModifyHeadersPolicyCreate
object
A policy that modifies headers for requests.
8 properties 2 required
EncryptionKey
The key to use for encryption.
ProduceFailureMode
string
Describes how to handle a failure in a policy applied to produced records. reject - rejects the record batch. passthrough - passes the record silently to the b…
EventGatewayProduceSchemaValidationPolicySchemaRegistryConfig
object
The configuration of the produce schema validation policy when using a schema registry.
4 properties 1 required
SchemaRegistryReference
A reference to a schema Registry.
InvalidParameterDependentItem
object
5 properties 4 required
EncryptionKeyStaticReferenceByName
object
A static encryption key reference by name.
1 property 1 required
SchemaRegistryReferenceByName
object
Reference a schema registry by its unique name.
1 property 1 required
EncryptionKeyStatic
object
A static encryption key.
2 properties 2 required
EventGatewayProducePolicyCreate
The typed schema of the produce policy to modify it.
EventGatewayModifyHeaderAction
An action that modifies a header.
InvalidRules
string
invalid parameters rules
EventGatewayEncryptConfig
object
The configuration of the encrypt policy.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-event-gateway-virtual-cluster-produce-policies-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 Event Gateway Virtual Cluster Produce 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.