> ## 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. # Firewall LAN CIDR > Retrieve Firewall LAN CIDR. ## OpenAPI ````yaml /openapi/10.0/aviatrix-api.json get /v2/api/get_firewall_lan_cidr 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/get_firewall_lan_cidr: get: tags: - firenet operationId: get_firewall_lan_cidr_get parameters: - description: Transit gateway name to enable dmz interface. in: query name: gateway_name required: true schema: type: string - description: . in: query name: mode required: false schema: enum: - default - gwlb type: string - description: Transit vpc to be configured. in: query name: vpc_id required: false schema: type: string - description: The region of the vpc to be configured. in: query name: region required: false schema: type: string - description: The account that should be used to configure the vpc. in: query name: account required: false schema: type: string - description: Firewall instance id. in: query name: firewall_id required: false schema: type: string - description: Firewall instance name. in: query name: firewall_name required: false schema: type: string - description: Firewall main side interface or subnet. in: query name: main required: false schema: type: string - description: Zone to launch Firewall. in: query name: zone required: false schema: type: string - description: Firewall main side interface or subnet for hagw. in: query name: main_ha required: false schema: type: string - description: GCE Firewall egress side vpc. in: query name: egress_vpc required: false schema: type: string - description: Firewall egress side interface or subnet. in: query name: egress required: false schema: type: string - description: GCE Firewall management side vpc. in: query name: management_vpc required: false schema: type: string - description: Firewall management side interface or subnet. in: query name: management required: false schema: type: string - description: Show detail info. in: query name: detail required: false schema: type: boolean - description: Return structured JSON in vendor_info for CoPilot UI. in: query name: json_format required: false schema: type: boolean - description: Support egress traffic through firewall. in: query name: firewall_egress required: false schema: $ref: '#/components/schemas/StringToggle' - description: Support east-west traffic inspection through firewall. in: query name: east_west required: false schema: $ref: '#/components/schemas/StringToggle' - description: Select Firewall hashing selection. in: query name: firewall_hashing required: false schema: enum: - 2-Tuple - 5-Tuple type: string - description: Enable close on all fail firewalls. in: query name: fail_close required: false schema: $ref: '#/components/schemas/StringToggle' - description: List private subnets. in: query name: private required: false schema: type: boolean - description: Enable firewall at the same time when insert firewall. in: query name: attach required: false schema: type: boolean - description: Skip associating firewall to gateway. in: query name: no_associate required: false schema: type: boolean - description: Spoke name that allow management access to. in: query name: management_access required: false schema: type: string - description: Excluded CIDR List from inspection. in: query name: exclude_cidr required: false schema: type: string - description: Enable Lan Interface Ping. in: query name: lan_ping required: false schema: $ref: '#/components/schemas/StringToggle' - description: Static Cidr for egress traffic. in: query name: egress_static_cidr required: false schema: type: string - description: Enable TGW domain segmentation for Egress FireNet. in: query name: tgw_segmentation required: false schema: $ref: '#/components/schemas/StringToggle' - description: Tag key:value pair comma separated list. in: query name: tag required: false schema: type: string - description: Json string of key:value tags. in: query name: json_tags required: false schema: type: string - description: Cloud type. in: query name: cloud_type required: false schema: type: integer - description: Extended Zone. in: query name: extended_zone required: false schema: type: string - description: Version count. in: query name: version_count required: false schema: type: integer - description: Firewall type. in: query name: firewall_vendor required: false schema: enum: - Aviatrix FQDN Gateway - Check Point Cloud Guard - Fortinet FortiGate - Generic - Palo Alto Networks Panorama - Palo Alto Networks VM-Series type: string - description: Firewall management interface IP. in: query name: public_ip required: false schema: type: string - description: Administrator user name. in: query name: user required: false schema: type: string - description: Administrator password. in: query name: password required: false schema: type: string - description: Administrator API token for Fortigate. in: query name: api_token required: false schema: type: string - description: Default route table. in: query name: route_table required: false schema: type: string - description: Sync local config with vendor config. in: query name: sync required: false schema: type: boolean - description: SSH private key file. in: query name: private_key_file required: false schema: type: string - description: List Firewall instances for Firewall Network. in: query name: firewall_instance required: false schema: type: boolean - description: Template name that the firewall belongs to. in: query name: template required: false schema: type: string - description: Template stack name that the firewall belongs to. in: query name: template_stack required: false schema: type: string - description: Config mode for firewall manager. in: query name: config_mode required: false schema: enum: - ADVANCE - DEFAULT type: string - description: >- Firewall template config with config_mode advance. dict {"firewall_id":{"template":"template_name", "template_stack":"stack_name","route_table":"route_table_name"}}. in: query name: firewall_template_config required: false schema: type: string - description: Custom firewall image id. in: query name: firewall_image_id required: false schema: type: string - description: Firewall VM image name. in: query name: firewall_image required: false schema: type: string - description: Firewall instance key pair name. in: query name: key_name required: false schema: type: string - description: AWS IAM role to be attached to the new instance. in: query name: iam required: false schema: type: string - description: AWS S3 bucket name for bootstrap. in: query name: bucket_name required: false schema: type: string - description: Firewall instance ID. in: query name: firewall_size required: false schema: type: string - description: Firewall image version. in: query name: firewall_image_version required: false schema: type: string - description: Check point sic key. in: query name: sic required: false schema: type: string - description: User data to boot strap firewall instance. in: query name: user_data required: false schema: type: string - description: Availability domain (OCI only). in: query name: availability_domain required: false schema: type: string - description: Fault domain (OCI only). in: query name: fault_domain required: false schema: type: string - description: Enable ipv6 on the Firewall. in: query name: enable_ipv6 required: false schema: type: boolean - description: AWS TGW name. in: query name: tgw_name required: false schema: type: string - description: AWS TGW domain name. in: query name: domain_name required: false schema: type: string - description: Azure resource group name. in: query name: arm_resource_group required: false schema: type: string - description: SSH Public Key. in: query name: ssh_public_key required: false schema: type: string - description: CheckPoint SIC Activation Key. in: query name: sic_key required: false schema: type: string - description: Azure Storage Account Name for bootstrap. in: query name: storage_name required: false schema: type: string - description: Azure Storage Access Key for PAN bootstrap. in: query name: storage_access_key required: false schema: type: string - description: Azure File share folder to store PAN bootstrap data. in: query name: file_share_folder required: false schema: type: string - description: Optional Azure common file share directory for PAN bootstrap. in: query name: share_directory required: false schema: type: string - description: Azure container folder name for FortiGate bootstrap. in: query name: container_folder required: false schema: type: string - description: Azure SAS URL to access FortiGate configURI bootstrap data. in: query name: sas_url_config required: false schema: type: string - description: Azure SAS URL to access FortiGate licenseURI bootstrap data. in: query name: sas_url_license required: false schema: type: string - description: Full path of the progress log file. in: query name: log_file 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:///v2/api/get_firewall_lan_cidr" \ -H "Authorization: cid " - lang: python label: Python source: |- import requests url = "https:///v2/api/get_firewall_lan_cidr" 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/get_firewall_lan_cidr", { 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/get_firewall_lan_cidr", 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.