v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-263064641.4 MB

Event Gateway Virtual Cluster Consume Policies

Update Consume Policy for Virtual Cluster

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

put/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}#ModifyHeaders

type'modify_headers' 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.

When the policy is applied as a child policy of schema_validation, the expression can also reference record.value fields.

{
  "labels": {
    "env": "test"
  },
  "condition": "record.value.content.foo.bar == \"a-value\""
}

Updated consume 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.

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