Fortinet black logo

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Integration API Guide

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

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_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.

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

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_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.