Fortinet black logo

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Integration API Guide

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. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
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. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
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.