Skip to main content
Ctrl+K
FortiManager API HOW-TO
How to FortiManager API - Fri Jun 5 18:55:45 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

  • 8. Device Management
    • 8.1. How to get a managed device OID?
    • 8.2. How to rename a managed device?
      • 8.2.1. Using /dvmdb/device/<device>
      • 8.2.2. Using /dvmdb/adom/<adom>/device/<device>
    • 8.3. Device status
      • 8.3.1. Policy Package Status for Managed devices
    • 8.4. How to refresh a device?
      • 8.4.1. Refresh one device
      • 8.4.2. Refresh multiple devices
    • 8.5. Device timezone
      • 8.5.1. How to get the list of available timezones?
    • 8.6. Device coordinates
    • 8.7. How to get the full device database syntax?
    • 8.8. How to get the list of devices?
      • 8.8.1. How to get all managed devices?
      • 8.8.2. How to get managed devices for a specific ADOM?
      • 8.8.3. How to get list of managed devices for all ADOMs?
      • 8.8.4. How to get unauthorized devices?
    • 8.9. Real Device
      • 8.9.1. How to add a real device?
      • 8.9.2. How to add a real device in a Fabric of FortiManager?
    • 8.10. How to change the serial number of a managed device?
    • 8.11. How to promote/authorize a real device?
    • 8.12. Model Device
      • 8.12.1. How to obtain the list of supported Model Device?
      • 8.12.2. How to create a Model Device?
        • 8.12.2.1. Stop using the flags attribute
        • 8.12.2.2. For a virtual appliance
        • 8.12.2.3. For a hardware appliance
      • 8.12.3. How to create a Model Device and add in in a group with a single request?
      • 8.12.4. How to add a Model Device assigned to a Policy Package?
      • 8.12.5. How to add a Model Device with firmware enforcement enabled?
      • 8.12.6. How to add a Model Device with the backup_mode flag enabled?
      • 8.12.7. How to add a SD-WAN Model Device?
      • 8.12.8. How to add a list of Model Device?
      • 8.12.9. Auto-link management
        • 8.12.9.1. How to enable the auto-link flag on a Model Device?
        • 8.12.9.2. How to disable the auto-link flag on a Model Device?
        • 8.12.9.3. Multiplexing example
        • 8.12.9.4. How to get the list of Model Devices which are ready for auto-link?
        • 8.12.9.5. How to get the list of Model Devices which are not ready for auto-link?
      • 8.12.10. How to enable VDOM on a Model Device?
      • 8.12.11. How to enable the need_reset flag on a model device?
      • 8.12.12. How to add a model device linked to a pre-Run CLI Template?
      • 8.12.13. How to get the list of Model Devices?
    • 8.13. How to get the ADOM a device belongs to?
      • 8.13.1. How to get the ADOM a device belongs to using object master with filter?
      • 8.13.2. How to get the ADOM a device belongs to using the extra info option?
      • 8.13.3. How to get the ADOM a device belongs to using _is_master attribute?
    • 8.14. How to trigger an Install Device Settings?
    • 8.15. How to trigger a Quick Install?
    • 8.16. Device Groups
      • 8.16.1. How to install device settings against a device group?
      • 8.16.2. How to create a device group?
      • 8.16.3. How to add a device in a device group?
      • 8.16.4. How to add multiple devices in a device group?
      • 8.16.5. How to add a device group into a device group?
      • 8.16.6. How to get the device group members?
      • 8.16.7. How to get all device groups a device belongs to?
      • 8.16.8. How to delete a device from a device group?
      • 8.16.9. How to delete multiple devices from a device group?
      • 8.16.10. How to delete a device group?
    • 8.17. How to delete a device?
    • 8.18. How to get device meta fields?
    • 8.19. Devce Meta Fields
      • 8.19.1. How to get specific device meta fields?
      • 8.19.2. How to set device’s meta fields?
    • 8.20. VDOM operations
      • 8.20.1. How to enable VDOM?
      • 8.20.2. How to add a NAT VDOM?
        • 8.20.2.1. Using /dvmdb/device endpoint
        • 8.20.2.2. Using /dvmdb/adom endpoint
      • 8.20.3. How to add a TP VDOM?
      • 8.20.4. How to assign a VDOM to an ADOM?
      • 8.20.5. How to assign an interface to a VDOM?
      • 8.20.6. How to get the interfaces assigned to a VDOM?
      • 8.20.7. How to create a VDOM link?
        • 8.20.7.1. Create the VDOM link object
        • 8.20.7.2. Set the first auto-generated system interface
        • 8.20.7.3. Set the second auto-generated system interface
      • 8.20.8. How to delete a VDOM?
      • 8.20.9. How to get the Device VDOM meta fields for all VDOMs of a device?
      • 8.20.10. How to get the Device VDOM meta fields for a single VDOM?
      • 8.20.11. How to set the Device VDOM metafields for multiple VDOMs of a same device?
      • 8.20.12. How to set the Device VDOM metafields for a single VDOM?
      • 8.20.13. How to get devices matching a specific VDOM name?
      • 8.20.14. How to create same VLAN in different devices/VDOMs?
    • 8.21. How to get default config for a particular type of device?
    • 8.22. Device revisions
      • 8.22.1. How to get the list of device revisions for a particular device?
      • 8.22.2. How to get a specific device revision for a particular device?
      • 8.22.3. How to get the current device database configuration for a particular device?
      • 8.22.4. How to revert to a specific device revision?
      • 8.22.5. How to import a device revision?
    • 8.23. How to trigger a retrieve operation?
      • 8.23.1. Against a single device
      • 8.23.2. Against multiple devices
    • 8.24. Firmware upgrade
      • 8.24.1. How to get the upgrade path?
      • 8.24.2. How to get list of available firmware for a specific platform?
      • 8.24.3. How to get list of firmwares available on FortiManager drive?
      • 8.24.4. How to get list of firmwares available on FortiManager drive for a specific product?
      • 8.24.5. How to upgrade a device?
      • 8.24.6. How to get the upgrade history?
      • 8.24.7. How to get the Upgrade Report for managed devices?
    • 8.25. Certificates
      • 8.25.1. How to upload a certificate?
      • 8.25.2. How to update an existing certificate?
      • 8.25.3. How to show certificate details?
    • 8.26. Device Monitoring
      • 8.26.1. Generate an IP Pool Mapping
      • 8.26.2. How to get kernel routes from a managed fortigate device?
      • 8.26.3. How to get IPSEC tunnel statistics?
    • 8.27. How to get an Install Preview for a single device?
      • 8.27.1. Step #1: Trigger an install review operation
      • 8.27.2. Step #2: Collect the install preview output
    • 8.28. How to get an Install Preview for multiple devices?
      • 8.28.1. Step #1: Trigger an install preview for multiple devices
      • 8.28.2. Step #2: Collect the install device preview output
    • 8.29. How to get the platform_id, the platform_name and the ostype from a Serial Number?
    • 8.30. How to get all supported devices?
    • 8.31. Cluster
      • 8.31.1. Model HA Cluster
        • 8.31.1.1. How to create a Model HA Cluster?
        • 8.31.1.2. How to create a Model HA Cluster with new interfaces?
        • 8.31.1.3. How to add a Model HA Cluster with session-pickup up and override enabled?
        • 8.31.1.4. How to add a Model HA Cluster with Device Blueprint and Metadata?
      • 8.31.2. How to get the cluster members?
      • 8.31.3. How to fail-over a cluster?
      • 8.31.4. How to update/replace the serial numbers of a cluster?
        • 8.31.4.1. Update/Replace the serial number of the primary member
        • 8.31.4.2. Update/Replace the serial number of the secondary member
        • 8.31.4.3. Update/Replace the serial number of the members in a Model HA Cluster
      • 8.31.5. How to get cluster members status?
    • 8.32. Private Data Encryption
      • 8.32.1. How to get the private data encryption status of one device?
      • 8.32.2. How to verify a private data encryption key?
    • 8.33. FortiGate-VM
      • 8.33.1. How to upload a FortiGate-VM license?
    • 8.34. Single Pane of Glass
      • 8.34.1. How to sync a FortiManager ADOM?
        • 8.34.1.1. When a device is added
        • 8.34.1.2. When a device is deleted
    • 8.35. How to operate a Where Used?
    • 8.36. Device Blueprint
      • 8.36.1. How to get the list of Device Blueprints?
      • 8.36.2. How to add a Device Blueprint?
      • 8.36.3. How to add multiple Device Blueprint?
      • 8.36.4. How to delete a Device Blueprint?
      • 8.36.5. How to delete multiple Device Blueprint?
      • 8.36.6. How to get the list of metadata used by a Device Blueprint?
    • 8.37. VPN Monitor
    • 8.38. How to manage network setting?
      • 8.38.1. VLANs
        • 8.38.1.1. How to add a single VLAN?
        • 8.38.1.2. How to add multiple VLANs?
      • 8.38.2. Zones
        • 8.38.2.1. How to add members to an existing System Zone?
        • 8.38.2.2. How to delete members to an existing System Zone?
      • 8.38.3. Dynamic Routing
        • 8.38.3.1. How to add router ospf network entries?
        • 8.38.3.2. How to delete a router ospf network entry?
    • 8.39. Create FortiOS API users
    • 8.40. FortiGate with internal modems
      • 8.40.1. How to get LTE modem status?
    • 8.41. How to RMA a managed device?
      • 8.41.1. How to set the RMA status on a managed device?
      • 8.41.2. How to get the RMA status of a managed device?
      • 8.41.3. How to delete the RMA status on a managed device?
    • 8.42. SASE Controller
    • 8.43. How to get Fortinet vulnerabilities for your managed devices?
    • 8.44. Per-device mapping for a specific managed device
    • 8.45. How to run CLI commands against a managed device?
    • 8.46. Onboarding Rules
      • 8.46.1. How to create a new onboarding rule?
      • 8.46.2. How to get onboarding rules?
      • 8.46.3. How to delete an onboarding rule?

previous

7. Connector Management

next

8. Device Management

By Jean-Pierre Forcioli

© Copyright 2025.