Move Produce Policy

Moves the position of a specific produce policy relative to the chain associated with the Event Gateway virtual
cluster.
If a policy is defined under a parent policy, it moves the position relative to the sibling policies under the
same parent.

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

virtualClusterIdstring(uuid)required

The ID of the Virtual Cluster.

policyIdstring(uuid)required

The UUID of the policy.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

MoveEventGatewayPolicy

Defines the position of a policy relative to the policy chain.

indexintegerrequired

The position of the policy relative to the policy chain.

>= 0

Example:2

Response

No Content

post/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies/{policyId}/move

Body

{ "index": 2 }
 

Get Produce Policy Chain for Virtual Cluster

Get the produce policy chain for a virtual cluster composed of all the ids of the produce policies in order of execution.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

virtualClusterIdstring(uuid)required

The ID of the Virtual Cluster.

Response

application/json

A response containing the list of policies in order of execution.

policiesarray[string](uuid)required

The unique identifier of the policy.

get/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policy-chain
 
application/json

Update Produce Policy Chain

Update the produce policy chain for a virtual cluster by providing an ordered list of produce policy ids.

put

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

virtualClusterIdstring(uuid)required

The ID of the Virtual Cluster.

Body

application/json

The request schema for updating the policy chain.

policiesarray[string](uuid)required

The unique identifier of the policy.

Response

application/json

A response containing the list of policies in order of execution.

policiesarray[string](uuid)required

The unique identifier of the policy.

put/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policy-chain

Body

{ "policies": [] }
 
application/json

Event Gateway Virtual Cluster Consume Policies

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

List Consume Policies for Virtual Cluster

Returns a list of consume policies associated with the specified Event Gateway virtual cluster.

get

Query Parameters

filterobject

Filter policies returned in the response.

Show Child Parameters

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

virtualClusterIdstring(uuid)required

The ID of the Virtual Cluster.

Response

application/json

A paginated list response for a collection of consume policies associated with an Event Gateway virtual cluster.

A policy associated with an Event Gateway.

typestringrequired

The type name of the policy.

>= 1 characters<= 255 characters

namestring

A unique user-defined name of the policy.

<= 255 characters

descriptionstring

A human-readable description of the policy.

Default:

<= 512 characters

enabledboolean

Whether the policy is enabled.

Default:true

labelsobject

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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

idstring(uuid)required

The unique identifier of the policy.

configobject

The configuration of the policy.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

parent_policy_idstring | null(uuid)

The unique identifier of the parent policy, if any.

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

conditionstring

A string containing the boolean expression that determines whether the policy is applied.

Default:

<= 1000 characters

get/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies
 
application/json