Alarm details

https://<servername>:8443/api/alarm?tag={tag}

https://<servername>:8443api/alarm/{id}

Alarm actions

https://<servername>:8443/api/alarm/acknowledge/{dbid}

Control details

https://<servername>:8443/api/control

https://<servername>:8443/api/control/{dbid}

https://<servername>:8443/api/control/host/{hostId}

https://<servername>:8443/api/control/ipaddress/{ip}

https://<servername>:8443/api/control/active

https://<servername>:8443/api/control/active/ipaddress/{ip}

https://<servername>:8443/api/control/active/host/{hostId}

https://<servername>:8443/api/control/inactive

https://<servername>:8443/api/control/inactive/ipaddress/{ip}

https://<servername>:8443/api/control/inactive/host/{hostId}

https://<servername>:8443/api/control/{dbid}tasks

Control actions

https://<servername>:8443/api/control/ipaddress

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

IP address: ip

Control Action: action

Duration: duration

https://<servername>:8443/api/control/macaddress

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

MAC address: mac

Control Action: action

Duration: duration

https://<servername>:8443/api/control/endpoint

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

ID: id

Control Action: action

Duration: duration

https://<servername>:8443/api/control/undo/{dbid}

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

IP address: ip

Control Action: action

Duration: duration

https://<servername>:8443/api/control/{id}

https://<servername>:8443/api/control/scan/{id}

Device profile actions

https://<servername>:8443/api/deviceprofiler/profiled/register/{id}

https://<servername>:8443/api/deviceprofiler/profiled/{id}

Device profile details

https://<servername>:8443/api/deviceprofiler/profiled

https://<servername>:8443/api/deviceprofiler/identity/{id}

https://<servername>:8443/api/deviceprofiler/rule

https://<servername>:8443/api/deviceprofiler/rule/{id}

Endpoint details

https://<servername>:8443/api/host/?offset={offset}&limit={limit}

Default offset = 0

Default limit = 25

The following values can be appended to the end of the URL to further filter the results:

id, createTime, hardwareType, hostName, owner, loggedOnUserId, os, connected, notes, ipAddress, macAddress, location, orderby, direction, role, atRisk, enabled, deviceType, serialNumber, limit, offset

Example:

https://<servername>:8443/api/host/?hardwareType=mobile&connected=true

https://<servername>:8443/api/host/{id}

The following values can be appended to the end of the URL to further filter the results:

role, atRisk, enabled, deviceType, serialNumber

Example:

https://<servername>:8443/api/host/3717/"enabled":true,"role":null,"atRisk":
false,"deviceType":"Rogue","serialNumber":null

https://<servername>:8443/api/host/ipaddress/{ip}

https://<servername>:8443/api/host/macaddress/{mac}

https://<servername>:8443/api/host/{dbid}/adapters

https://<servername>:8443/api/host/adapter/{adapterID}

https://<servername>:8443/api/host/adapter/{adapterID}/port

https://<servername>:8443/api/host/dbid/device

Endpoint actions

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

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

Username: userID

Hostname: hName

Operating System: os

IP address: ip

MAC address: mac

MAC address is required to uniquely identify the endpoint. If the MAC address exists in the database, the record is updated. If the MAC address does not exist in the database a new endpoint record is created.

The following values can be appended to the end of the URL to further filter the results:

notes, hwType, role, enabled, serialNumber

Example:

https://&lt;servername&gt;:8443/api/host/update/"hardwareType":null,
"connected":false,"enabled":false,"role":"MyNewRole","serialNumber":null

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

https://<servername>:8443/api/host/{id}

Event details

https://<servername>:8443/api/event

Group details

https://<servername>:8443/api/group

Group actions

https://<servername>:8443/api/group

https://<servername>:8443/api/group/{id}

Network details

https://<servername>:8443/api/network/device/?offset={offset}&limit={limit}

Default offset = 0

Default limit = 25

The following values can be appended to the end of the URL to further filter the results:

id, name, hardwareType, ipAddress, description, sysOid, orderby,
direction

Example:

https://<servername>:8443/api/network/device/?hardwareType=mobile&connected=true

https://<servername>:8443/api/network/device/{dbid}

https://<servername>:8443/api/network/device/{dbid}/ports

https://<servername>:8443/api/network/device/port/{dbid}

https://<servername>:8443/api/network/device/port/{dbid}/hosts

https://<servername>:8443/api/network/device/{dbid}/hosts

Scheduler details

https://<servername>:8443/api/scheduler

https://<servername>:8443/api/scheduler/{id}

Scheduler actions

https://<servername>:8443/api/scheduler/run/{id}

User details

https://<servername>:8443/api/user/?offset={offset}&limit={limit}

Default offset = 0

Default limit = 25

The following values can be appended to the end of the URL to further filter the results:

id, userid, firstName, lastName, address, city, state, zipcode, phone, email, mobilephone, mobileprovider, orderby, direction, role

Example:

https://<servername>:8443/api/user?city=concord&state=nh

https://<servername>:8443/api/user/{dbid}

The following values can be appended to the end of the URL to further filter the results:

id, userid, firstName, lastName, address, city, state, zipcode, phone, email, mobilephone, mobileprovider, orderby, direction, role

https://<servername>:8443/api/user/userid/{userid}

id, userid, firstName, lastName, address, city, state, zipcode, phone, email, mobilephone, mobileprovider, orderby, direction, role

User actions

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

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

Username: userID

First Name: fName

Last Name: lName

User Type: type (values are User or Administrative, with User being the default)

Email Address: email

Admin Profile: adminProfile (enter the name of the administrator profile)

The userID parameter is required to uniquely identify the User. If the userID exists in the database, the record is updated. If the userID does not exist in the database a new User record is created.

Role: role

https://<servername>:8443/api/user/{id}

Network containers

https://<servername>:8443/api/network/domain?offset={offset}&limit={limit}

Default offset = 0

Default limit = 25

https://<servername>:8443/api/network/domain/{dbid}

https://<servername>:8443/api/network/domain/name/{name}

https://<servername>:8443/api/network/domain/{dbid}/devices

Network container actions

https://<servername>:8443/api/network/domain/update

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

Name: name

The name parameter is required to uniquely identify the container. If the name does not exist in the database a new Container record is created.

https://<servername>:8443/api/network/domain/ discovery/snmpV1

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

Name: name

Starting IP address: startIP

Ending IP address: endIP

Security String: security

The name parameter is required to uniquely identify the container where discovery should be run. If the name exists in the database discovery is done for the selected container.

https://<servername>:8443/api/network/domain/ discovery/snmpV1/cdp

Accepted Content-type:
application/x-www-form-urlencoded

Form Parameters:

Name: name

Starting IP address: startIP

Security String: security

The name parameter is required to uniquely identify the container where discovery should be run. If the name exists in the database discovery is done for the selected container.

When using CDP discovery it is recommended that you set the Maximum Cisco Discovery Depth in the FortiNAC admin UI to limit the number of levels searched from the starting IP address. If this setting is not enabled, discovery may take an extensive amount of time.

https://<servername>:8443/api/network/domain/ discovery/snmpV3

Accepted Content-type:

application/x-www-form-urlencoded

Form Parameters:

Name: name

Starting IP address: startIP

Ending IP address: endIP

User name: user

Authentication password: password

Privacy password: privacy

Authentication protocol: authProto

Privacy protocol: privProto

The name parameter is required to uniquely identify the container where discovery should be run. If the name exists in the database discovery is done for the selected container.

https://<servername>:8443/api/network/domain/ discovery/snmpV3/cdp

Accepted Content-type:

application/x-www-form-urlencoded

Form Parameters:

Name: name

Starting IP address: startIP

User name: user

Authentication password: password

Privacy password: privacy

Authentication protocol: authProto

Privacy protocol: privProto

The name parameter is required to uniquely identify the container where discovery should be run. If the name exists in the database discovery is done for the selected container.

When using CDP discovery it is recommended that you set the maximum Cisco discovery depth in the FortiNAC admin UI to limit the number of levels searched from the starting IP address. If this setting is not enabled, discovery may take an extensive amount of time.

Vendor OUI details

https://<servername>:8443/api/vendorcode