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

# FQDN cache global status

> Retrieve FQDN cache global status.



## OpenAPI

````yaml /openapi/9.0/aviatrix-api.json get /v2/api/get_fqdn_cache_global_status
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/get_fqdn_cache_global_status:
    get:
      tags:
        - fqdn
      operationId: get_fqdn_cache_global_status_get
      parameters:
        - description: Add gateway_to_tag or filter pass through.
          in: query
          name: add
          required: false
          schema:
            enum:
              - pass_through
              - tag_gw
            type: string
        - description: Delete tag or gateway_from_tag.
          in: query
          name: delete
          required: false
          schema:
            enum:
              - tag
              - tag_gw
            type: string
        - description: Update tag params.
          in: query
          name: update
          required: false
          schema:
            enum:
              - cache_rule
              - exact_match
              - exception_rule
              - mode
              - policies
              - private_sub_filter
              - tag_state
            type: string
        - description: User config filepath.
          in: query
          name: import_path
          required: false
          schema:
            type: string
        - description: Export existing tag config.
          in: query
          name: export
          required: false
          schema:
            enum:
              - tag
            type: string
        - description: Compressing the export string.
          in: query
          name: compress
          required: false
          schema:
            type: boolean
        - description: Tag name.
          in: query
          name: tag
          required: false
          schema:
            type: string
        - description: Attach/detach user.
          in: query
          name: attach
          required: false
          schema:
            $ref: '#/components/schemas/StringToggle'
        - description: Gateway name.
          in: query
          name: gw
          required: false
          schema:
            type: string
        - description: White/Black mode.
          in: query
          name: mode
          required: false
          schema:
            enum:
              - black
              - white
            type: string
        - description: 'Policy list of dictionaries: [{fqdn:, proto:, port:}].'
          in: query
          name: policies
          required: false
          schema:
            type: string
        - description: Source ip/cidr for filtering.
          in: query
          name: source_ips
          required: false
          schema:
            type: string
        - description: Tag_state:enabled/disabled.
          in: query
          name: state
          required: false
          schema:
            enum:
              - disabled
              - enabled
            type: string
        - description: Exception_rule:enabled/disabled.
          in: query
          name: exception_rule
          required: false
          schema:
            enum:
              - disabled
              - enabled
            type: string
        - description: Cache_rule:enabled/disabled.
          in: query
          name: cache_rule
          required: false
          schema:
            enum:
              - disabled
              - enabled
            type: string
        - description: Exact_match:enabled/disabled.
          in: query
          name: exact_match
          required: false
          schema:
            enum:
              - disabled
              - enabled
            type: string
        - description: Include private subnet into the FQDN filter.
          in: query
          name: private_sub_filter
          required: false
          schema:
            type: boolean
        - description: Discovery mode started.
          in: query
          name: is_discovery
          required: false
          schema:
            type: boolean
        - description: Update policy directly after import.
          in: query
          name: update_now
          required: false
          schema:
            type: boolean
        - description: Add/Delete rules instead of replace.
          in: query
          name: modify_policy
          required: false
          schema:
            enum:
              - add_rules
              - delete_rules
            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/get_fqdn_cache_global_status" \
              -H "Authorization: cid <CID>"
        - lang: python
          label: Python
          source: |-
            import requests

            url = "https://<controller>/v2/api/get_fqdn_cache_global_status"
            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/get_fqdn_cache_global_status", {
              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/get_fqdn_cache_global_status", 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:
    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.

````