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.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
The identity and technical contract details declared by the specification.
InvalidParameterMinimumLength
object
5 properties
4 required
EventGatewayModifyHeaderRemoveAction
object
An action that removes a header by key.
2 properties
2 required
EventGatewayProduceSchemaValidationPolicyJsonConfig
object
The configuration of the produce schema validation policy when using JSON parsing without schema.
4 properties
1 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties
4 required
EventGatewayProduceSchemaValidationPolicyConfig
The configuration of the produce schema validation policy.
SchemaRegistryReference
A reference to a schema Registry.
InvalidParameterMaximumLength
object
5 properties
4 required
SchemaRegistryReferenceById
object
1 property
1 required
EventGatewayModifyHeaderSetAction
object
An action that sets a header key and value.
3 properties
3 required
EventGatewayEncryptPolicy
object
Encrypts Kafka records or keys using AES256GCM. Keys are therefore 256 bits long.
7 properties
2 required
EventGatewayEncryptConfig
object
The configuration of the encrypt policy.
3 properties
3 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
EventGatewayPolicyPatch
object
The schema of the policy to patch it.
5 properties
EncryptionKeyStatic
object
A static encryption key.
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,…
EventGatewayProduceSchemaValidationPolicy
object
A policy that validates produce messages against a schema registry.
7 properties
2 required
EventGatewayModifyHeaderAction
An action that modifies a header.
SchemaRegistryReferenceByName
object
Reference a schema registry by its unique name.
1 property
1 required
EventGatewayPolicyReference
string
The unique identifier of the policy.
EventGatewayProducePolicyCreate
The typed schema of the produce policy to modify it.
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…
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 properties
4 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
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…
BaseError
object
standard error
5 properties
4 required
InvalidParameterDependentItem
object
5 properties
4 required
EventGatewayModifyHeadersPolicy
object
A policy that modifies headers for requests.
7 properties
2 required
InvalidRules
string
invalid parameters rules
EventGatewayParsedRecordEncryptionSelector
object
Selects fields of a parsed record for encryption and defines what key to encrypt them with.
2 properties
2 required
EncryptionKey
The key to use for encryption.
InvalidParameters
array
invalid parameters
EncryptionKeyStaticReference
A static encryption key reference, either by ID or by value.
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
EventGatewayProduceSchemaValidationPolicySchemaRegistryConfig
object
The configuration of the produce schema validation policy when using a schema registry.
4 properties
1 required
EncryptionRecordPart
string
key - encrypt the record key value - encrypt the record value
EncryptionKeyAWS
object
The AWS KMS key to use for encryption.
2 properties
2 required
InvalidParameterStandard
object
4 properties
2 required
EncryptionKeyStaticReferenceByName
object
A static encryption key reference by name.
1 property
1 required
EncryptionKeyStaticReferenceById
object
A static encryption key reference by ID.
1 property
1 required
MoveEventGatewayPolicy
object
Defines the position of a policy relative to the policy chain.
1 property
1 required
EventGatewayParsedRecordEncryptFieldsConfig
object
The configuration of the encrypt parsed record policy.
2 properties
2 required
EventGatewayProducePolicyUpdate
The typed schema of the produce policy to modify it.
EventGatewayModifyHeadersPolicyCreate
object
A policy that modifies headers for requests.
8 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kong publishes across the network.
