Fortinet black logo

Integration API Guide

Get Short Description of All Devices

Get Short Description of All Devices

Release Added

5.1

Methodology REST API based: Caller makes an HTTP(S) request with an input XML. An output XML is returned.
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices&organization=ACME
Input Credentials
  • Enterprise deployments: User name and password of any FortiSIEM account that has the appropriate access. Use "super" as the organization for Enterprise deployments.
    Curl example: curl -k -u super/admin:Admin*123
  • Service Provider deployments: User name and password of Super Global account or Organization specific account and name. Make sure that the account has the appropriate access.
    Curl example with super organization: curl -k -u super/admin:Admin*123
    If querying for a specific organization, replace "super" with the organization name.
Output An XML that contains a short set of attributes for each device, including:
    • Host Name
    • Access IP
    • Creation Method
    • Description
    • Vendor, Model, version
    • Contact info
    • Location
    • Uptime
    • Hardware Model
    • Serial Number
    • Business Service Groups to which the device belongs

Get Short Description of All Devices

Release Added

5.1

Methodology REST API based: Caller makes an HTTP(S) request with an input XML. An output XML is returned.
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices&organization=ACME
Input Credentials
  • Enterprise deployments: User name and password of any FortiSIEM account that has the appropriate access. Use "super" as the organization for Enterprise deployments.
    Curl example: curl -k -u super/admin:Admin*123
  • Service Provider deployments: User name and password of Super Global account or Organization specific account and name. Make sure that the account has the appropriate access.
    Curl example with super organization: curl -k -u super/admin:Admin*123
    If querying for a specific organization, replace "super" with the organization name.
Output An XML that contains a short set of attributes for each device, including:
    • Host Name
    • Access IP
    • Creation Method
    • Description
    • Vendor, Model, version
    • Contact info
    • Location
    • Uptime
    • Hardware Model
    • Serial Number
    • Business Service Groups to which the device belongs