---
title: "Konnect Control Planes Configuration for Event Gateways"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19"
---

# Konnect Control Planes Configuration for Event Gateways

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Konnect Control Planes Configuration for Event Gateways","version":"1.0.0","description":"The API for configuring Event Gateways in Konnect.\n","x-extensions-note":"This API uses the `x-expression` vendor extension to indicate that a string property is a DSL expression.\nSupported types:\n  - `boolean`: An expression evaluates to boolean. For example, `context.topic.name == 'my-topic'`\n  - `string`: A template string expression that evaluates to a string or a literal string value. For example,\n    `${context.topic.name.substring(0, context.topic.name.length-4)}` or `my-literal-value`\n\nAdditionally, `x-sensitive` flag indicates that a field contains sensitive information. When the value\nof the field is provided in plain text, it's encrypted at rest and it's never returned in API responses.\nWhen the value is an expression, the expression itself is stored and returned in API responses.\n\n`x-min-runtime-version` indicates the minimum Event Gateway runtime version required to use a certain policy or\npolicy feature. The runtime version can be configured at the Event Gateway entity level. It must be a string\ncontaining a semantic version in the `MAJOR.MINOR` format, e.g., `\"1.1\"`.\n","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v1","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v1","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v1","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v1","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v1","description":"India Production region"},{"url":"https://sg.api.konghq.com/v1","description":"Singapore Production region"}],"paths":{"/event-gateways":{"get":{"operationId":"list-event-gateways","summary":"List all Event Gateways","description":"Returns an array of gateway objects containing information about the Konnect Event Gateways.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/EventGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListEventGatewaysResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Event Gateways"]},"post":{"operationId":"create-event-gateway","summary":"Create Event Gateway","description":"Create a Event gateway in the Konnect Organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGatewayRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateGatewayResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Event Gateways"]}},"/event-gateways/{gatewayId}":{"parameters":[{"name":"gatewayId","in":"path","description":"The UUID of your Gateway.","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"}}],"get":{"operationId":"get-event-gateway","summary":"Get an Event Gateway","description":"Returns information about an individual Event gateway.","responses":{"200":{"description":"A response to retrieving a single eventgateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayInfo"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Event Gateways"]},"put":{"operationId":"update-event-gateway","summary":"Update Event Gateway","description":"Update an individual gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGatewayRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateGatewayResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Event Gateways"]},"patch":{"operationId":"patch-event-gateway","summary":"Partially Update Event Gateway","description":"Patch an individual gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchGatewayRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateGatewayResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Event Gateways"]},"delete":{"operationId":"delete-event-gateway","summary":"Delete Event Gateway","description":"Delete an individual gateway.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateways"]}},"/event-gateways/{gatewayId}/listeners":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-event-gateway-listeners","summary":"List Event Gateway Listeners","description":"Returns a list of listeners associated with the specified Event Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/EventGatewayListenersFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListEventGatewayListenersResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listeners"]},"post":{"operationId":"create-event-gateway-listener","summary":"Create Event Gateway Listener","description":"Creates a new listener associated with the specified Event Gateway.","requestBody":{"$ref":"#/components/requestBodies/CreateEventGatewayListenerRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListener"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listeners"]}},"/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"name":"eventGatewayListenerId","in":"path","description":"The ID of the Event Gateway Listener.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"get-event-gateway-listener","summary":"Get an Event Gateway Listener","description":"Returns information about a specific listener associated with the Event Gateway.","responses":{"200":{"description":"A single event gateway listener object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListener"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Listeners"]},"put":{"operationId":"update-event-gateway-listener","summary":"Update Event Gateway Listener","description":"Updates an existing listener associated with the specified Event Gateway.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayListenerRequest"},"responses":{"200":{"description":"Updated event gateway listener object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListener"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listeners"]},"delete":{"operationId":"delete-event-gateway-listener","summary":"Delete Event Gateway Listener","description":"Deletes a specific listener associated with the Event Gateway.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Listeners"]}},"/event-gateways/{gatewayId}/virtual-clusters":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-event-gateway-virtual-clusters","summary":"List all virtual clusters","description":"Returns a paginated list of virtual clusters associated with the specified Event Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"name":"filter","in":"query","description":"Filter documents returned in the response.","required":false,"schema":{"type":"object","properties":{"backend_cluster_id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"name":{"$ref":"#/components/schemas/StringFieldContainsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListVirtualClustersResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Clusters"]},"post":{"operationId":"create-event-gateway-virtual-cluster","summary":"Create Virtual Cluster","description":"Creates a new virtual cluster associated with the specified Event Gateway.","requestBody":{"$ref":"#/components/requestBodies/CreateVirtualClusterRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCluster"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Clusters"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"name":"virtualClusterId","in":"path","description":"The ID of the Virtual Cluster.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"get-event-gateway-virtual-cluster","summary":"Get a Virtual Cluster","description":"Returns information about a specific virtual cluster associated with the Event Gateway.","responses":{"200":{"description":"A single virtual cluster object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCluster"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Virtual Clusters"]},"put":{"operationId":"update-event-gateway-virtual-cluster","summary":"Update Virtual Cluster","description":"Updates an existing virtual cluster associated with the specified Event Gateway.","requestBody":{"$ref":"#/components/requestBodies/UpdateVirtualClusterRequest"},"responses":{"200":{"description":"Updated virtual cluster object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCluster"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Clusters"]},"delete":{"operationId":"delete-event-gateway-virtual-cluster","summary":"Delete Virtual Cluster","description":"Deletes a specific virtual cluster associated with the Event Gateway.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Virtual Clusters"]}},"/event-gateways/{gatewayId}/backend-clusters":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-event-gateway-backend-clusters","summary":"List Backend Clusters","description":"Returns a list of backend clusters associated with the specified Event Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/EventGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListBackendClustersResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Backend Clusters"]},"post":{"operationId":"create-event-gateway-backend-cluster","summary":"Create Backend Cluster","description":"Creates a new backend cluster.","requestBody":{"$ref":"#/components/requestBodies/CreateBackendClusterRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendCluster"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Backend Clusters"]}},"/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"name":"backendClusterId","in":"path","description":"The ID of the Backend Cluster.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"get-event-gateway-backend-cluster","summary":"Get a Backend Cluster","description":"Returns information about a specific backend cluster.","responses":{"200":{"description":"A single backend cluster object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendCluster"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Backend Clusters"]},"put":{"operationId":"update-event-gateway-backend-cluster","summary":"Update Backend Cluster","description":"Updates an existing backend cluster.","requestBody":{"$ref":"#/components/requestBodies/UpdateBackendClusterRequest"},"responses":{"200":{"description":"Updated backend cluster object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendCluster"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Backend Clusters"]},"delete":{"operationId":"delete-event-gateway-backend-cluster","summary":"Delete Backend Cluster","description":"Deletes a specific backend cluster.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Backend Clusters"]}},"/event-gateways/{gatewayId}/schema-registries":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-event-gateway-schema-registries","summary":"List Schema Registries","description":"Returns a list of schema registries associated with the specified Event Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/EventGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListSchemaRegistriesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Schema Registries"]},"post":{"operationId":"create-event-gateway-schema-registry","summary":"Create Schema Registry","description":"Creates a new schema registry associated with the specified Event Gateway.","requestBody":{"$ref":"#/components/requestBodies/CreateSchemaRegistryRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaRegistry"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Schema Registries"]}},"/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"name":"schemaRegistryId","in":"path","description":"The ID of the Schema Registry.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"get-event-gateway-schema-registry","summary":"Get a Schema Registry","description":"Returns information about a specific schema registry associated with the Event Gateway.","responses":{"200":{"description":"A single schema registry object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaRegistry"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Schema Registries"]},"put":{"operationId":"update-event-gateway-schema-registry","summary":"Update Schema Registry","description":"Updates an existing schema registry associated with the specified Event Gateway.","requestBody":{"$ref":"#/components/requestBodies/UpdateSchemaRegistryRequest"},"responses":{"200":{"description":"Updated schema registry object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaRegistry"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Schema Registries"]},"delete":{"operationId":"delete-event-gateway-schema-registry","summary":"Delete Schema Registry","description":"Deletes a specific schema registry associated with the Event Gateway.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Schema Registries"]}},"/event-gateways/{gatewayId}/nodes":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-event-gateway-nodes","summary":"List Nodes","description":"Returns a list of nodes associated with the specified Event Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListEventGatewayNodesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Nodes"]}},"/event-gateways/{gatewayId}/nodes/{eventGatewayNodeId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/eventGatewayNodeId"}],"get":{"operationId":"get-event-gateway-node","summary":"Get a Node","description":"Returns information about a specific node associated with the Event Gateway.","responses":{"200":{"description":"A single node object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayNode"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Nodes"]}},"/event-gateways/{gatewayId}/nodes/{eventGatewayNodeId}/status":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/eventGatewayNodeId"}],"get":{"operationId":"get-event-gateway-node-status","summary":"Get Node Status","description":"Returns information about the node status.","responses":{"200":{"$ref":"#/components/responses/EventGatewayNodeStatus"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Nodes"]}},"/event-gateways/{gatewayId}/nodes/{eventGatewayNodeId}/errors":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/eventGatewayNodeId"}],"get":{"operationId":"list-event-gateway-node-errors","summary":"List Node Errors","description":"Returns information about the node errors.","responses":{"200":{"$ref":"#/components/responses/ListEventGatewayNodeErrorsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Nodes"]}},"/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/eventGatewayListenerId"}],"get":{"operationId":"list-event-gateway-listener-policies","summary":"List Policies for Listener","description":"Returns a list of policies associated with the specified Event Gateway listener.","parameters":[{"$ref":"#/components/parameters/EventGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListEventGatewayListenerPoliciesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listener Policies"]},"post":{"operationId":"create-event-gateway-listener-policy","summary":"Create Policy for Listener","description":"Creates a new policy associated with the specified Event Gateway listener.","parameters":[{"$ref":"#/components/parameters/EventGatewayPolicyBefore"},{"$ref":"#/components/parameters/EventGatewayPolicyAfter"}],"requestBody":{"$ref":"#/components/requestBodies/CreateEventGatewayListenerPolicyRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListenerPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listener Policies"]}},"/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies/{policyId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/eventGatewayListenerId"},{"name":"policyId","in":"path","description":"The UUID of the policy.","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"}}],"get":{"operationId":"get-event-gateway-listener-policy","summary":"Get a Policy for Listener","description":"Returns information about a specific policy associated with the Event Gateway listener.","responses":{"200":{"description":"A single policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListenerPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Listener Policies"]},"put":{"operationId":"update-event-gateway-listener-policy","summary":"Update Policy for Listener","description":"Updates an existing policy associated with the specified Event Gateway listener.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayListenerPolicyRequest"},"responses":{"200":{"description":"Updated policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListenerPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listener Policies"]},"patch":{"operationId":"patch-event-gateway-listener-policy","summary":"Partially Update Policy for Listener","description":"Partially updates an existing policy associated with the specified Event Gateway listener.","requestBody":{"$ref":"#/components/requestBodies/PatchEventGatewayListenerPolicyRequest"},"responses":{"200":{"description":"Updated policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListenerPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listener Policies"]},"delete":{"operationId":"delete-event-gateway-listener-policy","summary":"Delete Policy for Listener","description":"Deletes a specific policy associated with the Event Gateway listener.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Listener Policies"]}},"/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies/{policyId}/move":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/eventGatewayListenerId"},{"$ref":"#/components/parameters/policyId"}],"post":{"operationId":"move-event-gateway-listener-policy","summary":"Move Policy","description":"Moves the position of a specific policy relative to the chain associated with the Event Gateway listener.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveEventGatewayPolicy"}}}},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listener Policies"]}},"/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policy-chain":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/eventGatewayListenerId"}],"get":{"operationId":"get-event-gateway-listener-policy-chain","summary":"Get Policy Chain for Listener","description":"Get the policy chain for a listener composed of all the ids of the policies in order of execution.\n","responses":{"200":{"$ref":"#/components/responses/EventGatewayPolicyChainResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listener Policies"]},"put":{"operationId":"update-event-gateway-listener-policy-chain","summary":"Update Policy Chain for Listener","description":"Update the policy chain for a listener by providing an ordered list of policy ids.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayPolicyChainRequest"},"responses":{"200":{"$ref":"#/components/responses/EventGatewayPolicyChainResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Listener Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"}],"get":{"operationId":"list-event-gateway-virtual-cluster-consume-policies","summary":"List Consume Policies for Virtual Cluster","description":"Returns a list of consume policies associated with the specified Event Gateway virtual cluster.","parameters":[{"$ref":"#/components/parameters/EventGatewayPolicyListFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListConsumePoliciesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]},"post":{"operationId":"create-event-gateway-virtual-cluster-consume-policy","summary":"Create Consume Policy for Virtual Cluster","description":"Creates a new consume policy associated with the specified Event Gateway virtual cluster.","parameters":[{"$ref":"#/components/parameters/EventGatewayPolicyBefore"},{"$ref":"#/components/parameters/EventGatewayPolicyAfter"}],"requestBody":{"$ref":"#/components/requestBodies/CreateEventGatewayConsumePolicyRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"},{"name":"policyId","in":"path","description":"The UUID of the policy.","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"}}],"get":{"operationId":"get-event-gateway-virtual-cluster-consume-policy","summary":"Get a Consume Policy for Virtual Cluster","description":"Returns information about a specific consume policy associated with the Event Gateway virtual cluster.","responses":{"200":{"description":"A single consume policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]},"put":{"operationId":"update-event-gateway-virtual-cluster-consume-policy","summary":"Update Consume Policy for Virtual Cluster","description":"Updates an existing consume policy associated with the specified Event Gateway virtual cluster.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayConsumePolicyRequest"},"responses":{"200":{"description":"Updated consume policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]},"patch":{"operationId":"patch-event-gateway-virtual-cluster-consume-policy","summary":"Patch Consume Policy for Virtual Cluster","description":"Updates an existing consume policy associated with the specified Event Gateway virtual cluster.","requestBody":{"$ref":"#/components/requestBodies/PatchEventGatewayPolicyRequest"},"responses":{"200":{"description":"Updated consume policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]},"delete":{"operationId":"delete-event-gateway-virtual-cluster-consume-policy","summary":"Delete Consume Policy for Virtual Cluster","description":"Deletes a specific consume policy associated with the Event Gateway virtual cluster.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}/move":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"},{"$ref":"#/components/parameters/policyId"}],"post":{"operationId":"move-event-gateway-virtual-cluster-consume-policy","summary":"Move Consume Policy","description":"Moves the position of a specific consume policy relative to the chain associated with the Event Gateway virtual\ncluster.\nIf a policy is defined under a parent policy, it moves the position relative to the sibling policies under the\nsame parent.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveEventGatewayPolicy"}}}},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policy-chain":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"}],"get":{"operationId":"get-event-gateway-virtual-cluster-consume-policy-chain","summary":"Get Consume Policy Chain","description":"Get the consume policy chain for a virtual cluster composed of all the ids of the consume policies in order of execution.\n","responses":{"200":{"$ref":"#/components/responses/EventGatewayPolicyChainResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]},"put":{"operationId":"update-event-gateway-virtual-cluster-consume-policy-chain","summary":"Update Consume Policy Chain","description":"Update the consume policy chain for a virtual cluster by providing an ordered list of consume policy ids.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayPolicyChainRequest"},"responses":{"200":{"$ref":"#/components/responses/EventGatewayPolicyChainResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Consume Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"}],"get":{"operationId":"list-event-gateway-virtual-cluster-produce-policies","summary":"List Produce Policies for Virtual Cluster","description":"Returns a list of produce policies associated with the specified Event Gateway virtual cluster.","parameters":[{"$ref":"#/components/parameters/EventGatewayPolicyListFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListProducePoliciesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]},"post":{"operationId":"create-event-gateway-virtual-cluster-produce-policy","summary":"Create Produce Policy for Virtual Cluster","description":"Creates a new produce policy associated with the specified Event Gateway virtual cluster.","parameters":[{"$ref":"#/components/parameters/EventGatewayPolicyBefore"},{"$ref":"#/components/parameters/EventGatewayPolicyAfter"}],"requestBody":{"$ref":"#/components/requestBodies/CreateEventGatewayProducePolicyRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies/{policyId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"},{"name":"policyId","in":"path","description":"The UUID of the policy.","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"}}],"get":{"operationId":"get-event-gateway-virtual-cluster-produce-policy","summary":"Get a Produce Policy for Virtual Cluster","description":"Returns information about a specific produce policy associated with the Event Gateway virtual cluster.","responses":{"200":{"description":"A single produce policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]},"put":{"operationId":"update-event-gateway-virtual-cluster-produce-policy","summary":"Update Produce Policy for Virtual Cluster","description":"Updates an existing produce policy associated with the specified Event Gateway virtual cluster.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayProducePolicyRequest"},"responses":{"200":{"description":"Updated produce policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]},"patch":{"operationId":"patch-event-gateway-virtual-cluster-produce-policy","summary":"Patch Produce Policy for Virtual Cluster","description":"Partially updates an existing produce policy associated with the specified Event Gateway virtual cluster.","requestBody":{"$ref":"#/components/requestBodies/PatchEventGatewayPolicyRequest"},"responses":{"200":{"description":"Updated produce policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]},"delete":{"operationId":"delete-event-gateway-virtual-cluster-produce-policy","summary":"Delete Produce Policy for Virtual Cluster","description":"Deletes a specific produce policy associated with the Event Gateway virtual cluster.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies/{policyId}/move":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"},{"$ref":"#/components/parameters/policyId"}],"post":{"operationId":"move-event-gateway-virtual-cluster-produce-policy","summary":"Move Produce Policy","description":"Moves the position of a specific produce policy relative to the chain associated with the Event Gateway virtual\ncluster.\nIf a policy is defined under a parent policy, it moves the position relative to the sibling policies under the\nsame parent.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveEventGatewayPolicy"}}}},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policy-chain":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"}],"get":{"operationId":"get-event-gateway-virtual-cluster-produce-policy-chain","summary":"Get Produce Policy Chain for Virtual Cluster","description":"Get the produce policy chain for a virtual cluster composed of all the ids of the produce policies in order of execution.\n","responses":{"200":{"$ref":"#/components/responses/EventGatewayPolicyChainResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]},"put":{"operationId":"update-event-gateway-virtual-cluster-produce-policy-chain","summary":"Update Produce Policy Chain","description":"Update the produce policy chain for a virtual cluster by providing an ordered list of produce policy ids.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayPolicyChainRequest"},"responses":{"200":{"$ref":"#/components/responses/EventGatewayPolicyChainResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Produce Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policies":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"}],"get":{"operationId":"list-event-gateway-virtual-cluster-cluster-level-policies","summary":"List Cluster Policies for Virtual Cluster","description":"Returns a list of cluster-level policies associated with the virtual cluster.","parameters":[{"$ref":"#/components/parameters/EventGatewayPolicyListFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListClusterPoliciesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Policies"]},"post":{"operationId":"create-event-gateway-virtual-cluster-cluster-level-policy","summary":"Create Cluster Policy for Virtual Cluster","description":"Creates a new cluster-level policy associated with the specified Event Gateway virtual cluster.","parameters":[{"$ref":"#/components/parameters/EventGatewayPolicyBefore"},{"$ref":"#/components/parameters/EventGatewayPolicyAfter"}],"requestBody":{"$ref":"#/components/requestBodies/CreateEventGatewayClusterPolicyRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policies/{policyId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"},{"name":"policyId","in":"path","description":"The UUID of the policy.","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"}}],"get":{"operationId":"get-event-gateway-virtual-cluster-cluster-level-policy","summary":"Get a Cluster Policy for Virtual Cluster","description":"Returns information about a specific cluster-level policy associated with the Event Gateway virtual cluster.","responses":{"200":{"description":"A single cluster-level policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Virtual Cluster Policies"]},"put":{"operationId":"update-event-gateway-virtual-cluster-cluster-level-policy","summary":"Update Cluster Policy for Virtual Cluster","description":"Updates an existing cluster-level policy associated with the specified Event Gateway virtual cluster.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayClusterPolicyRequest"},"responses":{"200":{"description":"Updated cluster-level policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Policies"]},"patch":{"operationId":"patch-event-gateway-virtual-cluster-cluster-level-policy","summary":"Patch Cluster Policy for Virtual Cluster","description":"Partially updates an existing cluster-level policy associated with the specified Event Gateway virtual cluster.","requestBody":{"$ref":"#/components/requestBodies/PatchEventGatewayPolicyRequest"},"responses":{"200":{"description":"Updated cluster-level policy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Policies"]},"delete":{"operationId":"delete-event-gateway-virtual-cluster-cluster-level-policy","summary":"Delete Cluster Policy for Virtual Cluster","description":"Deletes a specific cluster-level policy associated with the Event Gateway virtual cluster.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Virtual Cluster Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policies/{policyId}/move":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"},{"$ref":"#/components/parameters/policyId"}],"post":{"operationId":"move-event-gateway-virtual-cluster-cluster-level-policy","summary":"Move Cluster Policy","description":"Moves the position of a specific cluster-level policy relative to the chain associated with the Event Gateway virtual\ncluster.\nIf a policy is defined under a parent policy, it moves the position relative to the sibling policies under the\nsame parent.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveEventGatewayPolicy"}}}},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Policies"]}},"/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policy-chain":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/virtualClusterId"}],"get":{"operationId":"get-event-gateway-virtual-cluster-cluster-level-policy-chain","summary":"Get Cluster Policy Chain for Virtual Cluster","description":"Get the cluster-level policy chain for a virtual cluster composed of all the ids of the cluster-level policies in order of execution.\n","responses":{"200":{"$ref":"#/components/responses/EventGatewayPolicyChainResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Policies"]},"put":{"operationId":"update-event-gateway-virtual-cluster-cluster-level-policy-chain","summary":"Update Cluster Policy Chain","description":"Update the cluster-level policy chain for a virtual cluster by providing an ordered list of cluster-level policy ids.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayPolicyChainRequest"},"responses":{"200":{"$ref":"#/components/responses/EventGatewayPolicyChainResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway Virtual Cluster Policies"]}},"/event-gateways/{gatewayId}/data-plane-certificates":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-event-gateway-data-plane-certificates","summary":"List Event Gateway DataPlane Certificates","description":"Returns a list of dataplane certificates that are associated to this event gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this event gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/EventGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListEventGatewayDataPlaneCertificatesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway DataPlane Certificates"]},"post":{"operationId":"create-event-gateway-data-plane-certificate","summary":"Create a New DataPlane Certificate","description":"Create new dataplane certificate to this event gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this event gateway.","requestBody":{"$ref":"#/components/requestBodies/CreateEventGatewayDataPlaneCertificateRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayDataPlaneCertificate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway DataPlane Certificates"]}},"/event-gateways/{gatewayId}/data-plane-certificates/{certificateId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"name":"certificateId","in":"path","description":"The ID of the dataplane certificate.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"get-event-gateway-data-plane-certificate","summary":"Get a DataPlane Certificate","description":"Returns information about an individual dataplane certificate.","responses":{"200":{"description":"A single dataplane certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayDataPlaneCertificate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway DataPlane Certificates"]},"put":{"operationId":"update-event-gateway-data-plane-certificate","summary":"Update Event Gateway DataPlane Certificate","description":"Updates an existing dataplane certificate associated with the specified Event Gateway.","requestBody":{"$ref":"#/components/requestBodies/UpdateEventGatewayDataPlaneCertificateRequest"},"responses":{"200":{"description":"Updated event gateway dataplane certificate object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayDataPlaneCertificate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway DataPlane Certificates"]},"delete":{"operationId":"delete-event-gateway-data-plane-certificate","summary":"Delete Event Gateway DataPlane Certificate","description":"Deletes a specific dataplane certificate associated with the Event Gateway.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway DataPlane Certificates"]}},"/event-gateways/{gatewayId}/static-keys":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-event-gateway-static-keys","summary":"List Event Gateway Static Keys","description":"Returns a list of static keys associated to this event gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/EventGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListEventGatewayStaticKeysResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Static Keys"]},"post":{"operationId":"create-event-gateway-static-key","summary":"Create a New Static Key","description":"Create new static key to this event gateway.","requestBody":{"$ref":"#/components/requestBodies/CreateEventGatewayStaticKeyRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayStaticKey"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Static Keys"]}},"/event-gateways/{gatewayId}/static-keys/{staticKeyId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"name":"staticKeyId","in":"path","description":"The ID of the static key.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"get-event-gateway-static-key","summary":"Get a Static Key","description":"Returns information about an individual static key.","responses":{"200":{"description":"A single static key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayStaticKey"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Static Keys"]},"delete":{"operationId":"delete-event-gateway-static-key","summary":"Delete Event Gateway Static Key","description":"Deletes a specific static key associated with the Event Gateway.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway Static Keys"]}},"/event-gateways/{gatewayId}/tls-trust-bundles":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-event-gateway-tls-trust-bundles","summary":"List TLS Trust Bundles","description":"Returns a list of TLS trust bundles associated with the specified Event Gateway.\n\n**Requires a minimum runtime version of `1.1`**.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/EventGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListTLSTrustBundlesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway TLS Trust Bundles"],"x-min-runtime-version":"1.1"},"post":{"operationId":"create-event-gateway-tls-trust-bundle","summary":"Create TLS Trust Bundle","description":"Creates a new TLS trust bundle containing trusted CA certificates for client certificate verification.\n\n**Requires a minimum runtime version of `1.1`**.","requestBody":{"$ref":"#/components/requestBodies/CreateTLSTrustBundleRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TLSTrustBundle"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway TLS Trust Bundles"],"x-min-runtime-version":"1.1"}},"/event-gateways/{gatewayId}/tls-trust-bundles/{tlsTrustBundleId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"name":"tlsTrustBundleId","in":"path","description":"The ID of the TLS trust bundle.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"get-event-gateway-tls-trust-bundle","summary":"Get a TLS Trust Bundle","description":"Returns information about a specific TLS trust bundle.\n\n**Requires a minimum runtime version of `1.1`**.","responses":{"200":{"description":"A single TLS trust bundle object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TLSTrustBundle"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway TLS Trust Bundles"],"x-min-runtime-version":"1.1"},"put":{"operationId":"update-event-gateway-tls-trust-bundle","summary":"Update TLS Trust Bundle","description":"Updates an existing TLS trust bundle.\n\n**Requires a minimum runtime version of `1.1`**.","requestBody":{"$ref":"#/components/requestBodies/UpdateTLSTrustBundleRequest"},"responses":{"200":{"description":"Updated TLS trust bundle object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TLSTrustBundle"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Event Gateway TLS Trust Bundles"],"x-min-runtime-version":"1.1"},"delete":{"operationId":"delete-event-gateway-tls-trust-bundle","summary":"Delete TLS Trust Bundle","description":"Deletes a specific TLS trust bundle associated with the Event Gateway.\n\n**Requires a minimum runtime version of `1.1`**.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Event Gateway TLS Trust Bundles"],"x-min-runtime-version":"1.1"}}},"components":{"parameters":{"EventGatewayCommonFilter":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldContainsFilter"}}},"in":"query","name":"filter","description":"Filter documents returned in the response.","required":false,"style":"deepObject"},"eventGatewayListenerId":{"schema":{"type":"string","format":"uuid"},"name":"eventGatewayListenerId","in":"path","required":true,"description":"The ID of the Event Gateway Listener."},"EventGatewayListenersFilter":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldContainsFilter"},"virtual_cluster_id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"in":"query","name":"filter","description":"Filter listeners returned in the response.","required":false,"style":"deepObject"},"eventGatewayNodeId":{"schema":{"type":"string","format":"uuid"},"name":"eventGatewayNodeId","in":"path","required":true,"description":"The ID of the Event Gateway Node."},"EventGatewayPolicyAfter":{"schema":{"type":"string","format":"uuid"},"in":"query","name":"after","description":"Determines the id of the existing policy the new policy should be inserted after. Either 'before' or 'after' can be provided, when both are omitted the new policy is added to the end of the chain. When both are provided, the request fails with a 400 Bad Request.\n","required":false},"EventGatewayPolicyBefore":{"schema":{"type":"string","format":"uuid"},"in":"query","name":"before","description":"Determines the id of the existing policy the new policy should be inserted before. Either 'before' or 'after' can be provided, when both are omitted the new policy is added to the end of the chain. When both are provided, the request fails with a 400 Bad Request.\n","required":false},"EventGatewayPolicyListFilter":{"schema":{"type":"object","properties":{"parent_policy_id":{"description":"The ID of the parent policy.","type":"string"}}},"in":"query","name":"filter","description":"Filter policies returned in the response.","required":false,"style":"deepObject"},"gatewayId":{"name":"gatewayId","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"},"description":"The UUID of your Gateway."},"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"policyId":{"name":"policyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"},"description":"The UUID of the policy."},"virtualClusterId":{"schema":{"type":"string","format":"uuid"},"name":"virtualClusterId","in":"path","required":true,"description":"The ID of the Virtual Cluster."}},"schemas":{"EventGatewayInfo":{"description":"The gateway object contains information about a Konnect gateway.","type":"object","properties":{"id":{"description":"The gateway ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"$ref":"#/components/schemas/GatewayName"},"description":{"$ref":"#/components/schemas/GatewayDescription"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"description":"An ISO-8604 timestamp representation of gateway creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An ISO-8604 timestamp representation of gateway update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"nodes_total":{"description":"The total number of nodes associated with the Event Gateway.","type":"integer"},"virtual_clusters_total":{"description":"The total number of virtual clusters associated with the Event Gateway.","type":"integer"},"min_runtime_version":{"$ref":"#/components/schemas/MinRuntimeVersion"},"version":{"description":"The version number of the event gateway. Every change to an entity\nunder this gateway will modify the version.\n","type":"string","example":"v1.123"}},"additionalProperties":false,"required":["id","name","created_at","updated_at","nodes_total","virtual_clusters_total","min_runtime_version","version"],"x-examples":{"Example 1":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Test Gateway","labels":{"env":"test"},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}}},"EventGatewayListener":{"description":"Listeners are used to expose virtual clusters to clients.","type":"object","properties":{"id":{"description":"The unique identifier of the listener.","type":"string","format":"uuid"},"name":{"description":"The unique name of the listener.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the listener.","type":"string","default":"","maxLength":512},"addresses":{"$ref":"#/components/schemas/EventGatewayListenerAddresses"},"ports":{"$ref":"#/components/schemas/EventGatewayListenerPorts"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","addresses","ports","created_at","updated_at"]},"EventGatewayListenerAddresses":{"description":"Which address or addresses to listen on.\n`0.0.0.0` means all addresses on the host.\n`::` means all addresses on the host in IPv6.\n\n  If `0.0.0.0` or `::` is used, there can't be other extra addresses defined.\n  WARNING: there are use cases where listening on all addresses is insecure. So use this with caution.\n\n  `localhost` means only the localhost ipv4 address.\n","type":"array","items":{"type":"string","minLength":1},"minItems":1},"EventGatewayListenerPorts":{"description":"Which port or ports to listen on.\nThere can be multiple ways to define ports:\n  - as a single port, e.g. 9092\n  - as a range of ports, e.g. 9092-9094\n\nIt's possible to combine both, e.g. [9092, \"9093-9095\", 9096].\n","type":"array","items":{"$ref":"#/components/schemas/EventGatewayListenerPort"},"minItems":1},"EventGatewayListenerPort":{"oneOf":[{"type":"string","pattern":"^(\\d{1,5}|\\d{1,5}-\\d{1,5})$","description":"A port or a range of ports in the format 9092 or 9092-9094."},{"type":"integer","minimum":1,"maximum":65535}]},"VirtualCluster":{"description":"A representation of a Kafka cluster that maps to a backend cluster.","type":"object","properties":{"id":{"description":"The unique identifier of the virtual cluster.","type":"string","format":"uuid"},"description":{"description":"A human-readable description of the virtual cluster.","type":"string","default":"","maxLength":512},"destination":{"$ref":"#/components/schemas/BackendClusterReference"},"authentication":{"$ref":"#/components/schemas/VirtualClusterAuthenticationSensitiveDataAwareSchemes"},"namespace":{"$ref":"#/components/schemas/VirtualClusterNamespace"},"name":{"$ref":"#/components/schemas/VirtualClusterName"},"dns_label":{"$ref":"#/components/schemas/VirtualClusterDNSLabel"},"acl_mode":{"$ref":"#/components/schemas/VirtualClusterACLMode"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","dns_label","destination","authentication","acl_mode","created_at","updated_at"]},"VirtualClusterName":{"description":"The name of the virtual cluster.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"VirtualClusterReference":{"description":"A reference to a virtual cluster.","anyOf":[{"$ref":"#/components/schemas/VirtualClusterReferenceById"},{"$ref":"#/components/schemas/VirtualClusterReferenceByName"}],"x-terraform-preferred":"#/components/schemas/VirtualClusterReferenceById"},"VirtualClusterReferenceById":{"description":"Reference a virtual cluster by its unique identifier.","type":"object","properties":{"id":{"description":"The unique identifier of the virtual cluster.","type":"string","format":"uuid","minLength":1}},"required":["id"]},"VirtualClusterReferenceByName":{"description":"Reference a virtual cluster by its unique name.","type":"object","properties":{"name":{"$ref":"#/components/schemas/VirtualClusterName"}},"required":["name"]},"VirtualClusterAuthenticationSensitiveDataAwareSchemes":{"description":"How to handle authentication from clients.\n\nIt tries to authenticate with every rule sequentially one by one.\nIt succeeds on the first match, and fails if no rule matches.\n","type":"array","items":{"$ref":"#/components/schemas/VirtualClusterAuthenticationSensitiveDataAwareScheme"},"minItems":1},"VirtualClusterAuthenticationSchemes":{"description":"How to handle authentication from clients.\n\nIt tries to authenticate with every rule sequentially one by one.\nIt succeeds on the first match, and fails if no rule matches.\n","type":"array","items":{"$ref":"#/components/schemas/VirtualClusterAuthenticationScheme"},"minItems":1},"VirtualClusterAuthenticationSensitiveDataAwareScheme":{"discriminator":{"propertyName":"type","mapping":{"anonymous":"#/components/schemas/VirtualClusterAuthenticationAnonymous","sasl_plain":"#/components/schemas/VirtualClusterAuthenticationSaslPlainSensitiveDataAware","sasl_scram":"#/components/schemas/VirtualClusterAuthenticationSaslScram","oauth_bearer":"#/components/schemas/VirtualClusterAuthenticationOauthBearer","client_certificate":"#/components/schemas/VirtualClusterAuthenticationClientCertificate"}},"oneOf":[{"$ref":"#/components/schemas/VirtualClusterAuthenticationAnonymous"},{"$ref":"#/components/schemas/VirtualClusterAuthenticationSaslPlainSensitiveDataAware"},{"$ref":"#/components/schemas/VirtualClusterAuthenticationSaslScram"},{"$ref":"#/components/schemas/VirtualClusterAuthenticationOauthBearer"},{"$ref":"#/components/schemas/VirtualClusterAuthenticationClientCertificate"}]},"VirtualClusterAuthenticationScheme":{"discriminator":{"propertyName":"type","mapping":{"anonymous":"#/components/schemas/VirtualClusterAuthenticationAnonymous","sasl_plain":"#/components/schemas/VirtualClusterAuthenticationSaslPlain","sasl_scram":"#/components/schemas/VirtualClusterAuthenticationSaslScram","oauth_bearer":"#/components/schemas/VirtualClusterAuthenticationOauthBearer","client_certificate":"#/components/schemas/VirtualClusterAuthenticationClientCertificate"}},"oneOf":[{"$ref":"#/components/schemas/VirtualClusterAuthenticationAnonymous"},{"$ref":"#/components/schemas/VirtualClusterAuthenticationSaslPlain"},{"$ref":"#/components/schemas/VirtualClusterAuthenticationSaslScram"},{"$ref":"#/components/schemas/VirtualClusterAuthenticationOauthBearer"},{"$ref":"#/components/schemas/VirtualClusterAuthenticationClientCertificate"}]},"VirtualClusterAuthenticationAnonymous":{"type":"object","properties":{"type":{"type":"string","enum":["anonymous"],"x-terraform-transform-const":true}},"required":["type"]},"VirtualClusterAuthenticationClientCertificate":{"description":"Client certificate (mTLS) authentication scheme for the virtual cluster.\n\n**Requires a minimum runtime version of `1.1`**.","type":"object","properties":{"type":{"type":"string","enum":["client_certificate"],"x-terraform-transform-const":true}},"example":{"type":"client_certificate"},"additionalProperties":false,"required":["type"],"x-min-runtime-version":"1.1"},"TLSTrustBundle":{"description":"A TLS trust bundle defines a set of trusted certificate authorities (CAs) used for client certificate\nverification during mutual TLS (mTLS). Trust bundles are referenced by TLS listener policies to\ndetermine which client certificates are accepted.\n\n**Requires a minimum runtime version of `1.1`**.","type":"object","properties":{"id":{"description":"The unique identifier of the TLS trust bundle.","type":"string","format":"uuid","readOnly":true},"name":{"$ref":"#/components/schemas/TLSTrustBundleName"},"description":{"description":"A human-readable description of the TLS trust bundle.","type":"string","default":"","maxLength":512},"config":{"$ref":"#/components/schemas/TLSTrustBundleConfig"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","config","created_at","updated_at"],"x-min-runtime-version":"1.1"},"TLSTrustBundleName":{"description":"The unique name of the TLS trust bundle.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"TLSTrustBundleConfig":{"type":"object","properties":{"trusted_ca":{"description":"PEM-encoded list of trusted CA certificates used to verify client certificates.\nCan be a literal PEM string or a vault reference.\n","type":"string","minLength":1,"x-examples":{"reference":{"summary":"Reference to a secret","value":"${vault.env['MY_ENV_VAR']}"},"literal":{"summary":"Literal value","value":"my-literal-value"}},"x-expression":{"type":"string","fields":["vault"]}}},"required":["trusted_ca"]},"TLSTrustBundleReference":{"description":"A reference to a TLS trust bundle resource.\n\nEither `id` or `name` must be provided. Following changes to the trust bundle name won't affect the\nreference, as the system will create the entities relationship by `id`.\n","anyOf":[{"$ref":"#/components/schemas/TLSTrustBundleReferenceById"},{"$ref":"#/components/schemas/TLSTrustBundleReferenceByName"}],"x-terraform-preferred":"#/components/schemas/TLSTrustBundleReferenceById"},"TLSTrustBundleReferenceById":{"type":"object","properties":{"id":{"description":"The unique identifier of the TLS trust bundle.","type":"string","format":"uuid","minLength":1}},"required":["id"]},"TLSTrustBundleReferenceByName":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TLSTrustBundleName"}},"required":["name"]},"VirtualClusterAuthenticationSaslPlainSensitiveDataAware":{"description":"SASL/PLAIN authentication scheme for the virtual cluster.","type":"object","properties":{"type":{"type":"string","enum":["sasl_plain"],"x-terraform-transform-const":true},"mediation":{"description":"The mediation type for SASL/PLAIN authentication.","type":"string","enum":["passthrough","terminate"]},"principals":{"description":"List of principals to be able to authenticate with, used with `terminate` mediation.","type":"array","items":{"$ref":"#/components/schemas/VirtualClusterAuthenticationPrincipalSensitiveDataAware"}}},"additionalProperties":false,"required":["type","mediation"]},"VirtualClusterAuthenticationSaslPlain":{"description":"SASL/PLAIN authentication scheme for the virtual cluster containing principals with username and password.\n","type":"object","properties":{"type":{"type":"string","enum":["sasl_plain"],"x-terraform-transform-const":true},"mediation":{"description":"The mediation type for SASL/PLAIN authentication.","type":"string","enum":["passthrough","terminate"]},"principals":{"description":"List of principals to be able to authenticate with, used with `terminate` mediation.","type":"array","items":{"$ref":"#/components/schemas/VirtualClusterAuthenticationPrincipal"},"minItems":1}},"additionalProperties":false,"required":["type","mediation"]},"VirtualClusterAuthenticationPrincipalSensitiveDataAware":{"description":"A principal for authentication.","type":"object","properties":{"username":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"password":{"$ref":"#/components/schemas/GatewaySecret"}},"required":["username"]},"VirtualClusterAuthenticationPrincipal":{"description":"A principal for authentication containing username and password.","type":"object","properties":{"username":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"password":{"$ref":"#/components/schemas/GatewaySecret"}},"required":["username","password"]},"VirtualClusterAuthenticationJWKS":{"description":"JSON Web Key Set configuration for verifying token signatures.","type":"object","properties":{"endpoint":{"description":"URL for JWKS endpoint.","type":"string","format":"uri","minLength":1},"timeout":{"description":"Total time from establishing connection to receive a response from JWKS endpoint.","type":"string","default":"10s"},"cache_expiration":{"description":"Duration after which the gateway will fetch and cache JWKS.","type":"string","default":"1h"}},"required":["endpoint"]},"VirtualClusterAuthenticationClaimsMapping":{"description":"Maps JWT claims in the case when sub and scope are presented as different claims in your JWT token.","type":"object","properties":{"sub":{"description":"Maps the subject claim.","type":"string","minLength":1},"scope":{"description":"Maps the scope claim.","type":"string","minLength":1}}},"VirtualClusterAuthenticationSaslScram":{"description":"SASL/SCRAM authentication scheme for the virtual cluster.","type":"object","properties":{"type":{"type":"string","enum":["sasl_scram"],"x-terraform-transform-const":true},"algorithm":{"description":"The algorithm used for SASL/SCRAM authentication.","type":"string","enum":["sha256","sha512"]}},"additionalProperties":false,"required":["type","algorithm"]},"VirtualClusterAuthenticationOauthBearer":{"description":"Oauth Bearer authentication scheme for the virtual cluster.","type":"object","properties":{"type":{"type":"string","enum":["oauth_bearer"],"x-terraform-transform-const":true},"mediation":{"description":"Methods to mediate authentication:\n* passthrough - pass authentication from the client through proxy to the backend cluster without any kind of\n  validation\n* validate_forward - pass authentication from the client through proxy to the backend cluster.\n  Proxy does the validation before forwarding it to the client.\n* terminate - terminate authentication at the proxy level and originate authentication to the backend cluster\n  using the configuration defined at BackendCluster's authentication.\n  SASL auth is not originated if authentication on the backend_cluster is not configured.\n","type":"string","enum":["passthrough","validate_forward","terminate"]},"claims_mapping":{"$ref":"#/components/schemas/VirtualClusterAuthenticationClaimsMapping"},"jwks":{"$ref":"#/components/schemas/VirtualClusterAuthenticationJWKS"},"validate":{"$ref":"#/components/schemas/VirtualClusterAuthenticationValidate"}},"additionalProperties":false,"required":["type","mediation"]},"VirtualClusterAuthenticationValidate":{"description":"Validation rules.","type":"object","properties":{"audiences":{"description":"List of expected audience values. One of them has to match the audience claim in the token.","type":"array","items":{"$ref":"#/components/schemas/VirtualClusterAuthenticationAudience"},"minItems":1},"issuer":{"description":"Expected token issuer in the token.","type":"string","minLength":1}}},"VirtualClusterAuthenticationAudience":{"type":"object","properties":{"name":{"type":"string","minLength":1}},"required":["name"]},"VirtualClusterDNSLabel":{"description":"The DNS label used in the bootstrap server URL to identify the virtual cluster when using SNI routing.\nThe format follows the RFC1035: 1-63 chars, lowercase alphanumeric or '-', must start and end with an alphanumeric character.","type":"string","example":"vcluster-1","maxLength":63,"minLength":1,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"VirtualClusterACLMode":{"description":"Configures whether or not ACL policies are enforced on the gateway.\n- `enforce_on_gateway` means the gateway enforces its own ACL policies for this virtual cluster\n  and does not forward ACL-related commands to the backend cluster.\n  Note that if there are no ACL policies configured, all access is denied.\n- `passthrough` tells the gateway to forward all ACL-related commands.\n","type":"string","enum":["enforce_on_gateway","passthrough"]},"BackendCluster":{"description":"The Kafka cluster.","type":"object","properties":{"id":{"description":"The unique identifier of the backend cluster.","type":"string","format":"uuid","readOnly":true},"name":{"$ref":"#/components/schemas/BackendClusterName"},"description":{"description":"A human-readable description of the backend cluster.","type":"string","default":"","maxLength":512},"authentication":{"$ref":"#/components/schemas/BackendClusterAuthenticationSensitiveDataAwareScheme"},"insecure_allow_anonymous_virtual_cluster_auth":{"description":"If true, virtual clusters can have allow anonymous authentication and use this backend cluster.\nThis setting is not recommended for production use as it may create privilege escalation vulnerabilities.\n","type":"boolean","default":false},"bootstrap_servers":{"$ref":"#/components/schemas/BootstrapServers"},"tls":{"$ref":"#/components/schemas/BackendClusterTLS"},"metadata_update_interval_seconds":{"$ref":"#/components/schemas/BackendMetadataUpdateIntervalSeconds"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","authentication","bootstrap_servers","tls","created_at","updated_at"]},"BackendClusterName":{"description":"The unique name of the backend cluster.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"BackendClusterReference":{"description":"The backend cluster associated with the virtual cluster.","type":"object","properties":{"id":{"description":"The unique identifier of the backend cluster.","type":"string","format":"uuid"},"name":{"$ref":"#/components/schemas/BackendClusterName"}},"additionalProperties":false,"required":["id","name"]},"BackendClusterReferenceModify":{"description":"The backend cluster associated with the virtual cluster.\n\nEither `id` or `name` must be provided. Following changes to the backend cluster name won't affect the\nreference, as the system will create the entities relationship by `id`.\n","anyOf":[{"$ref":"#/components/schemas/BackendClusterReferenceById"},{"$ref":"#/components/schemas/BackendClusterReferenceByName"}]},"BackendClusterReferenceById":{"type":"object","properties":{"id":{"description":"The unique identifier of the backend cluster.","type":"string","format":"uuid","minLength":1}},"required":["id"]},"BackendClusterReferenceByName":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/BackendClusterName"}},"required":["name"]},"BootstrapServers":{"description":"A list of cluster bootstrap servers in the format address:port.","type":"array","items":{"type":"string","description":"Endpoint in address:port format.","pattern":"^(([a-zA-Z0-9\\.\\-]+)|\\[([a-fA-F0-9:]+)\\]):\\d+$","minLength":1},"minItems":1},"BackendClusterTLS":{"type":"object","properties":{"enabled":{"description":"If true, TLS is enabled for connections to this backend cluster. If false, TLS is explicitly disabled.","type":"boolean"},"insecure_skip_verify":{"description":"If true, skip certificate verification. It's not secure to use for production.","type":"boolean","default":false},"ca_bundle":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"tls_versions":{"description":"List of supported TLS versions.","type":"array","items":{"type":"string","enum":["tls12","tls13"]},"default":["tls12","tls13"]},"client_identity":{"description":"Client mTLS configuration.\n\n**Requires a minimum runtime version of `1.1`**.","type":"object","properties":{"certificate":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"key":{"$ref":"#/components/schemas/GatewaySecret"}},"required":["certificate","key"],"x-min-runtime-version":"1.1","x-speakeasy-param-computed":false}},"required":["enabled"]},"BackendMetadataUpdateIntervalSeconds":{"description":"The interval at which metadata is updated in seconds.","type":"integer","default":60,"maximum":43200,"minimum":1},"BackendClusterAuthenticationScheme":{"discriminator":{"propertyName":"type","mapping":{"anonymous":"#/components/schemas/BackendClusterAuthenticationAnonymous","sasl_plain":"#/components/schemas/BackendClusterAuthenticationSaslPlain","sasl_scram":"#/components/schemas/BackendClusterAuthenticationSaslScram"}},"oneOf":[{"$ref":"#/components/schemas/BackendClusterAuthenticationAnonymous"},{"$ref":"#/components/schemas/BackendClusterAuthenticationSaslPlain"},{"$ref":"#/components/schemas/BackendClusterAuthenticationSaslScram"}]},"BackendClusterAuthenticationSensitiveDataAwareScheme":{"discriminator":{"propertyName":"type","mapping":{"anonymous":"#/components/schemas/BackendClusterAuthenticationAnonymous","sasl_plain":"#/components/schemas/BackendClusterAuthenticationSaslPlainSensitiveDataAware","sasl_scram":"#/components/schemas/BackendClusterAuthenticationSaslScramSensitiveDataAware"}},"oneOf":[{"$ref":"#/components/schemas/BackendClusterAuthenticationAnonymous"},{"$ref":"#/components/schemas/BackendClusterAuthenticationSaslPlainSensitiveDataAware"},{"$ref":"#/components/schemas/BackendClusterAuthenticationSaslScramSensitiveDataAware"}]},"BackendClusterAuthenticationAnonymous":{"description":"Anonymous authentication scheme for the backend cluster.","type":"object","properties":{"type":{"description":"The type of authentication scheme.","type":"string","enum":["anonymous"],"x-terraform-transform-const":true}},"additionalProperties":false,"required":["type"]},"BackendClusterAuthenticationSaslPlainSensitiveDataAware":{"description":"SASL/PLAIN authentication scheme for the backend cluster without requiring sensitive password data.\n","type":"object","properties":{"type":{"type":"string","enum":["sasl_plain"],"x-terraform-transform-const":true},"username":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"password":{"$ref":"#/components/schemas/GatewaySecret"}},"additionalProperties":false,"required":["type","username"]},"BackendClusterAuthenticationSaslPlain":{"description":"SASL/PLAIN authentication scheme for the backend cluster.","type":"object","properties":{"type":{"type":"string","enum":["sasl_plain"],"x-terraform-transform-const":true},"username":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"password":{"$ref":"#/components/schemas/GatewaySecret"}},"additionalProperties":false,"required":["type","username","password"]},"BackendClusterAuthenticationSaslScramSensitiveDataAware":{"description":"SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.\n","type":"object","properties":{"type":{"type":"string","enum":["sasl_scram"],"x-terraform-transform-const":true},"algorithm":{"description":"The algorithm used for SASL/SCRAM authentication.","type":"string","enum":["sha256","sha512"]},"username":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"password":{"$ref":"#/components/schemas/GatewaySecret"}},"additionalProperties":false,"required":["type","username","algorithm"]},"BackendClusterAuthenticationSaslScram":{"description":"SASL/SCRAM authentication scheme for the backend cluster.","type":"object","properties":{"type":{"type":"string","enum":["sasl_scram"],"x-terraform-transform-const":true},"algorithm":{"description":"The algorithm used for SASL/SCRAM authentication.","type":"string","enum":["sha256","sha512"]},"username":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"password":{"$ref":"#/components/schemas/GatewaySecret"}},"additionalProperties":false,"required":["type","username","algorithm","password"]},"SchemaRegistry":{"description":"A schema registry that contains schemas.","type":"object","properties":{"name":{"description":"The unique name of the schema registry.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the virtual cluster.","type":"string","default":"","maxLength":512},"type":{"description":"The type of the schema registry.","type":"string"},"config":{"description":"The configuration of the schema registry.","type":"object"},"labels":{"$ref":"#/components/schemas/Labels"},"id":{"description":"The unique identifier of the schema registry.","type":"string","format":"uuid"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["name","type","id","created_at","updated_at"]},"SchemaRegistryConfluentSensitiveDataAware":{"description":"A Confluent schema registry.","type":"object","properties":{"name":{"description":"The unique name of the schema registry.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the virtual cluster.","type":"string","default":"","maxLength":512},"type":{"description":"The type of the schema registry.","type":"string","enum":["confluent"],"x-terraform-transform-const":true},"config":{"description":"The configuration of the schema registry.","type":"object","$ref":"#/components/schemas/SchemaRegistryConfluentConfigSensitiveDataAware"},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["name","type","config"]},"SchemaRegistryConfluent":{"description":"A Confluent schema registry.","type":"object","properties":{"name":{"description":"The unique name of the schema registry.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the virtual cluster.","type":"string","default":"","maxLength":512},"type":{"description":"The type of the schema registry.","type":"string","enum":["confluent"],"x-terraform-transform-const":true},"config":{"description":"The configuration of the schema registry.","type":"object","$ref":"#/components/schemas/SchemaRegistryConfluentConfig"},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["name","type","config"]},"SchemaRegistryConfluentConfigSensitiveDataAware":{"description":"The configuration of [Confluent Schema Registry](https://github.com/confluentinc/schema-registry)\n","type":"object","properties":{"schema_type":{"description":"The format of the message.","type":"string","enum":["avro","json"]},"endpoint":{"description":"The endpoint of the Confluent schema registry.","type":"string","format":"uri","minLength":1},"timeout_seconds":{"description":"Total time in seconds from establishing connection to receive a response from schema registry.\n","type":"integer","default":10,"minimum":1},"authentication":{"$ref":"#/components/schemas/SchemaRegistryAuthenticationSensitiveDataAwareScheme"}},"required":["schema_type","endpoint"]},"SchemaRegistryConfluentConfig":{"description":"The configuration of [Confluent Schema Registry](https://github.com/confluentinc/schema-registry)\n","type":"object","properties":{"schema_type":{"description":"The format of the message.","type":"string","enum":["avro","json"]},"endpoint":{"description":"The endpoint of the Confluent schema registry.","type":"string","format":"uri","minLength":1},"timeout_seconds":{"description":"Total time in seconds from establishing connection to receive a response from schema registry.\n","type":"integer","default":10,"minimum":1},"authentication":{"$ref":"#/components/schemas/SchemaRegistryAuthenticationScheme"}},"required":["schema_type","endpoint"]},"SchemaRegistryAuthenticationSensitiveDataAwareScheme":{"description":"The authentication configuration for the schema registry.","discriminator":{"propertyName":"type","mapping":{"basic":"#/components/schemas/SchemaRegistryAuthenticationBasicSensitiveDataAware"}},"oneOf":[{"$ref":"#/components/schemas/SchemaRegistryAuthenticationBasicSensitiveDataAware"}]},"SchemaRegistryAuthenticationScheme":{"description":"The authentication configuration for the schema registry.","discriminator":{"propertyName":"type","mapping":{"basic":"#/components/schemas/SchemaRegistryAuthenticationBasic"}},"oneOf":[{"$ref":"#/components/schemas/SchemaRegistryAuthenticationBasic"}]},"SchemaRegistryAuthenticationBasicSensitiveDataAware":{"type":"object","properties":{"type":{"type":"string","enum":["basic"],"x-terraform-transform-const":true},"username":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"password":{"$ref":"#/components/schemas/GatewaySecret"}},"required":["type","username"]},"SchemaRegistryAuthenticationBasic":{"description":"Basic authentication scheme for the schema registry with username and password.","type":"object","properties":{"type":{"type":"string","enum":["basic"],"x-terraform-transform-const":true},"username":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"password":{"$ref":"#/components/schemas/GatewaySecret"}},"required":["type","username","password"]},"SchemaRegistryReference":{"description":"A reference to a schema Registry.","oneOf":[{"$ref":"#/components/schemas/SchemaRegistryReferenceById"},{"$ref":"#/components/schemas/SchemaRegistryReferenceByName"}],"x-terraform-preferred":"#/components/schemas/SchemaRegistryReferenceById"},"SchemaRegistryReferenceById":{"type":"object","properties":{"id":{"description":"The unique identifier of the schema registry.","type":"string","format":"uuid","minLength":1}},"required":["id"]},"SchemaRegistryReferenceByName":{"description":"Reference a schema registry by its unique name.","type":"object","properties":{"name":{"description":"The unique name of the schema registry.","type":"string","maxLength":255,"minLength":1}},"required":["name"]},"SchemaValidationType":{"description":"How to validate the schema and parse the record.\n* confluent_schema_registry - validates against confluent schema registry.\n* json - simple JSON parsing without the schema.\n","type":"string","enum":["confluent_schema_registry","json"]},"SchemaRegistryCreate":{"description":"The typed schema of the schema registry to create it.","discriminator":{"propertyName":"type","mapping":{"confluent":"#/components/schemas/SchemaRegistryConfluent"}},"oneOf":[{"$ref":"#/components/schemas/SchemaRegistryConfluent"}]},"SchemaRegistryUpdate":{"description":"The typed schema of the schema registry to modify it.","discriminator":{"propertyName":"type","mapping":{"confluent":"#/components/schemas/SchemaRegistryConfluentSensitiveDataAware"}},"oneOf":[{"$ref":"#/components/schemas/SchemaRegistryConfluentSensitiveDataAware"}]},"EventGatewayPolicy":{"description":"A policy associated with an Event Gateway.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","maxLength":255,"minLength":1},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"id":{"description":"The unique identifier of the policy.","type":"string","format":"uuid"},"config":{"description":"The configuration of the policy.","type":"object"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"parent_policy_id":{"description":"The unique identifier of the parent policy, if any.","type":"string","format":"uuid","nullable":true},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[]}}},"required":["type","id","created_at","updated_at"]},"EventGatewayListenerPolicy":{"description":"A policy associated with an Event Gateway.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","maxLength":255,"minLength":1},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"id":{"description":"The unique identifier of the policy.","type":"string","format":"uuid"},"config":{"description":"The configuration of the policy.","type":"object"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"parent_policy_id":{"description":"The unique identifier of the parent policy, if any.","type":"string","format":"uuid","nullable":true},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["type","id","created_at","updated_at","config"]},"EventGatewayTLSListenerSensitiveDataAwarePolicy":{"description":"The TLS Server policy defines the certificates and keys used by the gateway server when the client connects\nto the gateway over TLS.\n\nWhile it is possible to have multiple TLS policies on a listener, only one can be active at a time.\n","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["tls_server"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the policy.","type":"object","$ref":"#/components/schemas/EventGatewayTLSListenerPolicyConfigSensitiveDataAware"}},"required":["type","config"]},"EventGatewayTLSListenerPolicy":{"description":"The TLS Server policy defines the certificates and keys used by the gateway server when the client connects\nto the gateway over TLS.\n\nWhile it is possible to have multiple TLS policies on a listener, only one can be active at a time.\n","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["tls_server"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the policy.","type":"object","$ref":"#/components/schemas/EventGatewayTLSListenerPolicyConfig"}},"required":["type","config"],"title":"TLS Listener"},"EventGatewayTLSListenerPolicyConfigSensitiveDataAware":{"type":"object","properties":{"certificates":{"type":"array","items":{"$ref":"#/components/schemas/TLSCertificateSensitiveDataAware"},"maxItems":1,"minItems":1},"versions":{"$ref":"#/components/schemas/TLSVersionRange"},"allow_plaintext":{"description":"If false, only TLS connections are allowed. If true, both TLS and plaintext connections are allowed.\n","type":"boolean","default":false},"client_authentication":{"description":"Configures mutual TLS (mTLS) client certificate verification. When set, the gateway\nrequests or requires clients to present a certificate during the TLS handshake.\n\n**Requires a minimum runtime version of `1.1`**.","type":"object","properties":{"mode":{"description":"* required - Reject TLS connections without a valid client certificate.\n* requested - Request a client certificate during the TLS handshake, but allow connections without one (falls back to other configured authentication methods). If a certificate is presented but cannot be verified, the connection is closed.\n","type":"string","enum":["required","requested"]},"tls_trust_bundles":{"description":"TLS trust bundles contain CA certificate bundles used to verify client certificates.\nAll bundles are merged into a single trust store; a client certificate is accepted if it\nchains to any trusted CA across all bundles.\n","type":"array","items":{"$ref":"#/components/schemas/TLSTrustBundleReference"},"minItems":1},"principal_mapping":{"description":"An expression that extracts a principal identifier from a verified client certificate.\nThis expression must evaluate to a string.\n\n**Requires a minimum runtime version of `1.1`**.","type":"string","example":"${context.certificate.subject['CN'] ? context.certificate.subject['CN'] : context.certificate.sans.uri[0]}","x-expression":{"type":"string","fields":[{"name":"context.certificate.serialNumber","type":"string","description":"The string serial number of the certificate"},{"name":"context.certificate.subject","type":"object","description":"A map of the subject distinguished name.\n\nA distinguished name as described by RFC 4514 is represented as a map with each key being\nthe attribute type and the value being the attribute value.\nFor example:\n* `certificate.subject['CN']` is the common name\n* `certificate.subject['O']` is the organization\n"},{"name":"context.certificate.issuer","type":"object","description":"A map of the issuer distinguished name.\n\nA distinguished name as described by RFC 4514 is represented as a map with each key being\nthe attribute type and the value being the attribute value.\nFor example:\n* `certificate.issuer['CN']` is the common name\n* `certificate.issuer['O']` is the organization\n"},{"name":"context.certificate.sans.dns","type":"array","items":{"type":"string"},"description":"An array of the DNS Subject Alternative Names from the certificate."},{"name":"context.certificate.sans.uri","type":"array","items":{"type":"string"},"description":"An array of the URI Subject Alternative Names from the certificate."}]},"x-min-runtime-version":"1.1"}},"required":["mode","tls_trust_bundles"],"x-min-runtime-version":"1.1"}},"required":["certificates"]},"EventGatewayTLSListenerPolicyConfig":{"type":"object","properties":{"certificates":{"type":"array","items":{"$ref":"#/components/schemas/TLSCertificate"},"maxItems":1,"minItems":1},"versions":{"$ref":"#/components/schemas/TLSVersionRange"},"allow_plaintext":{"description":"If false, only TLS connections are allowed. If true, both TLS and plaintext connections are allowed.\n","type":"boolean","default":false},"client_authentication":{"description":"Configures mutual TLS (mTLS) client certificate verification. When set, the gateway\nrequests or requires clients to present a certificate during the TLS handshake.\n\n**Requires a minimum runtime version of `1.1`**.","type":"object","properties":{"mode":{"description":"* required - Reject TLS connections without a valid client certificate.\n* requested - Request a client certificate during the TLS handshake, but allow connections without one (falls back to other configured authentication methods). If a certificate is presented but cannot be verified, the connection is closed.\n","type":"string","enum":["required","requested"]},"tls_trust_bundles":{"description":"TLS trust bundles contain CA certificate bundles used to verify client certificates.\nAll bundles are merged into a single trust store; a client certificate is accepted if it\nchains to any trusted CA across all bundles.\n","type":"array","items":{"$ref":"#/components/schemas/TLSTrustBundleReference"},"minItems":1},"principal_mapping":{"description":"An expression that extracts a principal identifier from a verified client certificate.\nThis expression must evaluate to a string.\n\n**Requires a minimum runtime version of `1.1`**.","type":"string","example":"${context.certificate.subject['CN'] ? context.certificate.subject['CN'] : context.certificate.sans.uri[0]}","x-expression":{"type":"string","fields":[{"name":"context.certificate.serialNumber","type":"string","description":"The string serial number of the certificate"},{"name":"context.certificate.subject","type":"object","description":"A map of the subject distinguished name.\n\nA distinguished name as described by RFC 4514 is represented as a map with each key being\nthe attribute type and the value being the attribute value.\nFor example:\n* `certificate.subject['CN']` is the common name\n* `certificate.subject['O']` is the organization\n"},{"name":"context.certificate.issuer","type":"object","description":"A map of the issuer distinguished name.\n\nA distinguished name as described by RFC 4514 is represented as a map with each key being\nthe attribute type and the value being the attribute value.\nFor example:\n* `certificate.issuer['CN']` is the common name\n* `certificate.issuer['O']` is the organization\n"},{"name":"context.certificate.sans.dns","type":"array","items":{"type":"string"},"description":"An array of the DNS Subject Alternative Names from the certificate."},{"name":"context.certificate.sans.uri","type":"array","items":{"type":"string"},"description":"An array of the URI Subject Alternative Names from the certificate."}]},"x-min-runtime-version":"1.1"}},"required":["mode","tls_trust_bundles"],"x-min-runtime-version":"1.1"}},"required":["certificates"]},"TLSCertificateSensitiveDataAware":{"description":"A TLS certificate and its associated private key.","type":"object","properties":{"certificate":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"key":{"$ref":"#/components/schemas/GatewaySecret"}},"required":["certificate"]},"TLSCertificate":{"description":"A TLS certificate and its associated private key.","type":"object","properties":{"certificate":{"$ref":"#/components/schemas/GatewaySecretReferenceOrLiteral"},"key":{"$ref":"#/components/schemas/GatewaySecret"}},"required":["certificate","key"]},"EventGatewayListenerPolicyCreate":{"description":"The typed schema of the listener policy to modify it.","discriminator":{"propertyName":"type","mapping":{"tls_server":"#/components/schemas/EventGatewayTLSListenerPolicy","forward_to_virtual_cluster":"#/components/schemas/ForwardToVirtualClusterPolicy"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayTLSListenerPolicy"},{"$ref":"#/components/schemas/ForwardToVirtualClusterPolicy"}]},"EventGatewayListenerPolicyUpdate":{"description":"The typed schema of the listener policy to modify it.","discriminator":{"propertyName":"type","mapping":{"tls_server":"#/components/schemas/EventGatewayTLSListenerSensitiveDataAwarePolicy","forward_to_virtual_cluster":"#/components/schemas/ForwardToVirtualClusterPolicy"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayTLSListenerSensitiveDataAwarePolicy"},{"$ref":"#/components/schemas/ForwardToVirtualClusterPolicy"}]},"EventGatewayPolicyPatch":{"description":"The schema of the policy to patch it.","properties":{"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"minLength":1,"nullable":true,"pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","maxLength":512,"nullable":true},"enabled":{"description":"Whether the policy is enabled.","type":"boolean"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","example":"context.topic.name.endsWith('my_suffix')","maxLength":1000,"nullable":true,"x-expression":{"type":"boolean"}},"labels":{"$ref":"#/components/schemas/Labels"}}},"EventGatewayListenerPolicyPatch":{"description":"The schema of the policy to patch it.","properties":{"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"minLength":1,"nullable":true,"pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","maxLength":512,"nullable":true},"enabled":{"description":"Whether the policy is enabled.","type":"boolean"},"labels":{"$ref":"#/components/schemas/Labels"}}},"TLSVersionRange":{"description":"A range of TLS versions.","type":"object","properties":{"min":{"description":"Minimum TLS version to use.","type":"string","default":"TLSv1.2","enum":["TLSv1.2","TLSv1.3"]},"max":{"description":"Maximum TLS version to use.","type":"string","default":"TLSv1.3","enum":["TLSv1.2","TLSv1.3"]}},"default":{"min":"TLSv1.2","max":"TLSv1.3"}},"ForwardToVirtualClusterPolicy":{"description":"Forwards requests to virtual clusters configured with port routing or SNI routing.\nWhile there can be multiple of these policies configured on a listener, there can only be one instance of\n`port_mapping`.\nWhen multiple policies are configured, the first one that matches the connection is used.\nIf no policy matches, the connection is rejected.\n\nWhen using `port_mapping`, there must be a mapping port for each broker on the backend cluster see\n`ForwardToClusterBySNIConfig` for more details.\n","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["forward_to_virtual_cluster"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the policy.","type":"object","discriminator":{"propertyName":"type","mapping":{"port_mapping":"#/components/schemas/ForwardToClusterByPortMappingConfig","sni":"#/components/schemas/ForwardToClusterBySNIConfig"}},"oneOf":[{"$ref":"#/components/schemas/ForwardToClusterBySNIConfig"},{"$ref":"#/components/schemas/ForwardToClusterByPortMappingConfig"}]}},"required":["type","config"],"title":"Forward to Virtual Cluster"},"ForwardToClusterByPortMappingConfig":{"description":"The configuration to forward request to `destination` and rewrite ports accordingly.\nAll broker ids must fit in the range of ports defined in the listener, if it doesn't the metadata request will\nreturn an error.\n\nFor example with ports: [9000, \"9092-9094\", \"9100\"] and `bootstrap_port: at_start` and brokers with ids\n1, 2, 3, 4 we will map: bootstrap to 9000 broker 1 to 9001, broker 2 to 9002, broker 3 to 9003, and broker 4\nto 9004 and fail the metadata request as these ports are not open.\n\nHowever, with the same configuration but with brokers with ids: 92,93,94,100 we will map: bootstrap to 9000,\nbroker 92 to 9092, broker 93 to 9093, broker 94 to 9094, and broker 100 to 9100.\n\nIn most cases users should use a single range `[\"9090-9094\"] ` and `bootstrap_port: at_start` and connect with\n`<host>:9090` as bootstrap server. Being able to use multiple ranges is only useful when when dealing with\ngaps in broker ids.\n\nIt is strongly discouraged to use port mapping in production.\n","type":"object","properties":{"type":{"type":"string","enum":["port_mapping"],"x-terraform-transform-const":true},"destination":{"$ref":"#/components/schemas/VirtualClusterReference"},"advertised_host":{"description":"Virtual brokers are advertised to clients using this host. Any kind of host supported by kafka can be used. If not defined, it's listen_address. If listen_address is `0.0.0.0` it's the destination IP of the TCP connection.","type":"string","pattern":"^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?)*$"},"bootstrap_port":{"description":"If set to `at_start`, the first port will be used as a bootstrap port.\nIt provides a stable endpoint to use as the bootstrap server for clients, regardless of broker\nIDs in the cluster.\n\nAdditionally, it offsets all ports by one, so for example, if there are 3 brokers (id=1, id=2, id=3)\nthen we will use 4 ports: 9092 (bootstrap), 9093 (id=1), 9094 (id=2), 9095 (id=3)\nWith `none` we will use 3 ports: 9092 (id=1), 9093 (id=2), 9094 (id=3).\n","type":"string","default":"at_start","enum":["none","at_start"]},"min_broker_id":{"description":"The lowest broker node ID in the cluster.","type":"integer","default":0}},"additionalProperties":false,"required":["type","destination","advertised_host"]},"ForwardToClusterBySNIConfig":{"description":"The configuration to forward requests to virtual clusters configured with SNI routing.\n","type":"object","properties":{"type":{"type":"string","enum":["sni"],"x-terraform-transform-const":true},"sni_suffix":{"description":"Optional suffix for TLS SNI validation.\n\nThis suffix is concatenated with the virtual cluster \"dns.label\" label to form the base name for the SNI.\nIf not provided, the virtual cluster \"dns.label\" label alone is used as the base name for the SNI.\nFor example with sni_suffix: `.example.com` and virtual cluster \"dns.label\" label: `my-cluster`,\nthe SNI suffix for it is `my-cluster.example.com`.\nIf \"dns.label\" label is absent on the virtual cluster, the traffic won't be routed there.\n\nThe bootstrap host is `bootstrap.my-cluster.example.com` and then each broker is addressable at `broker-0.my-cluster.example.com`, `broker-1.my-cluster.example.com`, etc.\nThis means that your deployment needs to have a wildcard certificate for the domain and a DNS resolver that routes `*.my-cluster.example.com` to the proxy.\n\nThe accepted format is a DNS subdomain starting with either `.` or `-`. For example, `-keg.example.com`, `.keg.example.com`, `.namespace.svc.cluster.local`, and `.localhost` are all valid,\nwhile `keg.example.com` is not.\n","type":"string","example":".example.com","pattern":"^[\\.-]([a-z0-9]([a-z0-9-]*[a-z0-9])?\\.)*([a-z0-9-]*[a-z0-9])$"},"advertised_port":{"description":"Virtual brokers are advertised to clients with this port instead of listen_port. Useful when proxy is\nbehind loadbalancer listening on different port.\n","type":"integer","maximum":65535,"minimum":1},"broker_host_format":{"description":"Configures DNS names assigned to brokers in virtual clusters.\n\n- `per_cluster_suffix` is the default and allocates one level in the hierarchy for virtual clusters: `broker-{node_id}.{virtual_cluster}.{sni_suffix}`\n- `shared_suffix` puts all brokers from every virtual clusters into the same level: `broker-{node_id}-{virtual_cluster}.{sni_suffix}`. This makes it easier to manage certificates for this listener.\n\n**Requires a minimum runtime version of `1.1`**.","type":"object","properties":{"type":{"type":"string","default":"per_cluster_suffix","enum":["per_cluster_suffix","shared_suffix"]}},"required":["type"],"x-min-runtime-version":"1.1"}},"additionalProperties":false,"required":["type"]},"EventGatewayConsumePolicyCreate":{"description":"The typed schema of the consume policy to modify it.","discriminator":{"propertyName":"type","mapping":{"modify_headers":"#/components/schemas/EventGatewayModifyHeadersPolicyCreate","schema_validation":"#/components/schemas/EventGatewayConsumeSchemaValidationPolicy","decrypt":"#/components/schemas/EventGatewayDecryptPolicy","skip_record":"#/components/schemas/EventGatewaySkipRecordPolicyCreate"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayConsumeSchemaValidationPolicy"},{"$ref":"#/components/schemas/EventGatewayModifyHeadersPolicyCreate"},{"$ref":"#/components/schemas/EventGatewaySkipRecordPolicyCreate"},{"$ref":"#/components/schemas/EventGatewayDecryptPolicy"}]},"EventGatewayConsumePolicyUpdate":{"description":"The typed schema of the consume policy to modify it.","discriminator":{"propertyName":"type","mapping":{"modify_headers":"#/components/schemas/EventGatewayModifyHeadersPolicy","schema_validation":"#/components/schemas/EventGatewayConsumeSchemaValidationPolicy","decrypt":"#/components/schemas/EventGatewayDecryptPolicy","skip_record":"#/components/schemas/EventGatewaySkipRecordPolicy"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayModifyHeadersPolicy"},{"$ref":"#/components/schemas/EventGatewayConsumeSchemaValidationPolicy"},{"$ref":"#/components/schemas/EventGatewayDecryptPolicy"},{"$ref":"#/components/schemas/EventGatewaySkipRecordPolicy"}]},"EventGatewayProducePolicyCreate":{"description":"The typed schema of the produce policy to modify it.","discriminator":{"propertyName":"type","mapping":{"modify_headers":"#/components/schemas/EventGatewayModifyHeadersPolicyCreate","schema_validation":"#/components/schemas/EventGatewayProduceSchemaValidationPolicy","encrypt":"#/components/schemas/EventGatewayEncryptPolicy"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayModifyHeadersPolicyCreate"},{"$ref":"#/components/schemas/EventGatewayProduceSchemaValidationPolicy"},{"$ref":"#/components/schemas/EventGatewayEncryptPolicy"}]},"EventGatewayProducePolicyUpdate":{"description":"The typed schema of the produce policy to modify it.","discriminator":{"propertyName":"type","mapping":{"modify_headers":"#/components/schemas/EventGatewayModifyHeadersPolicy","schema_validation":"#/components/schemas/EventGatewayProduceSchemaValidationPolicy","encrypt":"#/components/schemas/EventGatewayEncryptPolicy"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayProduceSchemaValidationPolicy"},{"$ref":"#/components/schemas/EventGatewayModifyHeadersPolicy"},{"$ref":"#/components/schemas/EventGatewayEncryptPolicy"}]},"EventGatewayClusterPolicyModify":{"description":"The typed schema of the cluster policy to modify it.","discriminator":{"propertyName":"type","mapping":{"acls":"#/components/schemas/EventGatewayACLsPolicy"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayACLsPolicy"}]},"EventGatewayEncryptPolicy":{"description":"Encrypts Kafka records or keys using AES_256_GCM. Keys are therefore 256 bits long.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["encrypt"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the policy.","type":"object","$ref":"#/components/schemas/EventGatewayEncryptConfig"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","example":"context.topic.name.endsWith(\"my_suffix\") && record.headers[\"x-flag\"] == \"a-value\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.topic.name","type":"string","description":"The name of the topic."},{"name":"record.headers","type":"object","description":"An associative array of header key value pairs."}]}}},"required":["type","config"],"title":"Encrypt"},"EventGatewayEncryptConfig":{"description":"The configuration of the encrypt policy.","type":"object","properties":{"failure_mode":{"$ref":"#/components/schemas/EncryptionFailureMode"},"part_of_record":{"description":"Describes the parts of a record to encrypt.","type":"array","items":{"$ref":"#/components/schemas/EncryptionRecordPart"},"minItems":1},"encryption_key":{"$ref":"#/components/schemas/EncryptionKey"}},"required":["failure_mode","part_of_record","encryption_key"]},"EventGatewayDecryptPolicy":{"description":"Decrypts Kafka records or keys using AES_256_GCM. Keys are therefore 256 bits long.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["decrypt"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the policy.","type":"object","$ref":"#/components/schemas/EventGatewayDecryptPolicyConfig"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","example":"context.topic.name.endsWith(\"my_suffix\") && record.headers[\"x-flag\"] == \"a-value\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.topic.name","type":"string","description":"The name of the topic."},{"name":"record.headers","type":"object","description":"An associative array of header key value pairs."}]}}},"required":["type","config"],"title":"Decrypt"},"EventGatewayDecryptPolicyConfig":{"description":"The configuration of the decrypt policy.","type":"object","properties":{"failure_mode":{"$ref":"#/components/schemas/EncryptionFailureMode"},"key_sources":{"description":"Describes how to find a symmetric key for decryption.","type":"array","items":{"$ref":"#/components/schemas/EventGatewayKeySource"},"minItems":1},"part_of_record":{"description":"Describes the parts of a record to decrypt.","type":"array","items":{"$ref":"#/components/schemas/DecryptionRecordPart"},"minItems":1}},"required":["failure_mode","key_sources","part_of_record"]},"EventGatewayModifyHeadersPolicy":{"description":"A policy that modifies headers for requests.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["modify_headers"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the modify headers policy.","type":"object","properties":{"actions":{"description":"Actions are run in sequential order and act on individual headers.","type":"array","items":{"$ref":"#/components/schemas/EventGatewayModifyHeaderAction"},"minItems":1}}},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.\n\nWhen the policy is applied as a child policy of schema_validation, the expression can also reference\n`record.value` fields.\n","type":"string","example":"record.value.content.foo.bar == \"a-value\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.topic.name","type":"string","description":"The name of the topic."},{"name":"record.headers","type":"object","description":"An associative array of header key value pairs."},{"name":"record.value.validated","type":"boolean","description":"Indicates whether the record value was successfully validated."},{"name":"record.value.content","type":"object","description":"The content of the record value."}]}}},"required":["type","config"],"title":"Modify Headers"},"EventGatewayModifyHeadersPolicyCreate":{"description":"A policy that modifies headers for requests.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["modify_headers"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the modify headers policy.","type":"object","properties":{"actions":{"description":"Actions are run in sequential order and act on individual headers.","type":"array","items":{"$ref":"#/components/schemas/EventGatewayModifyHeaderAction"},"minItems":1}}},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.\n\nWhen the policy is applied as a child policy of schema_validation, the expression can also reference\n`record.value` fields.\n","type":"string","example":"record.value.content.foo.bar == \"a-value\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.topic.name","type":"string","description":"The name of the topic."},{"name":"record.headers","type":"object","description":"An associative array of header key value pairs."},{"name":"record.value.validated","type":"boolean","description":"Indicates whether the record value was successfully validated."},{"name":"record.value.content","type":"object","description":"The content of the record value."}]}},"parent_policy_id":{"description":"The unique identifier of the parent schema validation policy, if any.","type":"string","format":"uuid"}},"required":["type","config"],"title":"Modify headers"},"EventGatewaySkipRecordPolicy":{"description":"A policy that skips processing of a record.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["skip_record"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.\n\nWhen the policy is applied as a child policy of schema_validation, the expression can also reference\n`record.value` fields.\n","type":"string","example":"record.value.content.foo.bar == \"a-value\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.topic.name","type":"string","description":"The name of the topic."},{"name":"record.headers","type":"object","description":"An associative array of header key value pairs."},{"name":"record.value.validated","type":"boolean","description":"Indicates whether the record value was successfully validated."},{"name":"record.value.content","type":"object","description":"The content of the record value."}]}}},"required":["type"]},"EventGatewaySkipRecordPolicyCreate":{"description":"A policy that skips processing of a record.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["skip_record"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.\n\nWhen the policy is applied as a child policy of schema_validation, the expression can also reference\n`record.value` fields.\n","type":"string","example":"record.value.content.foo.bar == \"a-value\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.topic.name","type":"string","description":"The name of the topic."},{"name":"record.headers","type":"object","description":"An associative array of header key value pairs."},{"name":"record.value.validated","type":"boolean","description":"Indicates whether the record value was successfully validated."},{"name":"record.value.content","type":"object","description":"The content of the record value."}]}},"parent_policy_id":{"description":"The unique identifier of the parent schema validation policy, if any.","type":"string","format":"uuid"}},"required":["type"],"title":"Skip Record"},"EventGatewayModifyHeaderAction":{"description":"An action that modifies a header.","discriminator":{"propertyName":"op","mapping":{"remove":"#/components/schemas/EventGatewayModifyHeaderRemoveAction","set":"#/components/schemas/EventGatewayModifyHeaderSetAction"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayModifyHeaderRemoveAction"},{"$ref":"#/components/schemas/EventGatewayModifyHeaderSetAction"}]},"EventGatewayModifyHeaderRemoveAction":{"description":"An action that removes a header by key.","type":"object","properties":{"op":{"type":"string","enum":["remove"],"x-terraform-transform-const":true},"key":{"description":"The key of the header to remove.","type":"string"}},"required":["op","key"]},"EventGatewayModifyHeaderSetAction":{"description":"An action that sets a header key and value.","type":"object","properties":{"op":{"type":"string","enum":["set"],"x-terraform-transform-const":true},"key":{"description":"The key of the header to set.","type":"string"},"value":{"description":"The value of the header to set.","type":"string"}},"required":["op","key","value"]},"EventGatewayConsumeSchemaValidationPolicy":{"description":"A policy that validates consume messages against a schema registry.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["schema_validation"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the schema validation policy.","type":"object","properties":{"type":{"$ref":"#/components/schemas/SchemaValidationType"},"schema_registry":{"$ref":"#/components/schemas/SchemaRegistryReference"},"key_validation_action":{"$ref":"#/components/schemas/ConsumeKeyValidationAction"},"value_validation_action":{"$ref":"#/components/schemas/ConsumeValueValidationAction"}},"required":["type"]},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","example":"context.topic.name.endsWith(\"my_suffix\") && record.headers[\"x-flag\"] == \"a-value\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.topic.name","type":"string","description":"The name of the topic."},{"name":"record.headers","type":"object","description":"An associative array of header key value pairs."}]}}},"required":["type","config"],"title":"Schema Validation"},"EventGatewayProduceSchemaValidationPolicy":{"description":"A policy that validates produce messages against a schema registry.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["schema_validation"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the policy.","type":"object","$ref":"#/components/schemas/EventGatewayProduceSchemaValidationPolicyConfig"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","example":"context.topic.name.endsWith(\"my_suffix\") && record.headers[\"x-flag\"] == \"a-value\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.topic.name","type":"string","description":"The name of the topic."},{"name":"record.headers","type":"object","description":"An associative array of header key value pairs."}]}}},"required":["type","config"],"title":"Schema Validation"},"EventGatewayProduceSchemaValidationPolicyConfig":{"description":"The configuration of the produce schema validation policy.","discriminator":{"propertyName":"type","mapping":{"confluent_schema_registry":"#/components/schemas/EventGatewayProduceSchemaValidationPolicySchemaRegistryConfig","json":"#/components/schemas/EventGatewayProduceSchemaValidationPolicyJsonConfig"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayProduceSchemaValidationPolicySchemaRegistryConfig"},{"$ref":"#/components/schemas/EventGatewayProduceSchemaValidationPolicyJsonConfig"}]},"EventGatewayProduceSchemaValidationPolicyJsonConfig":{"description":"The configuration of the produce schema validation policy when using JSON parsing without schema.","type":"object","properties":{"schema_registry":{"$ref":"#/components/schemas/SchemaRegistryReference"},"key_validation_action":{"$ref":"#/components/schemas/ProduceKeyValidationAction"},"value_validation_action":{"$ref":"#/components/schemas/ProduceValueValidationAction"},"type":{"type":"string","enum":["json"],"x-terraform-transform-const":true}},"required":["type"]},"EventGatewayProduceSchemaValidationPolicySchemaRegistryConfig":{"description":"The configuration of the produce schema validation policy when using a schema registry.","type":"object","properties":{"schema_registry":{"$ref":"#/components/schemas/SchemaRegistryReference"},"key_validation_action":{"$ref":"#/components/schemas/ProduceKeyValidationAction"},"value_validation_action":{"$ref":"#/components/schemas/ProduceValueValidationAction"},"type":{"type":"string","enum":["confluent_schema_registry"],"x-terraform-transform-const":true}},"required":["type"]},"EventGatewayACLsPolicy":{"description":"Apply Kafka ACLs to virtual cluster traffic.","type":"object","properties":{"type":{"description":"The type name of the policy.","type":"string","enum":["acls"],"maxLength":255,"minLength":1,"x-terraform-transform-const":true},"name":{"description":"A unique user-defined name of the policy.","type":"string","maxLength":255,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the policy.","type":"string","default":"","maxLength":512},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","default":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"The configuration of the policy.","type":"object","$ref":"#/components/schemas/EventGatewayACLPolicyConfig"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","example":"context.auth.principal.name == \"this-user\"","default":"","maxLength":1000,"x-expression":{"type":"boolean","fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"}]}}},"required":["type","config"],"title":"ACL"},"EventGatewayACLPolicyConfig":{"description":"Apply ACLs to virtual cluster traffic.","type":"object","properties":{"rules":{"description":"Every ACL rule in this list applies independently.","type":"array","items":{"$ref":"#/components/schemas/EventGatewayACLRule"},"minItems":1}},"required":["rules"]},"EventGatewayACLRule":{"description":"A Kafka ACL rule to apply to virtual cluster traffic","type":"object","properties":{"resource_type":{"description":"This rule applies to access only for type of resource","type":"string","enum":["topic","group","transactional_id","cluster"]},"action":{"description":"How to handle the request if the rule matches","type":"string","enum":["allow","deny"]},"operations":{"description":"Types of Kafka operations to match against. Note that not every operation can apply to every resource type.","type":"array","items":{"$ref":"#/components/schemas/EventGatewayACLOperation"}},"resource_names":{"description":"If any of these entries match, the resource name matches for this rule. A maximum of 50 entries are allowed.","oneOf":[{"$ref":"#/components/schemas/EventGatewayACLRuleResourceNamesStaticArray"},{"$ref":"#/components/schemas/EventGatewayACLRuleResourceNamesDynamicArray"}]}},"required":["resource_type","action","operations","resource_names"]},"EventGatewayACLOperation":{"description":"An Event Gateway operation to match against in an ACL rule.","type":"object","properties":{"name":{"type":"string","enum":["all","alter","alter_configs","create","delete","describe","describe_configs","idempotent_write","read","write"]}},"required":["name"]},"EventGatewayACLResourceName":{"description":"An Event Gateway resource name to match against in an ACL rule.","type":"object","properties":{"match":{"description":"Currently supported are exact matches and globs.\nAll `*` characters are interpreted as globs, i.e. they match zero or more of any character.\n","type":"string","format":"glob"}},"required":["match"]},"EventGatewayACLRuleResourceNamesStaticArray":{"description":"A static list of resource name globs to match against resources when applying an ACL policy.","type":"array","items":{"$ref":"#/components/schemas/EventGatewayACLResourceName"},"example":[{"match":"orders-*"},{"match":"payments-*"}],"maxItems":50},"EventGatewayACLRuleResourceNamesDynamicArray":{"description":"This expression should evaluate to an array of glob patterns,\nequivalent to the `match` values in the static array form of `resource_names`.\n\n**Requires a minimum runtime version of `1.1`**.","type":"string","example":"context.auth.token.claims[\"topics\"]","x-expression":{"type":"array","items":{"type":"string"},"fields":[{"name":"context.auth.principal.name","type":"string","description":"Name of authenticated principal. Username in case of PLAIN/SCRAM, `sub` claim in case of OAUTHBEARER."},{"name":"context.auth.type","type":"string","description":"The matched authentication type from a virtual cluster: anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512, sasl_oauth_bearer.\n"},{"name":"context.auth.token.claims","type":"object","description":"All claims from the JWT token. Only populated for sasl_oauth_bearer authentication. Claims can be strings, numbers, booleans, arrays or nested JSON objects."}]},"x-min-runtime-version":"1.1"},"EventGatewayKeySource":{"description":"A key source that describes how to find a symmetric key for encryption or decryption.\nIt can be an AWS KMS key source that uses a KMS to find a symmetric key,\nor a static key source that uses a static symmetric key provided as secrets.\n","discriminator":{"propertyName":"type","mapping":{"aws":"#/components/schemas/EventGatewayAWSKeySource","static":"#/components/schemas/EventGatewayStaticKeySource"}},"oneOf":[{"$ref":"#/components/schemas/EventGatewayAWSKeySource"},{"$ref":"#/components/schemas/EventGatewayStaticKeySource"}]},"EventGatewayAWSKeySource":{"description":"A key source that uses an AWS KMS to find a symmetric key. Load KMS credentials from the environment.\n\nSee [aws docs](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/credproviders.html#credproviders-default-credentials-provider-chain)\nfor more information about how credential retrieval.\n","type":"object","properties":{"type":{"type":"string","enum":["aws"],"x-terraform-transform-const":true}},"additionalProperties":false,"required":["type"]},"EventGatewayStaticKeySource":{"description":"A key source that uses static symmetric keys.\n","type":"object","properties":{"type":{"type":"string","enum":["static"],"x-terraform-transform-const":true}},"additionalProperties":false,"required":["type"]},"EncryptionFailureMode":{"description":"Describes how to handle failing encryption or decryption.\nUse `error` if the record should be rejected if encryption or decryption fails.\nUse `passthrough` to ignore encryption or decryption failure and continue proxying the record.\n","type":"string","enum":["error","passthrough"]},"EncryptionRecordPart":{"description":"* key - encrypt the record key\n* value - encrypt the record value\n","type":"string","enum":["key","value"]},"DecryptionRecordPart":{"description":"* key - decrypt the record key\n* value - decrypt the record value\n","type":"string","enum":["key","value"]},"EncryptionKey":{"description":"The key to use for encryption.\n","discriminator":{"propertyName":"type","mapping":{"aws":"#/components/schemas/EncryptionKeyAWS","static":"#/components/schemas/EncryptionKeyStatic"}},"oneOf":[{"$ref":"#/components/schemas/EncryptionKeyAWS"},{"$ref":"#/components/schemas/EncryptionKeyStatic"}]},"EncryptionKeyAWS":{"description":"The AWS KMS key to use for encryption.\n","type":"object","properties":{"type":{"type":"string","enum":["aws"],"x-terraform-transform-const":true},"arn":{"description":"The AWS KMS key ARN.","type":"string","maxLength":2048,"minLength":10,"pattern":"^arn:aws:kms:.+"}},"example":{"type":"aws","arn":"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"},"required":["type","arn"]},"EncryptionKeyStatic":{"description":"A static encryption key.\n","type":"object","properties":{"type":{"type":"string","enum":["static"],"x-terraform-transform-const":true},"key":{"$ref":"#/components/schemas/EncryptionKeyStaticReference"}},"required":["type","key"]},"EncryptionKeyStaticReference":{"description":"A static encryption key reference, either by ID or by value.\n","anyOf":[{"$ref":"#/components/schemas/EncryptionKeyStaticReferenceById"},{"$ref":"#/components/schemas/EncryptionKeyStaticReferenceByName"}],"x-terraform-preferred":"#/components/schemas/EncryptionKeyStaticReferenceById"},"EncryptionKeyStaticReferenceById":{"description":"A static encryption key reference by ID.","type":"object","properties":{"id":{"description":"The ID of the static key defined in the key source.","type":"string","format":"uuid","minLength":1}},"required":["id"]},"EncryptionKeyStaticReferenceByName":{"description":"A static encryption key reference by name.","type":"object","properties":{"name":{"description":"The name of the static key defined in the key source.","type":"string","maxLength":255,"minLength":1}},"required":["name"]},"ConsumeKeyValidationAction":{"description":"Defines a behavior when record key is not valid.\n* mark - marks a record with kong/server header and client ID value\n  to help to identify the clients violating schema.\n* skip - skips delivering a record.\n","type":"string","enum":["mark","skip"]},"ConsumeValueValidationAction":{"description":"Defines a behavior when record value is not valid.\n* mark - marks a record with kong/server header and client ID value\n  to help to identify the clients violating schema.\n* skip - skips delivering a record.\n","type":"string","enum":["mark","skip"]},"ProduceKeyValidationAction":{"description":"Defines a behavior when record key is not valid.\n* reject - rejects a batch for topic partition. Only available for produce.\n* mark - marks a record with kong/server header and client ID value\n  to help to identify the clients violating schema.\n","type":"string","enum":["reject","mark"]},"ProduceValueValidationAction":{"description":"Defines a behavior when record value is not valid.\n* reject - rejects a batch for topic partition. Only available for produce.\n* mark - marks a record with kong/server header and client ID value\n  to help to identify the clients violating schema.\n","type":"string","enum":["reject","mark"]},"MoveEventGatewayPolicy":{"description":"Defines the position of a policy relative to the policy chain.","type":"object","properties":{"index":{"description":"The position of the policy relative to the policy chain.","type":"integer","example":2,"minimum":0}},"required":["index"]},"EventGatewayDataPlaneCertificate":{"description":"A dataplane certificate.","type":"object","properties":{"id":{"description":"The unique identifier of the certificate.","type":"string","format":"uuid"},"certificate":{"description":"JSON escaped string of the certificate.","type":"string"},"name":{"description":"The name to identify of the certificate.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A description of the certificate.","type":"string"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"metadata":{"$ref":"#/components/schemas/CertificateMetadata"}},"required":["id","certificate","created_at","updated_at"]},"CertificateMetadata":{"description":"Metadata extracted from a certificate.","type":"object","properties":{"issuer":{"description":"The issuer of the certificate.","type":"string"},"subject":{"description":"The subject of the certificate.","type":"string"},"key_usages":{"description":"The key usages of the certificate.","type":"array","items":{"type":"string"}},"expiry":{"description":"The expiry date of the certificate as a unix timestamp.","type":"integer","format":"int64"},"san_names":{"description":"The Subject Alternative Names (SAN) of the certificate.","type":"array","items":{"type":"string"}},"dns_names":{"description":"The DNS names in the certificate SAN.","type":"array","items":{"type":"string"}},"email_addresses":{"description":"The email addresses in the certificate SAN.","type":"array","items":{"type":"string"}},"ip_addresses":{"description":"The IP addresses in the certificate SAN.","type":"array","items":{"type":"string"}},"uris":{"description":"The URIs in the certificate SAN.","type":"array","items":{"type":"string","format":"uri"}},"sha256_fingerprint":{"description":"The SHA-256 fingerprint of the certificate.","type":"string"}}},"EventGatewayNodeError":{"description":"An error reported by an event gateway node.","type":"object","properties":{"name":{"description":"The name of the error.","type":"string"},"message":{"description":"The error message.","type":"string"}},"required":["name","message"]},"VirtualClusterNamespace":{"description":"Namespace allows to implement multitenancy using a single backend cluster.\nIt allows to either hide or enforce a static prefix on resources (topics, consumer group IDs, transaction IDs).\n","type":"object","properties":{"mode":{"description":"* hide_prefix - the configured prefix is hidden from clients for topics and IDs when reading.\n  Created resources are written with the prefix on the backend cluster.\n* enforce_prefix - the configured prefix remains visible to clients.\n  Created resources must include the prefix or the request will fail.\n","type":"string","enum":["hide_prefix","enforce_prefix"]},"prefix":{"description":"The namespace is differentiated by this chosen prefix.\nFor example, if the prefix is set to \"analytics_\" the topic named \"analytics_user_clicks\" is available to the clients\nof the virtual cluster. Topics without the prefix will be ignored unless added via `additional.topics`.\n","type":"string","minLength":1},"additional":{"$ref":"#/components/schemas/VirtualClusterNamespaceAdditionalProperties"}},"required":["mode","prefix"]},"VirtualClusterNamespaceAdditionalProperties":{"type":"object","properties":{"topics":{"description":"Additional backend topics to expose even if they don't match the namespace prefix.\nThe topics are not affected by the hide/enforce prefix mode.\nIf the client tries to create a topic that matches this list, the request is rejected.\n","type":"array","items":{"$ref":"#/components/schemas/VirtualClusterNamespaceTopicSelector"}},"consumer_groups":{"description":"Consumer group IDs to expose even if they don't start with the namespace prefix.\n","type":"array","items":{"$ref":"#/components/schemas/VirtualClusterNamespaceIdSelector"}}}},"VirtualClusterNamespaceTopicSelector":{"type":"object","discriminator":{"propertyName":"type","mapping":{"glob":"#/components/schemas/VirtualClusterNamespaceTopicSelectorGlob","exact_list":"#/components/schemas/VirtualClusterNamespaceTopicSelectorExactList"}},"oneOf":[{"$ref":"#/components/schemas/VirtualClusterNamespaceTopicSelectorGlob"},{"$ref":"#/components/schemas/VirtualClusterNamespaceTopicSelectorExactList"}],"required":["type"]},"VirtualClusterNamespaceTopicSelectorGlob":{"type":"object","properties":{"type":{"type":"string","enum":["glob"],"x-terraform-transform-const":true},"glob":{"description":"Expose any backend topic that matches this glob pattern (e.g., `operations_data_*`).","type":"string","format":"glob","minLength":1,"pattern":"^[A-Za-z0-9._?*-]+$"},"conflict":{"description":"How to inform the user about conflicts where multiple backend topics would map to the same virtual topic name.\n* warn - log in the Event Gateway logs. Additionally, it sets knep_namespace_topic_conflict to 1.\n* ignore - do not do anything. It does not cause knep_namespace_topic_conflict metric to be set to 1.\n","type":"string","default":"warn","enum":["warn","ignore"]}},"required":["type","glob"]},"VirtualClusterNamespaceTopicSelectorExactList":{"type":"object","properties":{"type":{"type":"string","enum":["exact_list"],"x-terraform-transform-const":true},"exact_list":{"description":"Explicit allow-list of backend topic names.","type":"array","items":{"$ref":"#/components/schemas/NamespaceExactAllowListItem"},"minItems":1},"conflict":{"description":"How to inform the user about conflicts where multiple backend topics would map to the same virtual topic name.\n* warn - log in the Event Gateway logs. Additionally, it sets knep_namespace_topic_conflict to 1.\n* ignore - do not do anything. It does not cause knep_namespace_topic_conflict metric to be set to 1.\n","type":"string","default":"warn","enum":["warn","ignore"]}},"required":["type"]},"NamespaceExactAllowListItem":{"type":"object","properties":{"backend":{"type":"string","minLength":1}},"required":["backend"]},"VirtualClusterNamespaceIdSelector":{"type":"object","discriminator":{"propertyName":"type","mapping":{"glob":"#/components/schemas/VirtualClusterNamespaceIdSelectorGlob","exact_list":"#/components/schemas/VirtualClusterNamespaceIdSelectorExactList"}},"oneOf":[{"$ref":"#/components/schemas/VirtualClusterNamespaceIdSelectorGlob"},{"$ref":"#/components/schemas/VirtualClusterNamespaceIdSelectorExactList"}],"required":["type"]},"VirtualClusterNamespaceIdSelectorGlob":{"type":"object","properties":{"type":{"type":"string","enum":["glob"],"x-terraform-transform-const":true},"glob":{"description":"Expose any id that matches this glob pattern (e.g., `my_id_*`).","type":"string","format":"glob","minLength":1,"pattern":"^[A-Za-z0-9._?*-]+$"}},"required":["type","glob"]},"VirtualClusterNamespaceIdSelectorExactList":{"type":"object","properties":{"type":{"type":"string","enum":["exact_list"],"x-terraform-transform-const":true},"exact_list":{"type":"array","items":{"type":"object","required":["value"],"properties":{"value":{"type":"string","minLength":1}}},"minItems":1}},"required":["type"]},"EventGatewayStaticKey":{"description":"A symmetric key with its secret value.\n","type":"object","properties":{"name":{"description":"The unique name of the static key.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the static key.","type":"string","default":"","maxLength":512},"labels":{"$ref":"#/components/schemas/Labels"},"id":{"description":"The unique identifier of the static key.","type":"string","format":"uuid"},"value":{"$ref":"#/components/schemas/GatewaySecret"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["name","id","created_at","updated_at"]},"EventGatewayStaticKeyCreate":{"description":"A symmetric key with its secret value for creation.\n","type":"object","properties":{"name":{"description":"The unique name of the static key.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the static key.","type":"string","default":"","maxLength":512},"labels":{"$ref":"#/components/schemas/Labels"},"value":{"$ref":"#/components/schemas/GatewaySecret"}},"required":["name","value"]},"EventGatewayPolicyReference":{"description":"The unique identifier of the policy.","type":"string","format":"uuid"},"CursorMetaPage":{"type":"object","properties":{"first":{"description":"URI to the first page","type":"string","format":"path"},"last":{"description":"URI to the last page","type":"string","format":"path"},"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"previous":{"description":"URI to the previous page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size","next","previous"]},"CursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/CursorMetaPage"}},"required":["page"]},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"StringFieldContainsFilter":{"description":"Filters on the given string field value by fuzzy match.","type":"object","properties":{"contains":{"type":"string"}},"additionalProperties":false,"required":["contains"],"title":"StringFieldContainsFilter","x-examples":{"example-1":{"contains":"some-value"}}},"GatewayName":{"description":"The name of the Gateway.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"GatewayDescription":{"description":"A human-readable description of the Gateway.","type":"string","maxLength":512},"Labels":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"Labels"},"MinRuntimeVersion":{"description":"The minimum runtime version supported by the API. This is the lowest version of the data plane\nrelease that can be used with the entity model.\nWhen not specified, the minimum runtime version will be pinned to the latest available release.\n","type":"string","example":"1.1","pattern":"^\\d+\\.\\d+$"},"CreateGatewayRequest":{"description":"The request schema for the create gateway request.","type":"object","properties":{"name":{"$ref":"#/components/schemas/GatewayName"},"description":{"$ref":"#/components/schemas/GatewayDescription"},"min_runtime_version":{"$ref":"#/components/schemas/MinRuntimeVersion"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name"],"title":"CreateGatewayRequest"},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"MinRuntimeVersionUpdate":{"description":"The minimum runtime version supported by the API. This is the lowest version of the data plane\nrelease that can be used with the entity model.\nWhen not specified, the minimum runtime version will not be updated.\n","type":"string","example":"1.1","pattern":"^\\d+\\.\\d+$"},"UpdateGatewayRequest":{"description":"The request schema for the update gateway request.","type":"object","properties":{"name":{"$ref":"#/components/schemas/GatewayName"},"description":{"$ref":"#/components/schemas/GatewayDescription"},"min_runtime_version":{"$ref":"#/components/schemas/MinRuntimeVersionUpdate"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"title":"UpdateGatewayRequest"},"PatchGatewayRequest":{"description":"The request schema for the patch gateway request.","type":"object","properties":{"name":{"$ref":"#/components/schemas/GatewayName"},"description":{"description":"A human-readable description of the Gateway.","type":"string","maxLength":512,"nullable":true},"min_runtime_version":{"description":"The minimum runtime version supported by the API. This is the lowest version of the data plane\nrelease that can be used with the entity model.\nWhen not specified, the minimum runtime version will not be updated.\n","type":"string","example":"1.1","nullable":true,"pattern":"^\\d+\\.\\d+$"},"labels":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"nullable":true,"title":"Labels"}},"additionalProperties":false,"title":"PatchGatewayRequest"},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","properties":{"eq":{"type":"string"}},"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"GatewaySecretReferenceOrLiteral":{"description":"A literal value or a reference to an existing secret as a template string expression.\nThe value is stored and returned by the API as-is, not treated as sensitive information.\n","type":"string","minLength":1,"x-examples":{"reference":{"summary":"Reference to a secret","value":"${vault.env['MY_ENV_VAR']}"},"literal":{"summary":"Literal value","value":"my-literal-value"}},"x-expression":{"type":"string","fields":["vault"]}},"GatewaySecret":{"description":"A sensitive value containing the secret or a reference to a secret as a template string expression.\nIf the value is provided as plain text, it is encrypted at rest and omitted from API responses.\nIf provided as an expression, the expression itself is stored and returned by the API.\n","type":"string","example":"${vault.env['MY_ENV_VAR']}","minLength":1,"x-expression":{"type":"string","fields":["vault"]},"x-sensitive":true},"GatewayNode":{"type":"object","properties":{"id":{"description":"The node ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"version":{"description":"The string representation of the node current version.","type":"string"},"last_seen_at":{"description":"An ISO-8604 timestamp representation of node last seen date.","type":"string","format":"date-time","example":"2025-08-04T20:10:06.927Z"},"created_at":{"description":"An ISO-8604 timestamp representation of node creation date.","type":"string","format":"date-time","example":"2025-08-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An ISO-8604 timestamp representation of node update date.","type":"string","format":"date-time","example":"2025-08-04T20:10:06.927Z","readOnly":true},"config_applied_at":{"description":"The time the node succeeds in applying the configuration.","type":"string","format":"date-time","readOnly":true},"config_version":{"description":"The version number of the configuration applied by the node.","type":"string","example":"v1.123","readOnly":true}},"required":["id","version","last_seen_at","created_at","updated_at"]}},"examples":{"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"CreateEventGatewayListenerRequest":{"description":"The request schema for creating a listener.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The unique name of the listener.","type":"string","maxLength":255,"minLength":1},"description":{"description":"A human-readable description of the listener.","type":"string","default":"","maxLength":512},"addresses":{"$ref":"#/components/schemas/EventGatewayListenerAddresses"},"ports":{"$ref":"#/components/schemas/EventGatewayListenerPorts"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","addresses","ports"]}}}},"UpdateEventGatewayListenerRequest":{"description":"The request schema for updating a listener.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The unique name of the listener.","type":"string","maxLength":255,"minLength":1},"description":{"description":"A human-readable description of the listener.","type":"string","default":"","maxLength":512},"addresses":{"$ref":"#/components/schemas/EventGatewayListenerAddresses"},"ports":{"$ref":"#/components/schemas/EventGatewayListenerPorts"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","addresses","ports"]}}}},"CreateVirtualClusterRequest":{"description":"The request schema for creating a virtual cluster.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/VirtualClusterName"},"description":{"description":"A human-readable description of the virtual cluster.","type":"string","default":"","maxLength":512},"destination":{"$ref":"#/components/schemas/BackendClusterReferenceModify"},"authentication":{"$ref":"#/components/schemas/VirtualClusterAuthenticationSchemes"},"namespace":{"$ref":"#/components/schemas/VirtualClusterNamespace"},"acl_mode":{"$ref":"#/components/schemas/VirtualClusterACLMode"},"dns_label":{"$ref":"#/components/schemas/VirtualClusterDNSLabel"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","destination","authentication","dns_label","acl_mode"]}}}},"UpdateVirtualClusterRequest":{"description":"The request schema for updating a virtual cluster.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/VirtualClusterName"},"description":{"description":"A human-readable description of the virtual cluster.","type":"string","default":"","maxLength":512},"destination":{"$ref":"#/components/schemas/BackendClusterReferenceModify"},"authentication":{"$ref":"#/components/schemas/VirtualClusterAuthenticationSensitiveDataAwareSchemes"},"namespace":{"$ref":"#/components/schemas/VirtualClusterNamespace"},"acl_mode":{"$ref":"#/components/schemas/VirtualClusterACLMode"},"dns_label":{"$ref":"#/components/schemas/VirtualClusterDNSLabel"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","destination","authentication","dns_label","acl_mode"]}}}},"CreateBackendClusterRequest":{"description":"The request schema for creating a backend cluster.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/BackendClusterName"},"description":{"description":"A human-readable description of the backend cluster.","type":"string","default":"","maxLength":512},"authentication":{"$ref":"#/components/schemas/BackendClusterAuthenticationScheme"},"insecure_allow_anonymous_virtual_cluster_auth":{"description":"If true, virtual clusters can have allow anonymous authentication and use this backend cluster.\nThis setting is not recommended for production use as it may create privilege escalation vulnerabilities.\n","type":"boolean","default":false},"bootstrap_servers":{"$ref":"#/components/schemas/BootstrapServers"},"tls":{"$ref":"#/components/schemas/BackendClusterTLS"},"metadata_update_interval_seconds":{"$ref":"#/components/schemas/BackendMetadataUpdateIntervalSeconds"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","authentication","bootstrap_servers","tls"]}}}},"UpdateBackendClusterRequest":{"description":"The request schema for updating a backend cluster.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/BackendClusterName"},"description":{"description":"A human-readable description of the backend cluster.","type":"string","default":"","maxLength":512},"authentication":{"$ref":"#/components/schemas/BackendClusterAuthenticationSensitiveDataAwareScheme"},"insecure_allow_anonymous_virtual_cluster_auth":{"description":"If true, virtual clusters can have allow anonymous authentication and use this backend cluster.\nThis setting is not recommended for production use as it may create privilege escalation vulnerabilities.\n","type":"boolean","default":false},"bootstrap_servers":{"$ref":"#/components/schemas/BootstrapServers"},"tls":{"$ref":"#/components/schemas/BackendClusterTLS"},"metadata_update_interval_seconds":{"$ref":"#/components/schemas/BackendMetadataUpdateIntervalSeconds"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","authentication","bootstrap_servers","tls"]}}}},"CreateSchemaRegistryRequest":{"description":"The request schema for creating a schema registry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaRegistryCreate"}}}},"UpdateSchemaRegistryRequest":{"description":"The request schema for updating a schema registry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaRegistryUpdate"}}}},"CreateEventGatewayListenerPolicyRequest":{"description":"The request schema for creating a listener policy.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListenerPolicyCreate"}}}},"UpdateEventGatewayListenerPolicyRequest":{"description":"The request schema for updating a listener policy.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListenerPolicyUpdate"}}}},"PatchEventGatewayPolicyRequest":{"description":"The request schema for patching a policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayPolicyPatch"}}}},"PatchEventGatewayListenerPolicyRequest":{"description":"The request schema for patching a listener policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayListenerPolicyPatch"}}}},"CreateEventGatewayConsumePolicyRequest":{"description":"The request schema for creating a consume policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayConsumePolicyCreate"}}}},"UpdateEventGatewayConsumePolicyRequest":{"description":"The request schema for updating a consume policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayConsumePolicyUpdate"}}}},"CreateEventGatewayProducePolicyRequest":{"description":"The request schema for creating a produce policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayProducePolicyCreate"}}}},"UpdateEventGatewayProducePolicyRequest":{"description":"The request schema for updating a produce policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayProducePolicyUpdate"}}}},"CreateEventGatewayClusterPolicyRequest":{"description":"The request schema for creating a cluster-level policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayClusterPolicyModify"}}}},"UpdateEventGatewayClusterPolicyRequest":{"description":"The request schema for updating a cluster-level policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayClusterPolicyModify"}}}},"CreateEventGatewayDataPlaneCertificateRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"description":"JSON escaped string of the certificate.","type":"string"},"name":{"description":"The name to identify of the certificate.","type":"string"},"description":{"description":"A description of the certificate.","type":"string","x-speakeasy-param-computed":false}},"required":["certificate"]},"examples":{"Sample Certificate":{"value":{"certificate":"-----BEGIN CERTIFICATE-----\r\n*****\r\n-----END CERTIFICATE-----\r\n"}}}}},"description":"Request body for creating a certificate."},"UpdateEventGatewayDataPlaneCertificateRequest":{"description":"The request schema for updating a dataplane certificate.","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"description":"JSON escaped string of the certificate.","type":"string"},"name":{"description":"The name to identify of the certificate.","type":"string"},"description":{"description":"A description of the certificate.","type":"string","x-speakeasy-param-computed":false}},"required":["certificate"]}}}},"CreateEventGatewayStaticKeyRequest":{"description":"The request schema for creating a static key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayStaticKeyCreate"}}}},"CreateTLSTrustBundleRequest":{"description":"The request schema for creating a TLS trust bundle.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TLSTrustBundleName"},"description":{"description":"A human-readable description of the TLS trust bundle.","type":"string","default":"","maxLength":512},"config":{"$ref":"#/components/schemas/TLSTrustBundleConfig"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","config"]}}}},"UpdateTLSTrustBundleRequest":{"description":"The request schema for updating a TLS trust bundle.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TLSTrustBundleName"},"description":{"description":"A human-readable description of the TLS trust bundle.","type":"string","default":"","maxLength":512},"config":{"$ref":"#/components/schemas/TLSTrustBundleConfig"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false}}}},"UpdateEventGatewayPolicyChainRequest":{"description":"The request schema for updating the policy chain.","content":{"application/json":{"schema":{"type":"object","properties":{"policies":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayPolicyReference"}}},"required":["policies"]}}}}},"responses":{"EventGatewayNodeStatus":{"description":"The status of an event gateway node.","content":{"application/json":{"schema":{"type":"object","properties":{"config_applied_at":{"description":"The time the node succeeds in applying the configuration.","type":"string","format":"date-time"},"config_version":{"description":"The version number of the configuration applied by the node.","type":"string","example":"v1.123"}},"required":["config_applied_at","config_version"]}}}},"ListEventGatewayNodeErrorsResponse":{"description":"A list of errors reported by an event gateway node.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayNodeError"}}},"additionalProperties":false,"required":["meta","data"]}}}},"ListEventGatewaysResponse":{"description":"A paginated list response for a collection of gateways.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayInfo"}}},"additionalProperties":false,"required":["meta","data"],"title":"ListEventGatewaysResponse"}}}},"ListEventGatewayListenersResponse":{"description":"A paginated list response for a collection of Event Gateway listeners.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayListener"}}}}}}},"ListVirtualClustersResponse":{"description":"A paginated list response for a collection of virtual clusters.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCluster"}}}}}}},"ListBackendClustersResponse":{"description":"A paginated list response for a collection of backend clusters.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BackendCluster"}}}}}}},"ListSchemaRegistriesResponse":{"description":"A paginated list response for a collection of schema registries.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SchemaRegistry"}}}}}}},"ListTLSTrustBundlesResponse":{"description":"A paginated list response for a collection of TLS trust bundles.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TLSTrustBundle"}}}}}}},"ListEventGatewayListenerPoliciesResponse":{"description":"A list response for a collection of policies associated with an Event Gateway listener.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayListenerPolicy"}}}}},"ListConsumePoliciesResponse":{"description":"A paginated list response for a collection of consume policies associated with an Event Gateway virtual cluster.\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}}},"ListProducePoliciesResponse":{"description":"A paginated list response for a collection of produce policies associated with an Event Gateway virtual cluster.\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}}},"ListClusterPoliciesResponse":{"description":"A paginated list response for a collection of cluster-level policies associated with an Event Gateway virtual\ncluster.\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayPolicy"}}}}},"ListEventGatewayNodesResponse":{"description":"A paginated list response for a collection of nodes associated with an Event Gateway.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GatewayNode"}}}}}}},"ListEventGatewayDataPlaneCertificatesResponse":{"description":"A paginated list response for a collection of certificates associated with an Event Gateway.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayDataPlaneCertificate"}}}}}}},"CreateGatewayResponse":{"description":"A response to creating a gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayInfo"}}}},"UpdateGatewayResponse":{"description":"A response to updating a gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGatewayInfo"}}}},"ListEventGatewayStaticKeysResponse":{"description":"A paginated list response for a collection of static keys.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayStaticKey"}}}}}}},"EventGatewayPolicyChainResponse":{"description":"A response containing the list of policies in order of execution.","content":{"application/json":{"schema":{"type":"object","properties":{"policies":{"type":"array","items":{"$ref":"#/components/schemas/EventGatewayPolicyReference"}}},"required":["policies"]}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"Internal":{"description":"Internal","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"NotAvailable":{"description":"Service not available","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"Event Gateways","description":"Create an Event Gateway Control Plane, used to store Event Gateway configuration\n"},{"name":"Event Gateway Backend Clusters","description":"A backend cluster is an abstraction of a real Kafka cluster. It stores the connection and configuration details required for Kong Event Gateway to proxy traffic to Kafka.\n\nMultiple Kafka clusters can be proxied through a single Kong Event Gateway.\n"},{"name":"Event Gateway Virtual Clusters","description":"Virtual clusters are the primary way clients interact with the Event Gateway proxy. They allow you to isolate clients from each other when connecting to the same backend cluster, and provide each client with modified view while still appearing as a standard Kafka cluster.\n"},{"name":"Event Gateway Listeners","description":"A listener represents hostname-port or IP-port combinations that connect to TCP sockets. Listeners need at least as many ports as backend brokers if you use port mapping in a Forward to Virtual Cluster policy. For SNI routing, you can route all brokers using a listener with only one port. Ports can be expressed as a single port or range. Addresses can be IPv4, IPv6, or hostnames.\n\nA listener can have policies that enforce TLS certificates and perform SNI routing. The listener runs at Layer 4 of the network stack. In Kong Event Gateway, listeners first take in the connection and then route the TCP connection to a virtual cluster based on conditions defined in listener policies.\n"},{"name":"Event Gateway Listener Policies","description":"Policies control how Kafka protocol traffic is modified between the client and the backend cluster.\n\nListener policies are routing policies that pass traffic to the virtual cluster.\n"},{"name":"Event Gateway Virtual Cluster Policies","description":"Policies control how Kafka protocol traffic is modified between the client and the backend cluster.\n\nCluster policies are transformation and validation policies that can be applied to Kafka messages.\n"},{"name":"Event Gateway Virtual Cluster Produce Policies","description":"Produce policies operate on Kafka messages before they are written to the Kafka cluster.\n\nWhere possible, apply transformations to the data using produce policies rather than consume policies for maximum efficiency.\n"},{"name":"Event Gateway Virtual Cluster Consume Policies","description":"Consume policies operate on Kafka messages as they are read from a Kafka cluster.\n\nTransformations may be applied at consume time, but they are applied once per Consumer. Where possible, transofmrations should be applied as a Produce policy\n"},{"name":"Event Gateway DataPlane Certificates","description":"DataPlane certificates control how your running Event Gateway instances connect to the Control Plane\n"},{"name":"Event Gateway Static Keys","description":"Static Keys are used by the Encrypt and Decrypt policies to encrypt data at rest\n"},{"name":"Event Gateway Schema Registries","description":"Configure a schema registry that can be used to validate payloads when producing/consuming messages\n"},{"name":"Event Gateway TLS Trust Bundles","description":"A TLS trust bundle defines a set of trusted certificate authorities (CAs) used for client certificate\nverification during mutual TLS (mTLS). Trust bundles are referenced by TLS listener policies to\ndetermine which client certificates are accepted.\n"},{"name":"Event Gateway Nodes"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
