Transit Gateways

Get Transit Gateway

Retrieves a transit gateway by ID, including its current state and attachment configuration.

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

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.

transitGatewayIdstring uuid required
Example:0850820b-d153-4a2a-b9be-7d2204779139

The ID of the transit gateway to operate on.

Response

Response format for retrieving a transit gateway.

OR
OR
OR
OR
OR

Example response

{
  "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

Changed in 10 of the 52 revisions of this API.28835

    • added the required property / to the response with the status

      response-required-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 to the response body oneOf list for the response status

      response-body-one-of-added

    • added the new error enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new error enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new error enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new error enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new error enum value to the / response property for the response status

      response-property-enum-value-added

    • added to the response body oneOf list for the response status

      response-body-one-of-added

  • 96118a9cd7f4113See the full diff
    • added to the response body oneOf list for the response status

      response-body-one-of-added

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property // became nullable for the status

      response-property-became-nullable

    • the response property // became nullable for the status

      response-property-became-nullable

    • the response property // became nullable for the status

      response-property-became-nullable

    • the response property // became nullable for the status

      response-property-became-nullable

    • the response property // became nullable for the status

      response-property-became-nullable

    • the response property // became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • added the new pending-user-action enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new pending-user-action enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new pending-user-action enum value to the / response property for the response status

      response-property-enum-value-added

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

    • 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

  • fc6abbc537f3329See the full diff
    • the /// response's property type changed from no type to object for status

      response-property-type-changed

    • the /// response's property type changed from no type to object for status

      response-property-type-changed

    • the /// response's property type changed from no type to object for status

      response-property-type-changed

    • removed subschema #2 from the /// response property allOf list for the response status

      response-property-all-of-removed

    • removed subschema #2 from the /// response property allOf list for the response status

      response-property-all-of-removed

    • removed from the /// response property allOf list for the response status

      response-property-all-of-removed

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

    • added the required property //// to the response with the status

      response-required-property-added

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

    • added to the response body oneOf list for the response status

      response-body-one-of-added

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

    • added to the response body oneOf list for the response status

      response-body-one-of-added

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

      response-body-type-changed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

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