Fortinet black logo

Administration Guide

Add or update an endpoint - FORM

Copy Link
Copy Doc ID 825689eb-200d-11e9-b6f6-f8bc1258b856:376350
Download PDF

Add or update an endpoint - FORM

Add or update a host with form parameters.

https://<servername>:8443/api/host/update

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

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.

Note

MAC address values are case sensitive and are stored as uppercase values.

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 POST -d 'macAddress=00:0C:29:3D:9B:4D' -d'role=MyNewRole' https://<servername>:8443/api/host/update

Example XML format

<endpointResult>

<status>success</status>

<endpoints>

<endpoint>

<atRisk>false</atRisk>

<connected>false</connected>

<createTime>2017-01-25T10:20:50.533-05:00</createTime>

<enabled>false</enabled>

<id>3717</id>

<macAddress>00:0C:29:3D:9B:4D</macAddress>

<role>MyNewRole</role>

</endpoint>

</endpoints>

</endpointResult>

Add or update an endpoint - FORM

Add or update a host with form parameters.

https://<servername>:8443/api/host/update

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

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.

Note

MAC address values are case sensitive and are stored as uppercase values.

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 POST -d 'macAddress=00:0C:29:3D:9B:4D' -d'role=MyNewRole' https://<servername>:8443/api/host/update

Example XML format

<endpointResult>

<status>success</status>

<endpoints>

<endpoint>

<atRisk>false</atRisk>

<connected>false</connected>

<createTime>2017-01-25T10:20:50.533-05:00</createTime>

<enabled>false</enabled>

<id>3717</id>

<macAddress>00:0C:29:3D:9B:4D</macAddress>

<role>MyNewRole</role>

</endpoint>

</endpoints>

</endpointResult>