Fortinet Document Library

Version:

Version:

Version:


Table of Contents

Administration Guide

Download PDF
Copy Link

Specific endpoint

Display a specific endpoint.

URL=https://<servername>:8443/api/endpoint/{id}

URL=https://<servername>:8443/api/endpoint/macaddress/{mac}

URL=https://<servername>:8443/api/endpoint/ipaddress/{ip}

URL=https://<servername>:8443/api/network/device/port/{id}/hosts

URL=https://<servername>:8443/api/network/device/{id}/hosts

Return value

Type

Description

id

Integer

ID that uniquely identifies the endpoint.

createTime

Time

Date and time that this endpoint was created.

atRisk

Boolean

If true, endpoint has been marked at risk.

connected

Boolean

If true, endpoint is connected.

enabled

Boolean

If true, endpoint is enabled

deviceType

String

Type of the endpoint, such as, an IP Phone.

ipAddress

String

List of IP addresses assigned to the interfaces on the endpoint separated by commas

macAddress

String

List of MAC addresses on the endpoint separated by commas

location

String

Name of the connection location, such as a port name.

hardwareType

String

Type of hardware, such as, a PC .

hostName

String

Host name of the endpoint.

loggedOnUser

String

User ID of the logged on user.

owner

String

User ID of the user to whom this endpoint is registered.

notes

String

Notes entered on the host record.

os

String

Operating System on the endpoint.

serialNumber

String

Serial Number of the endpoint.

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://<servername>:8443/api/host/4218

Example XML format:

<endpointSearchResults>

<status>success</status>

<limit>25</limit>

<nextOffset>0</nextOffset>

<offset>0</offset>

<total>1</total>

<endpoints>

<endpoint>

<atRisk>false</atRisk>

<connected>true</connected>

<createTime>2017-01-25T16:59:49.103-05:00</createTime>

<deviceType>IP-Phone</deviceType>

<enabled>true</enabled>

<hardwareType></hardwareType>

<hostName>host-1</hostName>

<id>4218</id>

<ipAddress>192.168.99.170</ipAddress>

<location>Concord-3750 Fa2/0/29</location>

<macAddress>00:22:90:59:CD:DF</macAddress>

<notes>the quick brown fox</notes>

<os>OS 1.2</os>

<owner>Moe</owner>

<role>Concord</role>

<serialNumber>123456789</serialNumber>

</endpoint>

</endpoints>

</endpointResult>

Specific endpoint

Display a specific endpoint.

URL=https://<servername>:8443/api/endpoint/{id}

URL=https://<servername>:8443/api/endpoint/macaddress/{mac}

URL=https://<servername>:8443/api/endpoint/ipaddress/{ip}

URL=https://<servername>:8443/api/network/device/port/{id}/hosts

URL=https://<servername>:8443/api/network/device/{id}/hosts

Return value

Type

Description

id

Integer

ID that uniquely identifies the endpoint.

createTime

Time

Date and time that this endpoint was created.

atRisk

Boolean

If true, endpoint has been marked at risk.

connected

Boolean

If true, endpoint is connected.

enabled

Boolean

If true, endpoint is enabled

deviceType

String

Type of the endpoint, such as, an IP Phone.

ipAddress

String

List of IP addresses assigned to the interfaces on the endpoint separated by commas

macAddress

String

List of MAC addresses on the endpoint separated by commas

location

String

Name of the connection location, such as a port name.

hardwareType

String

Type of hardware, such as, a PC .

hostName

String

Host name of the endpoint.

loggedOnUser

String

User ID of the logged on user.

owner

String

User ID of the user to whom this endpoint is registered.

notes

String

Notes entered on the host record.

os

String

Operating System on the endpoint.

serialNumber

String

Serial Number of the endpoint.

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://<servername>:8443/api/host/4218

Example XML format:

<endpointSearchResults>

<status>success</status>

<limit>25</limit>

<nextOffset>0</nextOffset>

<offset>0</offset>

<total>1</total>

<endpoints>

<endpoint>

<atRisk>false</atRisk>

<connected>true</connected>

<createTime>2017-01-25T16:59:49.103-05:00</createTime>

<deviceType>IP-Phone</deviceType>

<enabled>true</enabled>

<hardwareType></hardwareType>

<hostName>host-1</hostName>

<id>4218</id>

<ipAddress>192.168.99.170</ipAddress>

<location>Concord-3750 Fa2/0/29</location>

<macAddress>00:22:90:59:CD:DF</macAddress>

<notes>the quick brown fox</notes>

<os>OS 1.2</os>

<owner>Moe</owner>

<role>Concord</role>

<serialNumber>123456789</serialNumber>

</endpoint>

</endpoints>

</endpointResult>