Update Policy Chain for Listener

Update the policy chain for a listener by providing an ordered list of policy ids.

put

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

eventGatewayListenerIdstring(uuid)required

The ID of the Event Gateway Listener.

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}/listeners/{eventGatewayListenerId}/policy-chain

Body

{ "policies": [] }
 
application/json

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.

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 cluster-level 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}/cluster-policies
 
application/json

Create Cluster Policy for Virtual Cluster

Creates a new cluster-level policy associated with the specified Event Gateway virtual cluster.

post

Query Parameters

beforestring(uuid)

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.

afterstring(uuid)

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

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 creating a cluster-level policy.

EventGatewayClusterPolicyModify

EventGatewayClusterPolicyModify

The typed schema of the cluster policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:acls

>= 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"}

configobjectrequired

The configuration of the policy.

Show Child Parameters
conditionstring

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

Created

EventGatewayPolicy

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

post/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policies

Body

{}
 
application/json

Get a Cluster Policy for Virtual Cluster

Returns information about a specific cluster-level policy associated with the Event Gateway virtual cluster.

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.

policyIdstring(uuid)required

The UUID of the policy.

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

Response

application/json

A single cluster-level policy object.

EventGatewayPolicy

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}/cluster-policies/{policyId}
 
application/json