> ## 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.

# Disable gateway FireNet interfaces

> POST /v2/api/disable_gateway_firenet_interfaces



## OpenAPI

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


            url =
            "https://<controller>/v2/api/disable_gateway_firenet_interfaces"

            headers = {"Authorization": "cid <CID>"}


            response = requests.post(url, headers=headers, verify=False)

            print(response.status_code)

            print(response.text)
        - lang: javascript
          label: JavaScript
          source: >-
            fetch("https://<controller>/v2/api/disable_gateway_firenet_interfaces",
            {
              method: "POST",
              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("POST", "https://<controller>/v2/api/disable_gateway_firenet_interfaces", 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:
  schemas:
    CID:
      description: The opaque session ID token. Required for 7.2 controllers only.
      type: string
    action:
      description: The API action to perform. Required for 7.2 controllers only.
      type: string
    StringToggle:
      description: A boolean choice expressed as a string
      enum:
        - 'yes'
        - 'no'
      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
  responses:
    general_response_v2:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_response_v2'
      description: General v2 API response schema.

````