Move Cluster Policy
Moves the position of a specific cluster-level 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.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
The UUID of the policy.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
MoveEventGatewayPolicy
Defines the position of a policy relative to the policy chain.
The position of the policy relative to the policy chain.
>= 0
Example:2
Response
Response
No Content
Authentication
Path Parameters
Body
Get Cluster Policy Chain for Virtual Cluster
Get the cluster-level policy chain for a virtual cluster composed of all the ids of the cluster-level policies in order of execution.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
Response
application/json
Response
A response containing the list of policies in order of execution.
The unique identifier of the policy.
Authentication
Path Parameters
Update Cluster Policy Chain
Update the cluster-level policy chain for a virtual cluster by providing an ordered list of cluster-level policy ids.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
Body
application/json
Body
The request schema for updating the policy chain.
The unique identifier of the policy.
Response
application/json
Response
A response containing the list of policies in order of execution.
The unique identifier of the policy.
Authentication
Path Parameters
Body
Event Gateway Virtual Cluster Produce Policies
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.
List Produce Policies for Virtual Cluster
Returns a list of produce policies associated with the specified Event Gateway virtual cluster.
Query Parameters
Filter policies returned in the response.
Show Child Parameters
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
Response
application/json
Response
A paginated list response for a collection of produce policies associated with an Event Gateway virtual cluster.
A policy associated with an Event Gateway.
The type name of the policy.
>= 1 characters<= 255 characters
A unique user-defined name of the policy.
<= 255 characters
A human-readable description of the policy.
Default:
<= 512 characters
Whether the policy is enabled.
Default:true
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"}
The unique identifier of the policy.
The configuration of the policy.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
The unique identifier of the parent policy, if any.
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
A string containing the boolean expression that determines whether the policy is applied.
Default:
<= 1000 characters