---
title: "TransitGatewayResponse"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/schemas/TransitGatewayResponse"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b.md

# TransitGatewayResponse

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
components:
  schemas:
    AwsTransitGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        cidr_blocks:
          $ref: "#/components/schemas/TransitGatewayCIDRBlocks"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AwsTransitGatewayAttachmentConfigForResponse"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - cidr_blocks
        - transit_gateway_attachment_config
        - dns_config
        - id
        - state
        - entity_version
        - created_at
        - updated_at
      title: AWS Transit Gateway
    AwsVpcPeeringGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        cidr_blocks:
          $ref: "#/components/schemas/TransitGatewayCIDRBlocks"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AwsVpcPeeringGatewayAttachmentConfigForResponse"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - cidr_blocks
        - transit_gateway_attachment_config
        - dns_config
        - id
        - state
        - entity_version
        - created_at
        - updated_at
      title: AWS VPC Peering Gateway
    AzureTransitGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AzureVNETPeeringAttachmentConfig"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - transit_gateway_attachment_config
        - id
        - dns_config
        - state
        - entity_version
        - created_at
        - updated_at
      title: Azure Transit Gateway
    AzureVHubPeeringGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AzureVHubPeeringAttachmentConfig"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - transit_gateway_attachment_config
        - id
        - dns_config
        - state
        - entity_version
        - created_at
        - updated_at
      title: Azure Virtual Hub Peering Gateway
    GCPVPCPeeringGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/GCPVPCPeeringAttachmentConfig"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - transit_gateway_attachment_config
        - id
        - dns_config
        - state
        - entity_version
        - created_at
        - updated_at
      title: GCP VPC Peering Transit Gateway
    AwsResourceEndpointGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AwsResourceEndpointAttachmentConfigResponse"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - transit_gateway_attachment_config
        - id
        - dns_config
        - state
        - entity_version
        - created_at
        - updated_at
      title: AWS Resource Endpoint Gateway
    TransitGatewayName:
      description: Human-readable name of the transit gateway.
      type: string
      example: us-east-2 transit gateway
      title: Transit Gateway Name
    TransitGatewayDnsConfig:
      description: >
        List of mappings from remote DNS server IP address sets to proxied
        internal domains, for a transit gateway

        attachment.
      type: array
      items:
        type: object
        additionalProperties: false
        properties:
          remote_dns_server_ip_addresses:
            description: Remote DNS Server IP Addresses to connect to for resolving internal
              DNS via a transit gateway.
            type: array
            items:
              type: string
            example:
              - 10.0.0.2
            title: Remote DNS Server IP Addresses
          domain_proxy_list:
            description: >
              Internal domain names to proxy for DNS resolution from the listed
              remote DNS server IP addresses,

              for a transit gateway.
            type: array
            items:
              type: string
            example:
              - foobar.com
            title: Domain Proxy List
        required:
          - remote_dns_server_ip_addresses
          - domain_proxy_list
      title: Transit Gateway DNS Config
    TransitGatewayCIDRBlocks:
      description: >
        CIDR blocks for constructing a route table for the transit gateway, when
        attaching to the owning

        network.
      type: array
      items:
        type: string
      example:
        - 10.0.0.0/8
        - 100.64.0.0/10
        - 172.16.0.0/12
      title: Transit Gateway CIDR Blocks
    AwsTransitGatewayAttachmentConfigForResponse:
      type: object
      properties:
        kind:
          enum:
            - aws-transit-gateway-attachment
          title: AWS Transit Gateway Attachment Type
        transit_gateway_id:
          description: AWS Transit Gateway ID to create attachment to.
          type: string
          title: Transit Gateway ID
        ram_share_arn:
          description: Resource Share ARN to verify request to create transit gateway
            attachment.
          type: string
          title: RAM Share ARN
        attachment_id:
          description: ID of the AWS Transit Gateway attachment.
          type: string
          title: AWS Transit Gateway Attachment ID
      additionalProperties: false
      required:
        - kind
        - transit_gateway_id
        - ram_share_arn
      title: AWS Transit Gateway Attachment Config
    TransitGatewayId:
      type: string
      format: uuid
      example: 0850820b-d153-4a2a-b9be-7d2204779139
      readOnly: true
    TransitGatewayState:
      description: >
        The current state of the Transit Gateway. Possible values:

        - `created` - The attachment has been created but is not attached to
        transit gateway.

        - `initializing` - The attachment is in the process of being initialized
        and is setting up necessary resources.

        - `pending-acceptance` The attachment request is awaiting acceptance in
        customer VPC.

        - `pending-user-action` The attachment request is awaiting user action
        in customer VPC.

        - `ready` - The transit gateway attachment is fully operational and can
        route traffic as configured.

        - `terminating` - The attachment is in the process of being deleted and
        is no longer accepting new traffic.

        - `terminated` - The attachment has been fully deleted and is no longer
        available.

        - `error` - The attachment is in an error state.
      type: string
      enum:
        - created
        - initializing
        - pending-acceptance
        - pending-user-action
        - ready
        - terminating
        - terminated
        - error
      readOnly: true
      title: Transit Gateway State
    AwsVpcPeeringGatewayAttachmentConfigForResponse:
      type: object
      properties:
        kind:
          enum:
            - aws-vpc-peering-attachment
          title: AWS VPC Peering Attachment Config
        peer_account_id:
          type: string
        peer_vpc_id:
          type: string
        peer_vpc_region:
          type: string
        peering_connection_id:
          type: string
      additionalProperties: false
      required:
        - kind
        - peer_account_id
        - peer_vpc_id
        - peer_vpc_region
      title: AWS VPC Peering Attachment Config
    AzureVNETPeeringAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - azure-vnet-peering-attachment
          title: Azure VNET Peering Attachment Type
        tenant_id:
          description: Tenant ID for the Azure VNET Peering attachment.
          type: string
          title: Tenant ID
        subscription_id:
          description: Subscription ID for the Azure VNET Peering attachment.
          type: string
          title: Subscription ID
        resource_group_name:
          description: Resource Group Name for the Azure VNET Peering attachment.
          type: string
          title: Resource Group Name
        vnet_name:
          description: VNET Name for the Azure VNET Peering attachment.
          type: string
          title: VNET Name
      additionalProperties: false
      required:
        - kind
        - tenant_id
        - subscription_id
        - resource_group_name
        - vnet_name
      title: Azure VNET Peering Attachment Config
    AzureVHubPeeringAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - azure-vhub-peering-attachment
          title: Azure Virtual Hub Peering Attachment Type
        tenant_id:
          description: Tenant ID of the Azure Virtual Hub resource.
          type: string
          title: Tenant ID
        subscription_id:
          description: Subscription ID of the Azure Virtual Hub resource.
          type: string
          title: Subscription ID
        resource_group_name:
          description: Resource Group Name of the Azure Virtual Hub resource.
          type: string
          title: Resource Group Name
        vhub_name:
          description: Name of the Azure Virtual Hub resource.
          type: string
          title: Virtual Hub Name
      additionalProperties: false
      required:
        - kind
        - tenant_id
        - subscription_id
        - resource_group_name
        - vhub_name
      title: Azure Virtual Hub Peering Attachment Config
    GCPVPCPeeringAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - gcp-vpc-peering-attachment
          title: GCP VPC Peering Attachment Type
        peer_project_id:
          description: GCP Project ID of the peer account to create attachment to.
          type: string
          title: GCP Project ID
        peer_vpc_name:
          description: GCP VPC Name of the peer account to create attachment to.
          type: string
          title: GCP VPC Name
      additionalProperties: false
      required:
        - kind
        - peer_project_id
        - peer_vpc_name
      title: GCP VPC Peering Attachment Config
    AwsResourceEndpointAttachmentConfigResponse:
      type: object
      properties:
        kind:
          enum:
            - aws-resource-endpoint-attachment
          title: AWS Resource Endpoint Attachment Type
        ram_share_arn:
          description: Resource Share ARN to verify request to create transit gateway
            attachment.
          type: string
          title: RAM Share ARN
        resource_config:
          $ref: "#/components/schemas/AwsResourceEndpointConfigResponse"
      additionalProperties: false
      required:
        - kind
        - ram_share_arn
        - resource_config
      title: AWS Resource Endpoint Attachment Config Response
    AwsResourceEndpointConfigResponse:
      description: |
        List of unique resource config mapping for aws resource endpoint.
      type: array
      items:
        type: object
        additionalProperties: false
        properties:
          resource_config_id:
            description: Resource Config ID to uniquely identify a resource configuration.
            type: string
            title: Resource Config ID
          domain_name:
            description: Domain Name to uniquely identify a resource configuration.
            type: string
            title: Domain Name
          state:
            $ref: "#/components/schemas/AwsResourceEndpointConfigState"
        required:
          - resource_config_id
          - domain_name
          - state
      title: AWS Resource Endpoint Config Response
    AwsResourceEndpointConfigState:
      description: >
        The current state of the resource config in AWS Resource Endpoint.
        Possible values:

        - `initializing` - The config is in the process of being initialized and
        is setting up necessary resources.

        - `missing` - The config is missing and is no longer accepting new
        traffic.

        - `ready` - The config is fully operational and can route traffic as
        configured.

        - `error` - The config is in an error state, and is not operational.

        - `terminating` - The config is in the process of being deleted and is
        no longer accepting new traffic.
      type: string
      enum:
        - initializing
        - missing
        - ready
        - error
        - terminating
      readOnly: true
      title: AWS Resource Endpoint Config State
    TransitGatewayResponse:
      oneOf:
        - $ref: "#/components/schemas/AwsTransitGatewayResponse"
        - $ref: "#/components/schemas/AwsVpcPeeringGatewayResponse"
        - $ref: "#/components/schemas/AzureTransitGatewayResponse"
        - $ref: "#/components/schemas/AzureVHubPeeringGatewayResponse"
        - $ref: "#/components/schemas/GCPVPCPeeringGatewayResponse"
        - $ref: "#/components/schemas/AwsResourceEndpointGatewayResponse"
```
