Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Products Best Practices Hardware Guides Products A-Z
Summary
By Solution
By 4D Pillars
By Cloud
Secure Networking
Unified SASE
Security Operations
Secure SD-WAN
Secure Access Service Edge (SASE)
ZTNA
LAN Edge
Identity and Access Management
Next Generation Firewall
Public Cloud
Private Cloud
FortiCloud
Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
    • More >>
    Unified SASE
  • Single Vendor SASE
  • Cloud Network Security
  • Secure Endpoint Connectivity
  • Web Application / API Protection
    • More >>
    Security Operations
  • Security Operations Automation
  • Identity
  • Early Detection & Prevention
    • More >>
    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 Resources
    Solution Hubs
  • 4D Pillars
  • Cloud
  • Popular Solutions

    • Integration API Guide

    Home FortiSIEM 6.7.4 Integration API Guide
    6.7.4
    7.2.3
    7.2.2
    7.2.1
    7.2.0
    7.1.7
    7.1.6
    7.1.5
    7.1.4
    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

    Update Device by Id

    Update Device by Id

    This POST API allows user to update the CMDB device attributes for a CMDB Device. The device need to specified device id, that can be obtained via the Get CMDB Device List API. Only the attributes that need to be updated should be sent as part of API.

    Release Added 6.5.0
    Input URL

    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/device/update?deviceId=<device_id>&updateMode=OVERWRITE|APPEND

    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 Path Parameters

    Field

    		 Type Description
    deviceId string Device Id in CMDB - ids can be obtained via the Get CMDB Device List API.
    updateMode long

    Two values are allowed.

    • OVERWRITE – meaning overwrite the value like name
      or

    • APPEND – meaning add like network interface
    Request Body

    You need to create an XML as in Add CMDB Device(s) API to include the device attributes that you want to update and pass it in the HTTP request.

    A sample XML file for OVERWRITE-ing a device host name is File7_OVERWRITE_DeviceExample.xml. A sample XML file for APPEND-ing a device network Interface is File7_APPEND_DeviceExample.xml. The schema XSD is File8_deviceAPPENDExample.xsd. For an explanation the attribute definitions, see Appendix - Description of Device Attributes.
    Output

    When the request succeeds (HTTP response code 200), the following message will appear depending on the update status.

    • If update succeeds, a message “Successfully updated device” is returned.

    • If update fails, a proper error message e.g. “Invalid Device Id” is returned.

    Invalid attributes are ignored, and valid attributes are updated.
    Previous
    Next

    Update Device by Id

    Update Device by Id

    This POST API allows user to update the CMDB device attributes for a CMDB Device. The device need to specified device id, that can be obtained via the Get CMDB Device List API. Only the attributes that need to be updated should be sent as part of API.

    Release Added 6.5.0
    Input URL

    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/device/update?deviceId=<device_id>&updateMode=OVERWRITE|APPEND

    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 Path Parameters

    Field

    		 Type Description
    deviceId string Device Id in CMDB - ids can be obtained via the Get CMDB Device List API.
    updateMode long

    Two values are allowed.

    • OVERWRITE – meaning overwrite the value like name
      or

    • APPEND – meaning add like network interface
    Request Body

    You need to create an XML as in Add CMDB Device(s) API to include the device attributes that you want to update and pass it in the HTTP request.

    A sample XML file for OVERWRITE-ing a device host name is File7_OVERWRITE_DeviceExample.xml. A sample XML file for APPEND-ing a device network Interface is File7_APPEND_DeviceExample.xml. The schema XSD is File8_deviceAPPENDExample.xsd. For an explanation the attribute definitions, see Appendix - Description of Device Attributes.
    Output

    When the request succeeds (HTTP response code 200), the following message will appear depending on the update status.

    • If update succeeds, a message “Successfully updated device” is returned.

    • If update fails, a proper error message e.g. “Invalid Device Id” is returned.

    Invalid attributes are ignored, and valid attributes are updated.
    Previous
    Next