Fortinet black logo

Integration API Guide

Get a Section of Information (Applications, Interfaces, Processors, Storage) about One Device

Get a Section of Information (Applications, Interfaces, Processors, Storage) about One Device

Release Added

5.1

Methodology REST API based: Caller makes an HTTP(S) request with an input XML (optional). An output XML is returned.
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/device?ip=<deviceIp>&loadDepend=true&fields=<sectionName>
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/device?ip=<deviceIp>&loadDepend=true&fields= <sectionName>&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 the specified section discovered for the device.

Options for <sectionName>: applications, interfaces, processors or storages

Refer to Example Usage to get CMDB device info.

Get a Section of Information (Applications, Interfaces, Processors, Storage) about One Device

Release Added

5.1

Methodology REST API based: Caller makes an HTTP(S) request with an input XML (optional). An output XML is returned.
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/device?ip=<deviceIp>&loadDepend=true&fields=<sectionName>
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/device?ip=<deviceIp>&loadDepend=true&fields= <sectionName>&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 the specified section discovered for the device.

Options for <sectionName>: applications, interfaces, processors or storages

Refer to Example Usage to get CMDB device info.