Update Policy Chain for Listener
Update the policy chain for a listener by providing an ordered list of policy ids.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Event Gateway Listener.
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 Policies
Policies control how Kafka protocol traffic is modified between the client and the backend cluster.
Cluster policies are transformation and validation policies that can be applied to Kafka messages.
List Cluster Policies for Virtual Cluster
Returns a list of cluster-level policies associated with the 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 cluster-level 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
Authentication
Path Parameters
Query Parameters
Create Cluster Policy for Virtual Cluster
Creates a new cluster-level policy associated with the specified Event Gateway virtual cluster.
Query Parameters
Determines the id of the existing policy the new policy should be inserted before. Either ‘before’ or ‘after’ can be provided, when both are omitted the new policy is added to the end of the chain. When both are provided, the request fails with a 400 Bad Request.
Determines the id of the existing policy the new policy should be inserted after. Either ‘before’ or ‘after’ can be provided, when both are omitted the new policy is added to the end of the chain. When both are provided, the request fails with a 400 Bad Request.
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 creating a cluster-level policy.
EventGatewayClusterPolicyModify
The typed schema of the cluster policy to modify it.
One OfThe type name of the policy.
Allowed values:acls
>= 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 configuration of the policy.
Show Child Parameters
A string containing the boolean expression that determines whether the policy is applied.
Default:
<= 1000 characters
Example:context.auth.principal.name == "this-user"
Response
application/json
Response
Created
EventGatewayPolicy
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
Authentication
Path Parameters
Query Parameters
Body
Get a Cluster Policy for Virtual Cluster
Returns information about a specific cluster-level policy associated with the Event Gateway virtual cluster.
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
Response
application/json
Response
A single cluster-level policy object.
EventGatewayPolicy
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