---
title: "List Backend Clusters"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19/operations/list-event-gateway-backend-clusters"
---

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

# List Backend Clusters

`GET` `/event-gateways/{gatewayId}/backend-clusters`

Operation ID: `list-event-gateway-backend-clusters`

Returns a list of backend clusters associated with the specified Event Gateway.

## Path parameters

- `gatewayId` (string, uuid, required) - The UUID of your Gateway.

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[after]` (string, optional) - Request the next page of data, starting with the item after this parameter.
- `filter` (object, optional) - Filter documents returned in the response.

## Responses

- `200` - A paginated list response for a collection of backend clusters.
- `401` - Unauthorized
- `403` - Forbidden

## 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
paths:
  /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
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    gatewayId:
      name: gatewayId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: The UUID of your Gateway.
    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
    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
    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
  responses:
    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"
    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"
  schemas:
    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
    CursorMeta:
      description: Pagination metadata.
      type: object
      properties:
        page:
          $ref: "#/components/schemas/CursorMetaPage"
      required:
        - page
    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/BackendClusterAuthenticationSensitiveDataAwareSchem\
            e"
        insecure_allow_anonymous_virtual_cluster_auth:
          description: >
            If true, virtual clusters can have allow anonymous authentication
            and use this backend cluster.

            This setting is not recommended for production use as it may create
            privilege escalation vulnerabilities.
          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
    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
    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
    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}]$
    BackendClusterAuthenticationSensitiveDataAwareScheme:
      discriminator:
        propertyName: type
        mapping:
          anonymous: "#/components/schemas/BackendClusterAuthenticationAnonymous"
          sasl_plain: "#/components/schemas/BackendClusterAuthenticationSaslPlainSensitiv\
            eDataAware"
          sasl_scram: "#/components/schemas/BackendClusterAuthenticationSaslScramSensitiv\
            eDataAware"
      oneOf:
        - $ref: "#/components/schemas/BackendClusterAuthenticationAnonymous"
        - $ref: "#/components/schemas/BackendClusterAuthenticationSaslPlainSensitiveDataA\
            ware"
        - $ref: "#/components/schemas/BackendClusterAuthenticationSaslScramSensitiveDataA\
            ware"
    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.

            **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
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      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
    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
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          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
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    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.
      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
    BackendClusterAuthenticationSaslScramSensitiveDataAware:
      description: >
        SASL/SCRAM authentication scheme for the backend cluster without
        requiring sensitive password data.
      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
    GatewaySecretReferenceOrLiteral:
      description: >
        A literal value or a reference to an existing secret as a template
        string expression.

        The value is stored and returned by the API as-is, not treated as
        sensitive information.
      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.

        If the value is provided as plain text, it is encrypted at rest and
        omitted from API responses.

        If provided as an expression, the expression itself is stored and
        returned by the API.
      type: string
      example: ${vault.env['MY_ENV_VAR']}
      minLength: 1
      x-expression:
        type: string
        fields:
          - vault
      x-sensitive: true
  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
  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.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    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.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
