Fortinet black logo

Integration API Guide

Discover Devices

Discover Devices

This API enables you to discover devices in Enterprise and Service Provider deployments.

Release Added

5.1

Methodology REST API based: Caller makes an HTTP(S) request with an input XML containing the devices to be discovered. An output XML containing the task Id is returned. The task Id can then be used to get the status of the discovery results.
Request URL
  • Send Discovery request:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/deviceMon/discover
  • Get Discovery result:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/deviceMon/status?taskId=XXX
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
  • Discovery request: XML containing task Id.
  • Discovery result: XML containing discovered devices and attributes.

Refer to Example Usage for discovering devices.

Discover Devices

Discover Devices

This API enables you to discover devices in Enterprise and Service Provider deployments.

Release Added

5.1

Methodology REST API based: Caller makes an HTTP(S) request with an input XML containing the devices to be discovered. An output XML containing the task Id is returned. The task Id can then be used to get the status of the discovery results.
Request URL
  • Send Discovery request:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/deviceMon/discover
  • Get Discovery result:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/deviceMon/status?taskId=XXX
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
  • Discovery request: XML containing task Id.
  • Discovery result: XML containing discovered devices and attributes.

Refer to Example Usage for discovering devices.