Sign in
Event Gateway Backend Clusters

Get a Backend Cluster

Returns information about a specific backend cluster.

get/v1/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}

Response

A single backend cluster object.

idstring uuid required

The unique identifier of the backend cluster.

namestring required

The unique name of the backend cluster.

descriptionstring

A human-readable description of the backend cluster.

insecure_allow_anonymous_virtual_cluster_authboolean

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.

bootstrap_serversstring[] required

A list of cluster bootstrap servers in the format address:port.

metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

labelsLabels

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 "_".

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "authentication": {
    "password": "${vault.env['MY_ENV_VAR']}"
  },
  "tls": {
    "client_identity": {
      "key": "${vault.env['MY_ENV_VAR']}"
    }
  },
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 5 of the 30 revisions of this API.29

  • 658ffb748f9511See the full diff
    • ▲

      added to the response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added sasl_aws_iam discriminator mapping keys to the response property for the response status

      response-property-discriminator-mapping-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 106b373707f32See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      the response's property default value was added for the status

      response-property-default-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5d2b35832e3f13See the full diff
    • ▲

      added to the response property oneOf list for the response status

      response-property-one-of-added

    • ○

      mapped value for discriminator key sasl_plain changed from to for response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key sasl_scram changed from to for response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      removed from the response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2724f73e1d492See the full diff
    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      added the required property / to the response with the status

      response-required-property-added

  • ecce2daf9de61See the full diff
    • ○

      endpoint added

      endpoint-added