Modify Headers

object

A policy that modifies headers for requests.

typestringrequired

The type name of the policy.

Allowed values:modify_headers

>= 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 modify headers policy.

Show Child Parameters
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.

Default:

<= 1000 characters

Example:record.value.content.foo.bar == "a-value"

Example

Modify headers

object

A policy that modifies headers for requests.

typestringrequired

The type name of the policy.

Allowed values:modify_headers

>= 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 modify headers policy.

Show Child Parameters
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.

Default:

<= 1000 characters

Example:record.value.content.foo.bar == "a-value"

parent_policy_idstring(uuid)

The unique identifier of the parent schema validation policy, if any.

Example

EventGatewaySkipRecordPolicy

object

A policy that skips processing of a record.

typestringrequired

The type name of the policy.

Allowed values:skip_record

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

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.

Default:

<= 1000 characters

Example:record.value.content.foo.bar == "a-value"

Example

Skip Record

object

A policy that skips processing of a record.

typestringrequired

The type name of the policy.

Allowed values:skip_record

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

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.

Default:

<= 1000 characters

Example:record.value.content.foo.bar == "a-value"

parent_policy_idstring(uuid)

The unique identifier of the parent schema validation policy, if any.

Example

EventGatewayModifyHeaderAction

An action that modifies a header.

One Of
opstringrequired

Allowed values:remove

keystringrequired

The key of the header to remove.

Example