---
title: "ForwardToClusterByPortMappingConfig"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19/schemas/ForwardToClusterByPortMappingConfig"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19.md

# ForwardToClusterByPortMappingConfig

The configuration to forward request to `destination` and rewrite ports accordingly. All broker ids must fit in the range of ports defined in the listener, if it doesn't the metadata request will return an error. For example with ports: [9000, "9092-9094", "9100"] and `bootstrap_port: at_start` and brokers with ids 1, 2, 3, 4 we will map: bootstrap to 9000 broker 1 to 9001, broker 2 to 9002, broker 3 to 9003, and broker 4 to 9004 and fail the metadata request as these ports are not open. However, with the same configuration but with brokers with ids: 92,93,94,100 we will map: bootstrap to 9000, broker 92 to 9092, broker 93 to 9093, broker 94 to 9094, and broker 100 to 9100. In most cases users should use a single range `["9090-9094"] ` and `bootstrap_port: at_start` and connect with `<host>:9090` as bootstrap server. Being able to use multiple ranges is only useful when when dealing with gaps in broker ids. It is strongly discouraged to use port mapping in production.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for Event Gateways
  version: 1.0.0
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
components:
  schemas:
    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
    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}]$
    ForwardToClusterByPortMappingConfig:
      description: >
        The configuration to forward request to `destination` and rewrite ports
        accordingly.

        All broker ids must fit in the range of ports defined in the listener,
        if it doesn't the metadata request will

        return an error.


        For example with ports: [9000, "9092-9094", "9100"] and `bootstrap_port:
        at_start` and brokers with ids

        1, 2, 3, 4 we will map: bootstrap to 9000 broker 1 to 9001, broker 2 to
        9002, broker 3 to 9003, and broker 4

        to 9004 and fail the metadata request as these ports are not open.


        However, with the same configuration but with brokers with ids:
        92,93,94,100 we will map: bootstrap to 9000,

        broker 92 to 9092, broker 93 to 9093, broker 94 to 9094, and broker 100
        to 9100.


        In most cases users should use a single range `["9090-9094"] ` and
        `bootstrap_port: at_start` and connect with

        `<host>:9090` as bootstrap server. Being able to use multiple ranges is
        only useful when when dealing with

        gaps in broker ids.


        It is strongly discouraged to use port mapping in production.
      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.

            It provides a stable endpoint to use as the bootstrap server for
            clients, regardless of broker

            IDs in the cluster.


            Additionally, it offsets all ports by one, so for example, if there
            are 3 brokers (id=1, id=2, id=3)

            then we will use 4 ports: 9092 (bootstrap), 9093 (id=1), 9094
            (id=2), 9095 (id=3)

            With `none` we will use 3 ports: 9092 (id=1), 9093 (id=2), 9094
            (id=3).
          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
```
