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://<FortiSIEM_Supervisor_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://<FortiSIEM_Supervisor_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

Secure Networking

Hybrid Mesh Firewall

NOC Management

LAN

WAN

Unified SASE

Single Vendor SASE

Cloud Network Security

Secure Endpoint Connectivity

Web Application / API Protection

Security Operations

Security Operations Automation

Identity

Early Detection & Prevention

Secure Networking

Hybrid Mesh Firewall

NOC Management

LAN

WAN

Communication & Surveillance

Unified SASE

Single Vendor SASE

Secure Endpoint Connectivity

Cloud Network Security

Cloud-Native Security

Web Application / API Protection

Security Operations

Security Operations Automation

Endpoint

Data Protection

Identity

Email

Early Detection & Prevention

Expert Services

Edge Firewall

Orchestration & management

SD Branch

Application Delivery

Single Vendor SASE

Secure Endpoint Connectivity

Secure Private Access

Thin Edge

Identity

Application Gateway

Enterprise Asset Management

Endpoint Agent

Agentless Security Posture

Identity

Wireless

Switching

Identity

Privilege Acccess Management

Next Generation Firewall

Orchestration & management

Expert Services

All

All

Account Management

SAAS Management

SAAS Application Security

Managed Services

Platform as a service (PAAS)

Other SAAS Services

4D Pillars

Cloud

Popular Solutions

Integration API Guide