AccessAudit4

AccessRole4

AccessRoleBinding4

Add-Ons4

AI Gateway Agents4

AI Gateway Auth Strategies4

AI Gateway CA Certificates4

AI Gateway Certificates4

AI Gateway Config Stores8

AI Gateway Consumer Groups6

AI Gateway Consumers7

AI Gateway DataPlane Certificates3

AI Gateway Identity Providers4

AI Gateway MCP Servers4

AI Gateway Model Providers4

AI Gateway Models4

AI Gateway Policies4

AI Gateway SNIs4

AI Gateway Vaults4

AI Gateways4

API4

API Documentation4

API Implementation3

API Publication3

API Specification4

API Version4

Application Registrations4

Applications4

Assets4

Auth Server4

Auth Server Claims4

Auth Server Clients8

Auth Server Scopes4

Auth Server Trusted IdPs3

Dashboards4

Event Gateway Backend Clusters4

Event Gateway DataPlane Certificates4

Event Gateway Listener Policies8

Event Gateway Listeners4

Event Gateway Schema Registries4

Event Gateway Static Keys3

Event Gateway TLS Trust Bundles4

Event Gateway Vaults4

Event Gateway Virtual Cluster Consume Policies20

Event Gateway Virtual Cluster Policies4

Event Gateway Virtual Cluster Produce Policies16

Event Gateway Virtual Clusters4

Event Gateways4

HostnameGenerator4

Kong Identity Directories4

Mesh9

MeshAccessLog4

MeshCircuitBreaker4

MeshExternalService4

MeshFaultInjection4

MeshGateway4

MeshGlobalRateLimit4

MeshHealthCheck4

MeshHTTPRoute4

MeshIdentity4

MeshLoadBalancingStrategy4

MeshMetric4

MeshMultiZoneService4

MeshOPA4

MeshOpenTelemetryBackend4

MeshPassthrough4

MeshProxyPatch4

MeshRateLimit4

MeshRetry4

MeshService4

MeshTCPRoute4

MeshTimeout4

MeshTLS4

MeshTrace4

MeshTrafficPermission4

MeshTrust4

MeshZoneAddress4

Pages4

Personal Access Tokens2

Portal Audit Logs3

Portal Auth Settings9

Portal Custom Domains4

Portal Customization2

Portal Developers4

Portal Team Roles2

Portal Teams4

Portals5

Portals IP Allow List4

Secret4

Snippets4

Workload4

ZoneEgress4

ZoneIngress4

Event Gateway Backend Clusters

Update Backend Cluster

Updates an existing backend cluster.

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

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

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 6 of the 30 revisions of this API.11116

Aug 18, 2026658ffb748f9513See 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 request property
  request-property-discriminator-mapping-added
- ○
  added to the request property oneOf list
  request-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
Feb 16, 2026106b373707f354See the full diff
- ▲
  the ///// request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the ///// request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the ///// request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the ///// request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the / request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  the request property default value was added
  request-property-default-value-added
- ○
  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
Nov 6, 20255d2b35832e3f216See the full diff
- ▲
  removed from the request property oneOf list
  request-property-one-of-removed
- ▲
  added to the response property oneOf list for the response status
  response-property-one-of-added
- ●
  added the new type enum value to the /////// response property for the response status
  response-property-enum-value-added
- ○
  mapped value for discriminator key sasl_plain changed from to for request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key sasl_scram changed from to for request property
  request-property-discriminator-mapping-changed
- ○
  added to the request property oneOf list
  request-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
Oct 17, 2025564d63b800a11See the full diff
- ▲
  the request property became not nullable
  request-property-became-not-nullable
Oct 10, 20252724f73e1d4922See the full diff
- ▲
  added the new required request property /
  new-required-request-property
- ▲
  the request property became required
  request-property-became-required
- ○
  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
Oct 2, 2025ecce2daf9de61See the full diff
- ○
  endpoint added
  endpoint-added

Full history