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.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.
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…
GET
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies
List Consume Policies for Virtual Cluster
list-event-gateway-virtual-cluster-consume-policies
3 params
→ 200401403
POST
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies
Create Consume Policy for Virtual Cluster
create-event-gateway-virtual-cluster-consume-policy
4 params
body
→ 201400401403
GET
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}
Get a Consume Policy for Virtual Cluster
get-event-gateway-virtual-cluster-consume-policy
3 params
→ 200401403404
PUT
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}
Update Consume Policy for Virtual Cluster
update-event-gateway-virtual-cluster-consume-policy
3 params
body
→ 200400401403
PATCH
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}
Patch Consume Policy for Virtual Cluster
patch-event-gateway-virtual-cluster-consume-policy
3 params
body
→ 200400401403
DELETE
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}
Delete Consume Policy for Virtual Cluster
delete-event-gateway-virtual-cluster-consume-policy
3 params
→ 204401403404
POST
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}/move
Move Consume Policy
move-event-gateway-virtual-cluster-consume-policy
3 params
body
→ 204400401403
GET
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policy-chain
Get Consume Policy Chain
get-event-gateway-virtual-cluster-consume-policy-chain
2 params
→ 200401403
PUT
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policy-chain
Update Consume Policy Chain
update-event-gateway-virtual-cluster-consume-policy-chain
2 params
body
→ 200400401403
InvalidParameterMinimumLength
object
5 properties
4 required
SchemaValidationType
string
How to validate the schema and parse the record. confluentschemaregistry - validates against confluent schema registry. json - simple JSON parsing without the…
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…
EventGatewaySkipRecordPolicyCreate
object
A policy that skips processing of a record.
7 properties
1 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…
EventGatewayModifyHeaderRemoveAction
object
An action that removes a header by key.
2 properties
2 required
EventGatewayConsumePolicyCreate
The typed schema of the consume policy to modify it.
SchemaRegistryReference
A reference to a schema Registry.
InvalidParameterChoiceItem
object
5 properties
4 required
SchemaRegistryReferenceById
object
1 property
1 required
InvalidParameterMaximumLength
object
5 properties
4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
EventGatewayParsedRecordDecryptionSelector
object
Selects fields of a parsed record for decryption.
1 property
1 required
EventGatewayModifyHeaderSetAction
object
An action that sets a header key and value.
3 properties
3 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,…
EventGatewayDecryptPolicy
object
Decrypts Kafka records or keys using AES256GCM. Keys are therefore 256 bits long.
7 properties
2 required
EventGatewayPolicyPatch
object
The schema of the policy to patch it.
5 properties
EventGatewayParsedRecordDecryptFieldsConfig
object
The configuration of the decrypt parsed record fields policy.
3 properties
3 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,…
EventGatewaySkipRecordPolicy
object
A policy that skips processing of a record.
6 properties
1 required
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 properties
3 required
EventGatewayStaticKeySource
object
A key source that uses static symmetric keys.
1 property
1 required
EventGatewayModifyHeaderAction
An action that modifies a header.
SchemaRegistryReferenceByName
object
Reference a schema registry by its unique name.
1 property
1 required
EventGatewayConsumePolicyUpdate
The typed schema of the consume policy to modify it.
EventGatewayPolicyReference
string
The unique identifier of the policy.
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 properties
2 required
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
EventGatewayModifyHeadersPolicy
object
A policy that modifies headers for requests.
7 properties
2 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties
4 required
InvalidParameterDependentItem
object
5 properties
4 required
InvalidRules
string
invalid parameters rules
EventGatewayConsumeSchemaValidationPolicy
object
A policy that validates consume messages against a schema registry.
7 properties
2 required
InvalidParameters
array
invalid parameters
InvalidParameterStandard
object
4 properties
2 required
EventGatewayDecryptPolicyConfig
object
The configuration of the decrypt policy.
3 properties
3 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…
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 property
1 required
MoveEventGatewayPolicy
object
Defines the position of a policy relative to the policy chain.
1 property
1 required
DecryptionRecordPart
string
key - decrypt the record key value - decrypt the record value
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.
