Event Gateway Backend Clusters

Update Backend Cluster

Changed on

Updates an existing backend cluster.

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

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

Example request

{
  "authentication": {
    "password": "${vault.env['MY_ENV_VAR']}"
  },
  "tls": {
    "client_identity": {
      "key": "${vault.env['MY_ENV_VAR']}"
    }
  },
  "labels": {
    "env": "test"
  }
}

Response

Updated 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

  • 658ffb748f95Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added sasl_aws_iam discriminator mapping keys to the request property

    • info

      added to the request property oneOf list

    • info

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

  • 106b373707f3Revision changes
    • breaking

      the ///// request property's minLength was increased from 0 to 1

    • breaking

      the ///// request property's minLength was increased from 0 to 1

    • breaking

      the ///// request property's minLength was increased from 0 to 1

    • breaking

      the ///// request property's minLength was increased from 0 to 1

    • breaking

      the / request property's minLength was increased from 0 to 1

    • info

      added the new optional request property /

    • info

      the request property default value was added

    • info

      added the optional property / to the response with the status

    • info

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