Skip to main content
Ctrl+K
FortiManager API HOW-TO
How to FortiManager API - Fri Jun 19 13:57:52 2026 - Home

Contents:

  • 1. FMG JSON API Introduction
  • 2. The option attribute
  • 3. Objects Management
  • 4. Security Profiles
  • 5. Docker Management
  • 6. SD-WAN Management
  • 7. Connector Management
  • 8. Device Management
  • 9. Policy Package Management
  • 10. Provisioning Template Management
  • 11. Operating the FortiManager’s own configuration
  • 12. Alternative FortiManager APIs
  • 13. CLI Script management
  • 14. ADOM management
  • 15. FortiGuard Management
  • 16. QoS management
  • 17. Proxying any APIs within FMG JSON API
  • 18. FortiManager operations
  • 19. Using dbcache
  • 20. VPN Management
  • 21. Sub fetch operations
  • 22. FortiManager Cloud
  • 23. Meta-fields Management
  • 24. CSF Management
  • 25. Contributors
  • .rst

  • 3. Objects Management
    • 3.1. Metadata
      • 3.1.1. How to add a metadata?
      • 3.1.2. How to delete a metadata?
      • 3.1.3. How to rename a metadata?
      • 3.1.4. How to assign a metadata to devices?
        • 3.1.4.1. For a single device
        • 3.1.4.2. For multiple devices
      • 3.1.5. How to assign metadatas at Model Device creation time?
      • 3.1.6. How to unassign a metadata?
      • 3.1.7. How to replace assigned device with another one?
      • 3.1.8. How to get the metadata mapped to a specific managed device?
      • 3.1.9. How to get the value of a metadata for a specific device/vdom?
      • 3.1.10. How to set multiple metadatas for one device?
      • 3.1.11. How to assign a global metadata?
      • 3.1.12. How to get the assignement status for global metadatas?
      • 3.1.13. How to Export/Import metadatas?
        • 3.1.13.1. Export
        • 3.1.13.2. Import
    • 3.2. Firewall Address
      • 3.2.1. How to add a IP Range firewall address?
      • 3.2.2. How to add a FQDN firewall address?
    • 3.3. Firewall Address Groups
      • 3.3.1. How to add a single member?
      • 3.3.2. How to delete a single member?
      • 3.3.3. How to delete all members?
        • 3.3.3.1. Using the unset method
        • 3.3.3.2. Using the unset attrs
      • 3.3.4. How to get firewall addrgrp members along with their details?
    • 3.4. Firewall VIP
      • 3.4.1. How to add a new Firewall VIP?
      • 3.4.2. How to add a new Firewall VIP Group?
    • 3.5. Wildcard FQDN
      • 3.5.1. How to add a wildcard FQDN?
    • 3.6. Objects Operations
      • 3.6.1. How to reference objects when names have special characters?
      • 3.6.2. Objects default values
        • 3.6.2.1. How to get the default values for a firewall address?
      • 3.6.3. How to bulk add objects?
        • 3.6.3.1. params multi-plexing
        • 3.6.3.2. data multi-plexing
      • 3.6.4. How to get CLI configuration of a new object?
    • 3.7. Normalized Interfaces
      • 3.7.1. How to create a normalized interface?
      • 3.7.2. How to add a new per-platform mapping to an existing Normalized Interface?
      • 3.7.3. How to get the normalized interfaces mapped to a specific managed device?
      • 3.7.4. How to delete an existing per-platform mapping?
    • 3.8. How to get the full ADOM database objects syntax?
    • 3.9. Internet Service Objects
      • 3.9.1. How to get the regions that can be used in a Geographic Based Internet Service object?
      • 3.9.2. How to get the countries that can be used in a Geographic Based Internet Service object?
      • 3.9.3. How to get the cities that can be used in a Geographic Based Internet Service object?
      • 3.9.4. How to get the list of Internet Service objects?
      • 3.9.5. How to get the entries of an Internet Service object?
      • 3.9.6. How to get the list of Internet Service FQDN objects?
    • 3.10. Operations on objects
      • 3.10.1. Cloning objects
        • 3.10.1.1. How to clone a firewall address?
      • 3.10.2. Filtering objects
        • 3.10.2.1. The contain operator
        • 3.10.2.2. How to filter firewall address according to their IPs?
          • 3.10.2.2.1. Retrieve all firewall address objects matching a specific IP subnet
          • 3.10.2.2.2. Retrieve all firewall address objects that strictly match an IP address or subnet
          • 3.10.2.2.3. Retrieve all firewall address subnets matching a specific IP address
          • 3.10.2.2.4. Retrieve all firewall address ranges containing a specific IP address
          • 3.10.2.2.5. Retrieve all firewall address subnets or ranges matching an IP address
          • 3.10.2.2.6. Retrieve all firewall addresses with a per-device mapping, where the subnet or range matches a specific IP address
          • 3.10.2.2.7. Retrieve all firewall address subnets or ranges matching a specific IP address including in their per-device mapping entries
        • 3.10.2.3. How to get the Last Modified timestamp?
        • 3.10.2.4. How to filter on the Last Modified timestamp?
        • 3.10.2.5. The like operator
        • 3.10.2.6. How to delete multiple objects?
      • 3.10.3. Used/Unused objects
        • 3.10.3.1. How to know whether a specific object is used?
        • 3.10.3.2. How to get the list of used objects?
        • 3.10.3.3. How to get unused objects?
      • 3.10.4. Where Used
        • 3.10.4.1. How to where used from the global adom?
        • 3.10.4.2. How to where used from within a normal ADOM?
        • 3.10.4.3. How to where used only for direct object usage?
      • 3.10.5. Find duplicates objects
      • 3.10.6. Merge objects
        • 3.10.6.1. How to merge firewall addresses?
      • 3.10.7. Find and Replace
        • 3.10.7.1. How to find and replace objects in firewall policy?
      • 3.10.8. Partial installation
        • 3.10.8.1. How to partial install an IPS profile?
          • 3.10.8.1.1. Using the Legacy Partial Install API
          • 3.10.8.1.2. Using the New Partial Install API
      • 3.10.9. How to check for a duplicate object name?
    • 3.11. Object Revision
      • 3.11.1. How to add an object with an object revision note?
      • 3.11.2. How to update an object with an object revision note?
      • 3.11.3. How to get the object revision notes for a specific object?
      • 3.11.4. How to delete an object revision?
      • 3.11.5. How to revert to a specific object revision?
    • 3.12. How to copy objects?
    • 3.13. Per-device mapping
      • 3.13.1. Per-device mapping for firewall.address
        • 3.13.1.1. How to get per-device mapping info for a firewall address obejct?
        • 3.13.1.2. How to add a per-device mapping to a firewall address object?
        • 3.13.1.3. How to delete a per-device mapping from a firewall address object?
    • 3.14. Replacement Message Group
      • 3.14.1. How to get the default Replacement Message Groups?

previous

2. The option attribute

next

3. Objects Management

By Jean-Pierre Forcioli

© Copyright 2025.