Fortinet black logo

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Integration API Guide

Add CMDB Device(s)

This API provides the ability to add one or more devices to CMDB. This is an asynchronous request that should be used as follows:

  • Submit the device add request. A task id will be returned

  • Get the device addition status by querying with this task id (See Get Device Add Request Status API)

Release Added 6.5.0
Input URL https://<FSM-Super-IP>/phoenix/rest/device/discovery/add
Input Credentials User name and password of Supervisor account, or Organization specific user name and password, Organization name.
HTTP Method POST
Request Body You need to create an XML for the device attributes and pass it in the HTTP request. A sample XML file is File5_AddDeviceExample.xml and the schema file XSD is File6_device.xsd. For an explanation the attribute definitions, see Appendix - Description of Device Attributes.
Output

When the request succeeds (HTTP response code 200), a taskId will be returned. You can query Device add status using this task Id in a separate API (see Get Device Add Request Status).

<response>
      <status>Discovery xml is queued</status>
     <sourceIdentifier>RESTAPI_<TaskId></sourceIdentifier>
</response>

Add CMDB Device(s)

This API provides the ability to add one or more devices to CMDB. This is an asynchronous request that should be used as follows:

  • Submit the device add request. A task id will be returned

  • Get the device addition status by querying with this task id (See Get Device Add Request Status API)

Release Added 6.5.0
Input URL https://<FSM-Super-IP>/phoenix/rest/device/discovery/add
Input Credentials User name and password of Supervisor account, or Organization specific user name and password, Organization name.
HTTP Method POST
Request Body You need to create an XML for the device attributes and pass it in the HTTP request. A sample XML file is File5_AddDeviceExample.xml and the schema file XSD is File6_device.xsd. For an explanation the attribute definitions, see Appendix - Description of Device Attributes.
Output

When the request succeeds (HTTP response code 200), a taskId will be returned. You can query Device add status using this task Id in a separate API (see Get Device Add Request Status).

<response>
      <status>Discovery xml is queued</status>
     <sourceIdentifier>RESTAPI_<TaskId></sourceIdentifier>
</response>