Event Gateway Backend Clusters

List Backend Clusters

Changed on

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

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

Request

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

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[after]string
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

Filter documents returned in the response.

Response

A paginated list response for a collection of backend clusters.

Example response

{
  "meta": {
    "page": {
      "size": 10
    }
  },
  "data": [
    {
      "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

  • 68d43091b84dRevision changes
    • warning

      added the new 403.00 enum value to the response property for the response status

  • f324fb7610e4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status