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.0 Integration API Guide
    6.7.0
    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

    Get Device Custom Property

    Get Device Custom Property

    This GET API returns the device properties for a particular device specified by organization name, organization ID, access IP or host name. Only the properties that are set are returned.

    Release Added 6.5.0
    Input URL

    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/properties?organization=<org_name>&orgId=<org_id>&ip=<device_ip>&name=<hostname>
    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 Parameters

    Field

    		 Type Description
    org_name string Organization name
    org_id long Organization ID. Required field.
    ip string

    Device Access IP. Must be an exact match. Either ip or name is required.
    name string

    Host name of the device. Either ip or name is required.
    Output When the request succeeds (HTTP response code 200), then an XML is returned with the set properties for that device. Schema XSD file is File9_device_properties.xsd.
    Previous
    Next

    Get Device Custom Property

    Get Device Custom Property

    This GET API returns the device properties for a particular device specified by organization name, organization ID, access IP or host name. Only the properties that are set are returned.

    Release Added 6.5.0
    Input URL

    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/properties?organization=<org_name>&orgId=<org_id>&ip=<device_ip>&name=<hostname>
    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 Parameters

    Field

    		 Type Description
    org_name string Organization name
    org_id long Organization ID. Required field.
    ip string

    Device Access IP. Must be an exact match. Either ip or name is required.
    name string

    Host name of the device. Either ip or name is required.
    Output When the request succeeds (HTTP response code 200), then an XML is returned with the set properties for that device. Schema XSD file is File9_device_properties.xsd.
    Previous
    Next