Update Produce Policy for Virtual Cluster
Updates an existing produce policy associated with the specified Event Gateway virtual cluster.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
The UUID of the policy.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The request schema for updating a produce policy.
EventGatewayProducePolicyUpdate
The typed schema of the produce policy to modify it.
One OfThe type name of the policy.
Allowed values:schema_validation
>= 1 characters<= 255 characters
A unique user-defined name of the policy.
<= 255 characters
A human-readable description of the policy.
Default:
<= 512 characters
Whether the policy is enabled.
Default:true
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"}
One OfThe configuration of the policy.
The configuration of the produce schema validation policy when using a schema registry.
Show Child Parameters
A string containing the boolean expression that determines whether the policy is applied.
Default:
<= 1000 characters
Example:context.topic.name.endsWith("my_suffix") && record.headers["x-flag"] == "a-value"
Response
application/json
Response
Updated produce policy object.
EventGatewayPolicy
A policy associated with an Event Gateway.
The type name of the policy.
>= 1 characters<= 255 characters
A unique user-defined name of the policy.
<= 255 characters
A human-readable description of the policy.
Default:
<= 512 characters
Whether the policy is enabled.
Default:true
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"}
The unique identifier of the policy.
The configuration of the policy.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
The unique identifier of the parent policy, if any.
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
A string containing the boolean expression that determines whether the policy is applied.
Default:
<= 1000 characters
Authentication
Path Parameters
Body
Patch Produce Policy for Virtual Cluster
Partially updates an existing produce policy associated with the specified Event Gateway virtual cluster.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
The UUID of the policy.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The request schema for patching a policy.
EventGatewayPolicyPatch
The schema of the policy to patch it.
A unique user-defined name of the policy.
Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$
>= 1 characters<= 255 characters
A human-readable description of the policy.
<= 512 characters
Whether the policy is enabled.
A string containing the boolean expression that determines whether the policy is applied.
<= 1000 characters
Example:context.topic.name.endsWith('my_suffix')
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"}
Response
application/json
Response
Updated produce policy object.
EventGatewayPolicy
A policy associated with an Event Gateway.
The type name of the policy.
>= 1 characters<= 255 characters
A unique user-defined name of the policy.
<= 255 characters
A human-readable description of the policy.
Default:
<= 512 characters
Whether the policy is enabled.
Default:true
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"}
The unique identifier of the policy.
The configuration of the policy.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
The unique identifier of the parent policy, if any.
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
A string containing the boolean expression that determines whether the policy is applied.
Default:
<= 1000 characters
Authentication
Path Parameters
Body
Delete Produce Policy for Virtual Cluster
Deletes a specific produce policy associated with the Event Gateway virtual cluster.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
The UUID of the policy.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
No Content
Authentication
Path Parameters
Move Produce Policy
Moves the position of a specific produce 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.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
The UUID of the policy.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
MoveEventGatewayPolicy
Defines the position of a policy relative to the policy chain.
The position of the policy relative to the policy chain.
>= 0
Example:2
Response
Response
No Content
Authentication
Path Parameters
Body
Get Produce Policy Chain for Virtual Cluster
Get the produce policy chain for a virtual cluster composed of all the ids of the produce policies in order of execution.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
Response
application/json
Response
A response containing the list of policies in order of execution.
The unique identifier of the policy.