KOkong
Event Gateway Virtual Cluster Policies

Update Cluster Policy for Virtual Cluster

Changed on

Updates an existing cluster-level policy associated with the specified Event Gateway virtual cluster.

put/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policies/{policyId}#RequestRuleValidator

Request

Request body

type'request_rule_validator' required

The type name of the policy.

namestring

A unique user-defined name of the policy.

descriptionstring

A human-readable description of the policy.

enabledboolean

Whether the policy is enabled.

labelsLabels

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 "_".

conditionstring

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

Example request

{
  "labels": {
    "env": "test"
  },
  "config": {
    "requests": [
      {
        "type": "create_topics",
        "rules": [
          {
            "description": "Enforce the topic naming convention and a partition limit.",
            "rule": "context.topic.name.startsWith('team-a.') && context.topic.num_partitions <= 50",
            "action": "reject"
          }
        ]
      }
    ]
  },
  "condition": "context.auth.principal.name == \"this-user\""
}

Response

Updated cluster-level policy object.

typestring required

The type name of the policy.

namestring

A unique user-defined name of the policy.

descriptionstring

A human-readable description of the policy.

enabledboolean

Whether the policy is enabled.

labelsLabels

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 "_".

idstring uuid required

The unique identifier of the policy.

configobject nullable

The configuration of the policy.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

parent_policy_idstring uuid nullable

The unique identifier of the parent policy, if any.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

conditionstring

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

Example response

{
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes