Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Integration API Guide

Get Device Add Request Status

You can use this API to get the status of device add request with specific task id.

Release Added 6.5.0
Input URL

https://<FSM-Super-IP>/phoenix/rest/device/list/source?identifier=RESTAPI_<TaskId>

Input Credentials User name and password of Supervisor account, or Organization specific user name and password, Organization name.
HTTP Method GET
Request Path Parameter Replace <TaskId> with long value in the URL. The TaskId is obtained from the response in the Add CMDB Device(s) API.
Output

When the request succeeds (HTTP response code 200), a JSON object is returned. It contains key attributes of the devices that were added to CMDB as part of the request with the specified taskId.

Sample JSON follows.

[
  {
    "id": 968352,
    "orgId": 1,
    "orgName": "Super",
    "hostName": "FSM_Test_6501741_5835",
    "accessIp": "172.30.58.35",
    "deviceType": "Redhat Linux"
  }
]

When the request fails, response contains failed reason.

Note: Failed devices are not provided in this release.

Output Key Fields
Field Type Description
id long Device ID in FortiSIEM CMDB
orgId long Organization ID which device belongs to
orgName string Organization Name
hostName string Host Name
accessIp string Device IP Address
deviceType string Device Type

Get Device Add Request Status

You can use this API to get the status of device add request with specific task id.

Release Added 6.5.0
Input URL

https://<FSM-Super-IP>/phoenix/rest/device/list/source?identifier=RESTAPI_<TaskId>

Input Credentials User name and password of Supervisor account, or Organization specific user name and password, Organization name.
HTTP Method GET
Request Path Parameter Replace <TaskId> with long value in the URL. The TaskId is obtained from the response in the Add CMDB Device(s) API.
Output

When the request succeeds (HTTP response code 200), a JSON object is returned. It contains key attributes of the devices that were added to CMDB as part of the request with the specified taskId.

Sample JSON follows.

[
  {
    "id": 968352,
    "orgId": 1,
    "orgName": "Super",
    "hostName": "FSM_Test_6501741_5835",
    "accessIp": "172.30.58.35",
    "deviceType": "Redhat Linux"
  }
]

When the request fails, response contains failed reason.

Note: Failed devices are not provided in this release.

Output Key Fields
Field Type Description
id long Device ID in FortiSIEM CMDB
orgId long Organization ID which device belongs to
orgName string Organization Name
hostName string Host Name
accessIp string Device IP Address
deviceType string Device Type