Fortinet black logo

Integration API Guide

Home FortiSIEM 6.7.3 Integration API Guide

Get Device Add Request Status

6.7.3
7.1.3
7.1.1
7.1.0
7.0.3
7.0.2
7.0.1
7.0.0
6.7.9
6.7.8
6.7.7
6.7.6
6.7.5
6.7.4
6.7.3
6.7.2
6.7.1
6.7.0
6.6.5
6.6.4
6.6.3
6.6.2
6.6.1
6.6.0
6.5.3
6.5.2
6.5.1
6.5.0
6.4.4
6.4.3
6.4.2
6.4.1
6.4.0
6.3.3
6.3.2
6.3.1
6.3.0
6.2.1
6.2.0
6.1.2
6.1.1
6.1.0
5.4.0
5.3.3
5.3.2
5.3.1
5.3.0
5.2.6
5.2.5
5.2.1
5.1.0
5.0.0
4.10.0
Copy Link
Copy Doc ID 953a6ae4-c34a-11ed-8e6d-fa163e15d75b:783160
Download PDF

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://<FortiSIEM_Supervisor_IP>/phoenix/rest/device/list/source?identifier=RESTAPI_<TaskId>

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.
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
Previous
Next

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://<FortiSIEM_Supervisor_IP>/phoenix/rest/device/list/source?identifier=RESTAPI_<TaskId>

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.
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
Previous
Next