Transit Gateways

List Transit Gateways

Changed on

Returns a paginated collection of transit gateways attached to a given network.

get/v2/cloud-gateways/networks/{networkId}/transit-gateways

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/cloud-gateways/networks/{networkId}/transit-gateways
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

networkIdstring uuid required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Query parameters

Filters supported for transit gateways.

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[number]integer
Example:1

Determines which page of the entities to retrieve.

Response

A paginated list for a collection of transit gateways for a network.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "name": "us-east-2 transit gateway",
      "dns_config": [
        {
          "remote_dns_server_ip_addresses": [
            "10.0.0.2"
          ],
          "domain_proxy_list": [
            "foobar.com"
          ]
        }
      ],
      "cidr_blocks": [
        "10.0.0.0/8",
        "100.64.0.0/10",
        "172.16.0.0/12"
      ],
      "id": "0850820b-d153-4a2a-b9be-7d2204779139",
      "state_metadata": {
        "reported_status": "ERROR",
        "reason": "Transit Gateway Attachment configuration could not find a resource with the provided ram share arn.\n"
      },
      "entity_version": 1,
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ]
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

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

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

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

    • warning

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

    • warning

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