Delete Cluster Policy for Virtual Cluster

Deletes a specific cluster-level policy associated with the Event Gateway virtual cluster.

delete

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

No Content

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

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.

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

Body

{ "index": 2 }
 

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.

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}/cluster-policy-chain
 
application/json

Update Cluster Policy Chain

Update the cluster-level policy chain for a virtual cluster by providing an ordered list of cluster-level 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}/cluster-policy-chain

Body

{ "policies": [] }
 
application/json

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.