Fortinet Document Library

Version:

Version:

Version:


Table of Contents

Administration Guide

Download PDF
Copy Link

Endpoints - bulk

Display a list of endpoints.

URL = https://<servername>:8443/api/endpoint

Return value

Type

Description

Connected

Boolean

If true, endpoint is connected.

Create Time

Time

Date and time that this endpoint was created.

Hardware Type

String

Type of hardware, such as, a PC .

Host Name

String

Host name of the endpoint.

id

Integer

ID that uniquely identifies the endpoint.

IP address

String

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

Location

String

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

Logged On User

String

User ID of the logged on user.

MAC Address

String

List of MAC addresses on the endpoint separated by commas

Notes

String

Notes entered on the host record.

OS

String

Operating System on the endpoint.

Owner

String

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

Example XML format:

<endpointSearchResult>

<status>success</status>

<limit>25</limit>

<nextOffset>25</nextOffset>

<offset>0</offset>

<total>2</total>

<endpoints>

<endpoint>

<atRisk>false</atRisk>

<connected>false</connected>

<createTime>2017-02-04T10:35:35.653-05:00</createTime>

<deviceType>Rogue</deviceType>

<enabled>true</enabled>

<hostName>Franks-Mac-mini</hostName>

<id>5688</id>

<ipAddress>192.168.6.232</ipAddress>

<location/>

<macAddress>0C:4D:E9:A2:90:75</macAddress>

<os>Mac OS X OS X</os>

<role>TEST</role>

</endpoint>

<endpoint>

<atRisk>false</atRisk>

<connected>false</connected>

<createTime>2017-02-10T16:32:54.137-05:00</createTime>

<deviceType>Rogue</deviceType>

<enabled>true</enabled>

<id>5714</id>

<ipAddress/>

<location>XirrusLabQA-1 ROLE -Configured-</location>

<macAddress>DA:4B:46:55:C2:CD</macAddress>

<role>TEST</role>

</endpoint>

<endpoints>

</endpointSearchResult>

Endpoints - bulk

Display a list of endpoints.

URL = https://<servername>:8443/api/endpoint

Return value

Type

Description

Connected

Boolean

If true, endpoint is connected.

Create Time

Time

Date and time that this endpoint was created.

Hardware Type

String

Type of hardware, such as, a PC .

Host Name

String

Host name of the endpoint.

id

Integer

ID that uniquely identifies the endpoint.

IP address

String

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

Location

String

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

Logged On User

String

User ID of the logged on user.

MAC Address

String

List of MAC addresses on the endpoint separated by commas

Notes

String

Notes entered on the host record.

OS

String

Operating System on the endpoint.

Owner

String

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

Example XML format:

<endpointSearchResult>

<status>success</status>

<limit>25</limit>

<nextOffset>25</nextOffset>

<offset>0</offset>

<total>2</total>

<endpoints>

<endpoint>

<atRisk>false</atRisk>

<connected>false</connected>

<createTime>2017-02-04T10:35:35.653-05:00</createTime>

<deviceType>Rogue</deviceType>

<enabled>true</enabled>

<hostName>Franks-Mac-mini</hostName>

<id>5688</id>

<ipAddress>192.168.6.232</ipAddress>

<location/>

<macAddress>0C:4D:E9:A2:90:75</macAddress>

<os>Mac OS X OS X</os>

<role>TEST</role>

</endpoint>

<endpoint>

<atRisk>false</atRisk>

<connected>false</connected>

<createTime>2017-02-10T16:32:54.137-05:00</createTime>

<deviceType>Rogue</deviceType>

<enabled>true</enabled>

<id>5714</id>

<ipAddress/>

<location>XirrusLabQA-1 ROLE -Configured-</location>

<macAddress>DA:4B:46:55:C2:CD</macAddress>

<role>TEST</role>

</endpoint>

<endpoints>

</endpointSearchResult>