> ## 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 Edge gateway attributes

> Retrieve list Edge gateway attributes.



## OpenAPI

````yaml /openapi/10.0/aviatrix-api.json get /v2/api/list_edge_gateway_attributes
openapi: 3.1.0
info:
  title: Aviatrix Controller API
  version: '10.0'
  description: >-
    Aviatrix Controller API — version 10.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_edge_gateway_attributes:
    get:
      tags:
        - gateways
      operationId: list_edge_gateway_attributes_get
      parameters:
        - description: Updates the edge gateway Geocordinates-latitude.
          in: query
          name: geo_latitude
          required: false
          schema:
            type: string
        - description: Updates the edge gateway Geocordinates-longitude.
          in: query
          name: geo_longitude
          required: false
          schema:
            type: string
        - description: Name for the Aviatrix Edge gateway instance.
          in: query
          name: name
          required: true
          schema:
            type: string
        - description: Optional site id.
          in: query
          name: site_id
          required: false
          schema:
            type: string
        - description: IP cidr for controller to reach gateway.
          in: query
          name: mgmt_egress_ip
          required: false
          schema:
            type: string
        - description: >-
            Indicate that Gateway to controller traffic is over a private
            network.
          in: query
          name: mgmt_over_private_network
          required: false
          schema:
            type: boolean
        - description: Use DHCP for management interface.
          in: query
          name: dhcp
          required: false
          schema:
            type: boolean
        - description: Static IP for mgmt interface, in CIDR notation.
          in: query
          name: mgmt_ip
          required: false
          schema:
            type: string
        - description: Default gateway for mgmt interface.
          in: query
          name: mgmt_default_gateway
          required: false
          schema:
            type: string
        - description: User provided DNS server IP.
          in: query
          name: dns_server_ip
          required: false
          schema:
            type: string
        - description: User provided secondary DNS server IP.
          in: query
          name: dns_server_ip_secondary
          required: false
          schema:
            type: string
        - description: Use high performance encryption for this Aviatrix Edge gateway.
          in: query
          name: hpe
          required: false
          schema:
            type: boolean
        - description: WAN IP to connect to transit gateways.
          in: query
          name: wan_ip
          required: false
          schema:
            type: string
        - description: Default gateway for the WAN interface.
          in: query
          name: wan_default_gateway
          required: false
          schema:
            type: string
        - description: LAN IP to connect to on premises network.
          in: query
          name: lan_ip
          required: false
          schema:
            type: string
        - description: Default gateway for LAN network.
          in: query
          name: lan_default_gateway
          required: false
          schema:
            type: string
        - description: Keep ISO file on the controller.
          in: query
          name: do_not_delete_iso
          required: false
          schema:
            type: boolean
        - description: Supports cloud-init instead of ISO data.
          in: query
          name: cloud_init
          required: false
          schema:
            type: boolean
        - description: Supports edge gateways in active-standby mode.
          in: query
          name: enable_active_standby
          required: false
          schema:
            type: boolean
        - description: Disables edge gateways active-standby mode.
          in: query
          name: disable_active_standby
          required: false
          schema:
            type: boolean
        - description: Supports edge gateways in active-standby preemptive mode.
          in: query
          name: enable_active_standby_preemptive
          required: false
          schema:
            type: boolean
        - description: Edit wan discovery public ip.
          in: query
          name: wan_discovery_ip
          required: false
          schema:
            type: string
        - description: WAN discovery interface.
          in: query
          name: wan_interface
          required: false
          schema:
            type: string
        - description: WAN discovery on logical wan interface.
          in: query
          name: logical_wan_interface
          required: false
          schema:
            type: string
        - description: Disables edge gateways active-standby preemptive mode.
          in: query
          name: disable_active_standby_preemptive
          required: false
          schema:
            type: boolean
        - description: The host interface to be used as mgmt, by default it is eth2.
          in: query
          name: default_mgmt_interface
          required: false
          schema:
            type: string
        - description: Guest management interfaces.
          in: query
          name: guest_mgmt_interfaces
          required: false
          schema:
            type: string
        - description: Interface configuration.
          in: query
          name: interfaces
          required: false
          schema:
            type: string
        - description: VLAN configuration.
          in: query
          name: vlan
          required: false
          schema:
            type: string
        - description: Enable/Disable edge gateway auto adverise lan cidrs.
          in: query
          name: auto_advertise_lan_cidrs
          required: false
          schema:
            enum:
              - disable
              - enable
            type: string
        - description: Enable/Disable BGP on edge gateway.
          in: query
          name: is_bgp_configured
          required: false
          schema:
            type: boolean
        - description: Local BGP ASN.
          in: query
          name: bgp_local_as_num
          required: false
          schema:
            type: string
        - description: Edge platform type.
          in: query
          name: cloud_type
          required: false
          schema:
            type: integer
        - description: Native vlan-id.
          in: query
          name: native_vlan
          required: false
          schema:
            type: string
        - description: Creates Edge as a transit gateway.
          in: query
          name: is_transit
          required: false
          schema:
            type: boolean
        - description: Public IP mapping for the gateway wan interfaces.
          in: query
          name: eip_map
          required: false
          schema:
            type: string
        - description: Public IP mapping for the gateway wan logical interfaces.
          in: query
          name: logical_intf_eip_map
          required: false
          schema:
            type: string
        - description: Edge gateway size.
          in: query
          name: gw_size
          required: false
          schema:
            type: string
        - description: Phase 2 encryption policy for the gateway.
          in: query
          name: phase2_encryption
          required: false
          schema:
            type: string
        - description: Phase 2 PFS policy for the gateway.
          in: query
          name: phase2_dh
          required: false
          schema:
            type: string
        - description: Gateway group uuid for the gateway.
          in: query
          name: group_uuid
          required: false
          schema:
            type: string
        - $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://<controller>/v2/api/list_edge_gateway_attributes" \
              -H "Authorization: cid <CID>"
        - lang: python
          label: Python
          source: |-
            import requests

            url = "https://<controller>/v2/api/list_edge_gateway_attributes"
            headers = {"Authorization": "cid <CID>"}

            response = requests.get(url, headers=headers, verify=False)
            print(response.status_code)
            print(response.text)
        - lang: javascript
          label: JavaScript
          source: |-
            fetch("https://<controller>/v2/api/list_edge_gateway_attributes", {
              method: "GET",
              headers: {"Authorization": "cid <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://<controller>/v2/api/list_edge_gateway_attributes", nil)
              req.Header.Set("Authorization", "cid <CID>")

              client := &http.Client{}
              resp, err := client.Do(req)
              if err != nil {
                panic(err)
              }
              defer resp.Body.Close()

              fmt.Println(resp.Status)
            }
components:
  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.
  schemas:
    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

````