Kong Event Gateway Virtual Cluster Policies API

Policies control how Kafka protocol traffic is modified between the client and the backend cluster.Cluster policies are transformation and validation policies that can be applied to Kafka messages.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kong Event Gateway Virtual Cluster Policies API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Event Gateway Virtual Cluster Policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 9 operations across 4 paths, and defines 27 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

9 operations 4 paths 27 schemas 1 DELETE3 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

3.14.0

Base URL

https://konghq.com/

Authentication

API Key

Contact

Kong Inc

License

Apache 2.0

Resource Areas

Authentication & Security 1

Kong Event Gateway Virtual Cluster Policies API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Event Gateway Virtual Cluster Policies 9

Policies control how Kafka protocol traffic is modified between the client and the backend cluster. Cluster policies are transformation and validation policies that can be applied…

GET

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

List Cluster Policies for Virtual Cluster

list-event-gateway-virtual-cluster-cluster-level-policies 3 params → 200401403

POST

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

Create Cluster Policy for Virtual Cluster

create-event-gateway-virtual-cluster-cluster-level-policy 4 params body → 201400401403

GET

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

Get a Cluster Policy for Virtual Cluster

get-event-gateway-virtual-cluster-cluster-level-policy 3 params → 200401403404

PUT

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

Update Cluster Policy for Virtual Cluster

update-event-gateway-virtual-cluster-cluster-level-policy 3 params body → 200400401403

PATCH

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

Patch Cluster Policy for Virtual Cluster

patch-event-gateway-virtual-cluster-cluster-level-policy 3 params body → 200400401403

DELETE

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

Delete Cluster Policy for Virtual Cluster

delete-event-gateway-virtual-cluster-cluster-level-policy 3 params → 204401403404

POST

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

Move Cluster Policy

move-event-gateway-virtual-cluster-cluster-level-policy 3 params body → 204400401403

GET

/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policy-chain

Get Cluster Policy Chain for Virtual Cluster

get-event-gateway-virtual-cluster-cluster-level-policy-chain 2 params → 200401403

PUT

/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policy-chain

Update Cluster Policy Chain

update-event-gateway-virtual-cluster-cluster-level-policy-chain 2 params body → 200400401403

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are EventGatewayPolicy (11 properties), EventGatewayACLsPolicy (7 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength

object

5 properties 4 required

UpdatedAt

string

An ISO-8601 timestamp representation of entity update date.

InvalidParameterChoiceItem

object

5 properties 4 required

InvalidParameterMaximumLength

object

5 properties 4 required

EventGatewayACLRuleResourceNamesStaticArray

array

A static list of resource name globs to match against resources when applying an ACL policy.

EventGatewayPolicyPatch

object

The schema of the policy to patch it.

5 properties

Labels

object

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,…

ForbiddenError

UnauthorizedError

EventGatewayPolicyReference

string

The unique identifier of the policy.

EventGatewayACLRule

object

A Kafka ACL rule to apply to virtual cluster traffic

4 properties 4 required

EventGatewayACLOperation

object

An Event Gateway operation to match against in an ACL rule.

1 property 1 required

EventGatewayACLRuleResourceNamesDynamicArray

string

This expression should evaluate to an array of glob patterns, equivalent to the match values in the static array form of resourcenames. Requires a minimum runt…

EventGatewayPolicy

object

A policy associated with an Event Gateway.

11 properties 4 required

CreatedAt

string

An ISO-8601 timestamp representation of entity creation date.

BaseError

object

standard error

5 properties 4 required

InvalidParameterDependentItem

object

5 properties 4 required

InvalidRules

string

invalid parameters rules

InvalidParameters

array

invalid parameters

BadRequestError

EventGatewayACLResourceName

object

An Event Gateway resource name to match against in an ACL rule.

1 property 1 required

InvalidParameterStandard

object

4 properties 2 required

EventGatewayClusterPolicyModify

The typed schema of the cluster policy to modify it.

EventGatewayACLsPolicy

object

Apply Kafka ACLs to virtual cluster traffic.

7 properties 2 required

EventGatewayACLPolicyConfig

object

Apply ACLs to virtual cluster traffic.

1 property 1 required

MoveEventGatewayPolicy

object

Defines the position of a policy relative to the policy chain.

1 property 1 required

NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Kong publishes across the network.

Kong Gateway

AE Profile APIs.io

Kong AI Gateway

AE Profile APIs.io

Kong Agent Gateway

AE Profile APIs.io

Kong MCP Registry

AE Profile APIs.io

Kong Context Mesh

AE Profile APIs.io

Kong Mesh

AE Profile APIs.io

Kong Insomnia

AE Profile APIs.io

Kong ACLs API

AE Profile APIs.io

Kong Add-Ons API

AE Profile APIs.io

Kong API API

AE Profile APIs.io

Kong API Attributes API

AE Profile APIs.io

Kong API Documentation API

AE Profile APIs.io

#Event Gateway Virtual Cluster Policies

← Back to K APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kong Event Gateway Virtual Cluster Policies API

Metadata

Authentication & Security 1

Paths & Operations 9

Schemas 27

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kong Event Gateway Virtual Cluster Policies API

Metadata

Authentication & Security 1

Paths & Operations 9

Schemas 27

Specification

Source

More from Kong 12

API Details

Provider

Explore more