Fortinet black logo

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Integration API Guide

Get CMDB Device List

You can use this GET API to retrieve list of devices with specific organization ID and device IP/host name.

Release Added 6.5.0
Input URL

https://<FSM-Super-IP>/phoenix/rest/device/list?orgId=<org_id>&accessIp=<access_ip>&name=<name>

Input Credentials User name and password of Supervisor account, or Organization specific user name and password, Organization name.
HTTP Method GET
Request Path Parameters

Field

Type Description
org_id long Organization ID which device belongs to. This is a required field.
access_ip string

Device IP Address. Must be an exact match. Either access_ip or name is required.

name string

Host name of the device. Partial match is allowed. Either access_ip or name is required.

Output

When the request succeeds (HTTP response code 200), a JSON object is returned. It contains key attributes of the CMDB devices matching the request filter.

Sample JSON follows.

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

If there are no matching devices, then the JSON is empty.

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 CMDB Device List

You can use this GET API to retrieve list of devices with specific organization ID and device IP/host name.

Release Added 6.5.0
Input URL

https://<FSM-Super-IP>/phoenix/rest/device/list?orgId=<org_id>&accessIp=<access_ip>&name=<name>

Input Credentials User name and password of Supervisor account, or Organization specific user name and password, Organization name.
HTTP Method GET
Request Path Parameters

Field

Type Description
org_id long Organization ID which device belongs to. This is a required field.
access_ip string

Device IP Address. Must be an exact match. Either access_ip or name is required.

name string

Host name of the device. Partial match is allowed. Either access_ip or name is required.

Output

When the request succeeds (HTTP response code 200), a JSON object is returned. It contains key attributes of the CMDB devices matching the request filter.

Sample JSON follows.

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

If there are no matching devices, then the JSON is empty.

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