> ## Documentation Index > Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt > Use this file to discover all available pages before exploring further. # List TGW names > Retrieve list TGW names. ## OpenAPI ````yaml /openapi/9.0/aviatrix-api.json get /v2/api/list_tgw_names openapi: 3.1.0 info: title: Aviatrix Controller API version: '9.0' description: >- Aviatrix Controller API — version 9.0. Selected operations with Mintlify metadata. servers: [] security: [] tags: - name: policies x-group: Policies - name: authentication x-group: Authentication - name: account-management x-group: Account Management - name: rbac x-group: RBAC & Permissions - name: gateways x-group: Gateways - name: transit x-group: Transit - name: nat x-group: NAT - name: app-domains x-group: SmartGroups - name: certificates x-group: Certificates - name: mitm x-group: MITM - name: monitoring x-group: Monitoring & Diagnostics - name: fqdn x-group: FQDN - name: logging x-group: Logging - name: vpn x-group: UserVPN - name: site-to-cloud x-group: Site-to-Cloud - name: controller x-group: Controller - name: bgp x-group: BGP - name: general x-group: General - name: firenet x-group: FireNet - name: networking x-group: Networking - name: tgw x-group: AWS TGW - name: ips x-group: IPS - name: saml x-group: SAML paths: /v2/api/list_tgw_names: get: tags: - tgw operationId: list_tgw_names_get parameters: - description: Account name. in: query name: acct_name required: false schema: type: string - description: Region. in: query name: region required: false schema: type: string - description: TGW name. in: query name: tgw_name required: false schema: type: string - description: Attachment account. in: query name: attachment_acct required: false schema: type: string - description: Attachment, e.g. VPC ID. in: query name: attachment_name required: false schema: type: string - description: A route domain name. in: query name: route_domain_name required: false schema: type: string - description: The AVX transit gw name. in: query name: avx_gw_name required: false schema: type: string - description: A list of subnets. in: query name: subnet_list required: false schema: type: string - description: Native_edge_vpn attachment. in: query name: edge_vpn required: false schema: type: boolean - description: Native_edge_dx attachment. in: query name: edge_dx required: false schema: type: boolean - description: Native_tgw_peering attachment. in: query name: tgw_peering required: false schema: type: boolean - description: Native_tgw_connect attachment. in: query name: tgw_connect required: false schema: type: boolean - description: Vpn, DX, TGW Connect or TGW peering connection name. in: query name: conn_name required: false schema: type: string - description: Public IP for CGW. in: query name: public_ip required: false schema: type: string - description: Direct Connect Gateway ID. in: query name: dx_gateway_id required: false schema: type: string - description: AWS side ASN number. in: query name: aws_side_asn required: false schema: type: string - description: Add attachment to firewall domain. in: query name: firewall_domain required: false schema: type: boolean - description: Cloud type. in: query name: cloud_type required: false schema: enum: - 1 - 256 type: integer - description: Allowed prefix CIDRs for DX. in: query name: allowed_prefix required: false schema: type: string - description: Static remote CIDR list. in: query name: remote_cidrs required: false schema: type: string - description: Customized routes. in: query name: customized_routes required: false schema: type: string - description: Inside IP CIDR for Tunnel 1. in: query name: inside_ip_cidr_tun_1 required: false schema: type: string - description: Pre-Shared Key for Tunnel 1. in: query name: pre_shared_key_tun_1 required: false schema: type: string - description: Inside IP CIDR for Tunnel 2. in: query name: inside_ip_cidr_tun_2 required: false schema: type: string - description: Pre-Shared Key for Tunnel 2. in: query name: pre_shared_key_tun_2 required: false schema: type: string - description: Route table list. in: query name: route_table_list required: false schema: type: string - description: Disable local route propagation to its own domain. in: query name: disable_local_propagation required: false schema: type: boolean - description: Customized routes advertise list. in: query name: customized_routes_advertise required: false schema: type: string - description: Full path of the progress log file. in: query name: log_file required: false schema: type: string - description: Peer AWS TGW name. in: query name: peer_tgw_name required: false schema: type: string - description: Peer TGW route domain name. in: query name: peer_route_domain_name required: false schema: type: string - description: Enable VPN Acceleration. in: query name: enable_acceleration required: false schema: type: boolean - description: Learned cidrs approval. in: query name: learned_cidrs_approval required: false schema: $ref: '#/components/schemas/StringToggle' - description: Enable/disable summarize RFC1918 routes in VPC route table. in: query name: summarize_rfc1918 required: false schema: $ref: '#/components/schemas/StringToggle' - description: Enable multicast on the transit gateway. in: query name: multicast_enable required: false schema: type: boolean - description: TGW Connect protocol. in: query name: protocol required: false schema: type: string - description: TGW CIDR list. in: query name: tgw_cidr_list required: false schema: type: string - description: Do not create default domains. in: query name: not_create_default_domains required: false schema: type: boolean - $ref: '#/components/parameters/action' - $ref: '#/components/parameters/CID' responses: '200': $ref: '#/components/responses/general_response_v2' default: $ref: '#/components/responses/general_response_v2' x-codeSamples: - lang: curl label: cURL source: |- curl -sk -X GET "https:///v2/api/list_tgw_names" \ -H "Authorization: cid " - lang: python label: Python source: |- import requests url = "https:///v2/api/list_tgw_names" headers = {"Authorization": "cid "} response = requests.get(url, headers=headers, verify=False) print(response.status_code) print(response.text) - lang: javascript label: JavaScript source: |- fetch("https:///v2/api/list_tgw_names", { method: "GET", headers: {"Authorization": "cid "} }) .then(res => res.text()) .then(console.log) .catch(console.error); - lang: go label: Go source: |- package main import ( "fmt" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https:///v2/api/list_tgw_names", nil) req.Header.Set("Authorization", "cid ") client := &http.Client{} resp, err := client.Do(req) if err != nil { panic(err) } defer resp.Body.Close() fmt.Println(resp.Status) } components: schemas: StringToggle: description: A boolean choice expressed as a string enum: - 'yes' - 'no' type: string action: description: The API action to perform. Required for 7.2 controllers only. type: string CID: description: The opaque session ID token. Required for 7.2 controllers only. type: string general_response_v2: additionalProperties: true description: A generic API response container for v2 style APIs. properties: errortype: description: Error type if the API failed. type: string reason: description: Failure reason if the API failed. type: string results: oneOf: - description: API response data type: boolean - description: API response data type: integer - description: API response data type: string - description: API response data type: object - description: API response data items: {} type: array return: description: Whether the API returned successfully type: boolean title: General Response v2 type: object parameters: action: description: The API action to perform. Required for 7.2 controllers only. in: query name: action schema: $ref: '#/components/schemas/action' CID: description: The opaque session ID token. Required for 7.2 controllers only. in: query name: CID schema: $ref: '#/components/schemas/CID' responses: general_response_v2: content: application/json: schema: $ref: '#/components/schemas/general_response_v2' description: General v2 API response schema. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.