Fortinet black logo

Integration API Guide

Delete CMDB Device(s)

Delete CMDB Device(s)

This POST API enables you to delete one or more CMDB devices by specifying device IDs. The list of device ids can be obtained via the Get CMDB Device List API.

Release Added 6.5.0
Input URL

https://<FortiSIEM_Supervisor_IP>/phoenix/rest/device/list/delete

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 POST
Request Body

The request body should be a JSON with a list of device ids. Note that the list of device ids can be obtained via the Get CMDB Device List API.

Input JSON array format: [id1, id2]

Request Body example:

[id1, id2]

Output

When the request succeeds (HTTP response code 200), a JSON object is returned. It contains the list of device ids that were successfully deleted and the list of device ids for which delete failed.

Sample JSON follows.

{
  "success": "[968352]",
  "failed": "[968351,968353]"

Delete CMDB Device(s)

This POST API enables you to delete one or more CMDB devices by specifying device IDs. The list of device ids can be obtained via the Get CMDB Device List API.

Release Added 6.5.0
Input URL

https://<FortiSIEM_Supervisor_IP>/phoenix/rest/device/list/delete

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 POST
Request Body

The request body should be a JSON with a list of device ids. Note that the list of device ids can be obtained via the Get CMDB Device List API.

Input JSON array format: [id1, id2]

Request Body example:

[id1, id2]

Output

When the request succeeds (HTTP response code 200), a JSON object is returned. It contains the list of device ids that were successfully deleted and the list of device ids for which delete failed.

Sample JSON follows.

{
  "success": "[968352]",
  "failed": "[968351,968353]"