Sign in
Event Gateway Virtual Clusters

List all virtual clusters

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

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

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 virtual clusters.

Example response

{
  "meta": {
    "page": {
      "size": 10
    }
  },
  "data": [
    {
      "authentication": [
        {
          "principals": [
            {
              "password": "${vault.env['MY_ENV_VAR']}"
            }
          ]
        }
      ],
      "dns_label": "vcluster-1",
      "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 75 revisions of this API.119

  • 164458859caa4See the full diff
    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added

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

  • bb5e056b7c6d11See the full diff
    • ●

      removed the optional property //// from the response with the status

      response-optional-property-removed

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

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

  • 9296070059c51See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 377981ac9f1411See the full diff
    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added client_certificate discriminator mapping keys to the /// response property for the response status

      response-property-discriminator-mapping-added

  • 7bc7400170e01See the full diff
    • ○

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

      response-property-default-value-added

  • 581456e3279f1See the full diff
    • ○

      endpoint added

      endpoint-added

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