Rev B November 16, 2022 FortiNAC REST Schema

FortiNAC REST Schema

REST API for the FortiNAC product. Not all features may be publically accessible
More information: https://helloreverb.com

Version: 3.0.8
Copyright Fortinet
http://apache.org/licenses/LICENSE-2.0.html

Access
1. APIKey KeyParamName:bfSecKey KeyInQuery:true KeyInHeader:false
2. HTTP Basic Authentication

Methods
[ Jump to Models ]

Table of Contents

AAAServer

POST /settings/integration/aaa
POST /settings/integration/aaa-mappings/local-domains
POST /settings/integration/aaa-mappings
POST /settings/integration/aaa/delete
POST /settings/integration/aaa-mappings/local-domains/delete
POST /settings/integration/aaa-mappings/delete
DELETE /settings/integration/aaa/{id}
POST /settings/integration/aaa/{id}/delete
GET /settings/integration/aaa
GET /settings/integration/aaa/{id}
GET /settings/integration/aaa/count/all
GET /settings/integration/aaa/count
GET /settings/integration/aaa/{id}/usage
GET /settings/integration/aaa-mappings/defaults
GET /settings/integration/aaa-mappings/local-domains
GET /settings/integration/aaa-mappings
GET /settings/integration/aaa/{id}/secret
GET /settings/integration/aaa/{id}/validation-user-password
POST /settings/integration/aaa/{id}
POST /settings/integration/aaa-mappings/defaults
POST /settings/integration/aaa-mappings/swap

AccessConfiguration

POST /policy/access-configuration
POST /policy/access-configuration/delete
DELETE /policy/access-configuration/{id}
POST /policy/access-configuration/{id}/delete
GET /policy/access-configuration
GET /policy/access-configuration/{id}
GET /policy/access-configuration/count/all
GET /policy/access-configuration/count
GET /policy/access-configuration/{id}/usage
GET /policy/access-configuration/supporting-info
POST /policy/access-configuration/{id}

AccessPointManagement

POST /settings/device/access-point-management/ip-ranges
POST /settings/device/access-point-management/ip-ranges/{id}
POST /settings/device/access-point-management/ip-ranges/delete
GET /settings/device/access-point-management
GET /settings/device/access-point-management/ip-ranges
POST /settings/device/access-point-management

AccessPolicy

POST /policy/access
POST /policy/access/delete
DELETE /policy/access/{id}
POST /policy/access/{id}/delete
POST /policy/access/{id}/disable

1/615
1/21/22, 11:27 AM FortiNAC REST Schema
POST /policy/access/{id}/enable
GET /policy/access
GET /policy/access/{id}
GET /policy/access/supporting-info
POST /policy/access/{id}
POST /policy/access/rank/set
POST /policy/access/rank/swap

AdapterRecord

POST /adapter
POST /adapter/delete
DELETE /adapter/{id}
POST /adapter/{id}/delete
POST /adapter/{id}/disable
POST /adapter/{id}/enable
GET /adapter/connected-to-ports
GET /adapter/for-host
GET /adapter
GET /adapter/{id}
GET /adapter/count/all
GET /adapter/count
GET /adapter/{id}/usage
GET /adapter/{id}/get-port
POST /adapter/{id}
POST /adapter/reprofile-rogues
POST /adapter/run-nmap-scan

AdminProfile

POST /user/admin-profile/mapping
POST /user/admin-profile
POST /user/admin-profile/mapping/delete
POST /user/admin-profile/delete
DELETE /user/admin-profile/mapping/{id}
DELETE /user/admin-profile/{id}
POST /user/admin-profile/mapping/{id}/delete
POST /user/admin-profile/{id}/delete
GET /user/admin-profile/mapping
GET /user/admin-profile
GET /user/admin-profile/mapping/{id}
GET /user/admin-profile/{id}
GET /user/admin-profile/new
GET /user/admin-profile/{id}/usage
GET /user/admin-profile/permission-view-map
GET /user/admin-profile/mapping/supporting-info
POST /user/admin-profile/mapping/{id}
POST /user/admin-profile/{id}
POST /user/admin-profile/mapping/rank/set
POST /user/admin-profile/mapping/rank/swap

Aging

POST /host/aging/clear-registered
POST /host/aging/clear-unregistered
POST /host/aging/clear-users
GET /host/aging
POST /host/aging

Alarm

POST /logging/alarm/acknowledge
POST /logging/alarm/{id}/acknowledge
POST /logging/alarm/delete
DELETE /logging/alarm/{id}
POST /logging/alarm/{id}/delete
GET /logging/alarm/archive
GET /logging/alarm/supporting-info
GET /logging/alarm
GET /logging/alarm/{id}
GET /logging/alarm/count/all
GET /logging/alarm/count
GET /logging/alarm/archive/import/status
GET /logging/alarm/monitor/{id}
GET /logging/alarm/{id}/usage

2/615
1/21/22, 11:27 AM FortiNAC REST Schema
POST /logging/alarm/archive/import
POST /logging/alarm/monitor/start
POST /logging/alarm/monitor/{id}/stop

AuditLog

GET /logging/audit/count
GET /logging/audit

AuthenticationConfiguration

POST /policy/authentication-configuration
POST /policy/authentication-configuration/delete
DELETE /policy/authentication-configuration/{id}
POST /policy/authentication-configuration/{id}/delete
GET /policy/authentication-configuration
GET /policy/authentication-configuration/{id}
GET /policy/authentication-configuration/{id}/usage
POST /policy/authentication-configuration/{id}

AuthenticationPolicy

POST /policy/authentication
POST /policy/authentication/delete
DELETE /policy/authentication/{id}
POST /policy/authentication/{id}/delete
POST /policy/authentication/{id}/disable
POST /policy/authentication/{id}/enable
GET /policy/authentication
GET /policy/authentication/{id}
POST /policy/authentication/{id}
POST /policy/authentication/rank/set
POST /policy/authentication/rank/swap

BackgroundTask

POST /system/background-task
POST /system/background-task/delete
GET /system/background-task
GET /system/background-task/{id}
GET /system/background-task/current-user
POST /system/background-task/{id}/complete
POST /system/background-task/{id}

BackupConfiguration

GET /system/backup/configuration/ftp
GET /system/backup/configuration/ssh
POST /system/backup/configuration/ftp
POST /system/backup/configuration/ssh

BackupSettings

GET /system/backup-settings/archives
GET /system/backup-settings/database/archive
GET /system/backup-settings/database
GET /system/backup-settings/system-backup
POST /system/backup-settings/database/restore-archives
POST /system/backup-settings/database
POST /system/backup-settings/archives
POST /system/backup-settings/system-backup

Certificate

POST /settings/security/certificate-server/copy
POST /settings/security/certificate-server/{name}/deleteServerCert
POST /settings/security/certificate-server/{name}/delete
POST /settings/security/certificate-server/csr/generate
GET /settings/security/certificate-server
POST /settings/security/certificate-server/restart
POST /settings/security/certificate-server/{name}

ConnectionLog

GET /logging/connection/archive
3/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /logging/connection
GET /logging/connection/{id}
GET /logging/connection/count/all
GET /logging/connection/count
GET /logging/connection/archive/import/status
GET /logging/connection/top/users/connected-time
POST /logging/connection/archive/import

Container

POST /device/container
POST /device/container/delete
DELETE /device/container/{id}
POST /device/container/{id}/delete
GET /device/container
GET /device/container/{id}
GET /device/container/count/all
GET /device/container/count
GET /device/container/monitor/{id}
GET /device/container/{id}/usage
POST /device/container/{id}
POST /device/container/monitor/start
POST /device/container/monitor/{id}/stop

Dashboard

POST /user/dashboard
POST /user/dashboard/delete
DELETE /user/dashboard/{id}
POST /user/dashboard/{id}/delete
GET /user/dashboard/agent-summary
GET /user/dashboard
GET /user/dashboard/{id}
GET /user/dashboard/device-summary
GET /user/dashboard/device-summary/device/{tag}/{status}
GET /user/dashboard/device-summary/port/offline
GET /user/dashboard/device-summary/port/online
GET /user/dashboard/host-summary
GET /user/dashboard/{id}/usage
GET /user/dashboard/scan-summary/per-day
GET /user/dashboard/scan-summary/per-hour
GET /user/dashboard/user-summary
POST /user/dashboard/{id}
POST /user/dashboard/{id}/resetToDefault
POST /user/dashboard/rank/set

DeviceIdentity

POST /host/device-identity
POST /host/device-identity/confirm-rule
POST /host/device-identity/delete
DELETE /host/device-identity/{id}
POST /host/device-identity/{id}/delete
GET /host/device-identity
GET /host/device-identity/{id}
GET /host/device-identity/count/all
GET /host/device-identity/count
GET /host/device-identity/fingerprints
GET /host/device-identity/fingerprint/{id}
GET /host/device-identity/{id}/usage
POST /host/device-identity/{id}

DeviceIdentitySource

POST /host/device-identity-source
POST /host/device-identity-source/delete
DELETE /host/device-identity-source/{id}
POST /host/device-identity-source/{id}/delete
POST /host/device-identity-source/{id}/disable
POST /host/device-identity-source/{id}/enable
GET /host/device-identity-source
GET /host/device-identity-source/{id}
POST /host/device-identity-source/{id}
POST /host/device-identity-source/rank/set
POST /host/device-identity-source/rank/swap

4/615
1/21/22, 11:27 AM FortiNAC REST Schema
DeviceProfiler

GET /DeviceProfiler/Rule/export
GET /settings/device/device-profiler
POST /settings/device/device-profiler

DeviceProfilingRule

POST /host/device-profiling-rule
POST /host/device-profiling-rule/delete
DELETE /host/device-profiling-rule/{id}
POST /host/device-profiling-rule/{id}/delete
POST /host/device-profiling-rule/{id}/disable
POST /host/device-profiling-rule/{id}/enable
GET /host/device-profiling-rule
GET /host/device-profiling-rule/{id}
GET /host/device-profiling-rule/count/all
GET /host/device-profiling-rule/count
GET /host/device-profiling-rule/create-from-adapter
GET /host/device-profiling-rule/{id}/usage
GET /host/device-profiling-rule/queue
POST /host/device-profiling-rule/{id}
POST /host/device-profiling-rule/scan
POST /host/device-profiling-rule/swap-rule-ranks
POST /host/device-profiling-rule/test

DeviceType

POST /settings/device/device-type
POST /settings/device/device-type/createFromArchive
POST /settings/device/device-type/delete
DELETE /settings/device/device-type/{id}
POST /settings/device/device-type/{id}/delete
GET /settings/device/device-type/image/archive
GET /settings/device/device-type
GET /settings/device/device-type/{id}
GET /settings/device/device-type/{id}/usage
POST /settings/device/device-type/{id}

DirectoryAgentConfig

POST /settings/agent/directory-agent/subnet
POST /settings/agent/directory-agent
POST /settings/agent/directory-agent/subnet/delete
POST /settings/agent/directory-agent/delete
DELETE /settings/agent/directory-agent/{id}
POST /settings/agent/directory-agent/{id}/delete
POST /settings/agent/directory-agent/{id}/disable
POST /settings/agent/directory-agent/{id}/enable
GET /settings/agent/directory-agent/groups
GET /settings/agent/directory-agent
GET /settings/agent/directory-agent/{id}
GET /settings/agent/directory-agent/directory-groups
GET /settings/agent/directory-agent/subnet
GET /settings/agent/directory-agent/{id}/usage
POST /settings/agent/directory-agent/{id}
POST /settings/agent/directory-agent/rank/set
POST /settings/agent/directory-agent/rank/swap
POST /settings/agent/directory-agent/test
GET /settings/agent/directory-agent/subnet/test

Discovery

GET /device/discovery/discover/status
GET /device/discovery/discover/status/all
POST /device/discovery/discover
POST /device/discovery/discover/stop

EPCScan

POST /policy/endpoint-compliance/scan
POST /policy/endpoint-compliance/scan/copy
POST /policy/endpoint-compliance/scan/delete
GET /policy/endpoint-compliance/scan/available
GET /policy/endpoint-compliance/scan

5/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /policy/endpoint-compliance/scan/{id}/usage
GET /policy/endpoint-compliance/scan/details
GET /policy/endpoint-compliance/scan/product

Email

POST /settings/integration/email/delete
GET /settings/integration/email/password
GET /settings/integration/email
POST /settings/integration/email
POST /settings/integration/email/test

Event

POST /logging/event
POST /logging/event/delete
DELETE /logging/event/{id}
POST /logging/event/{id}/delete
GET /logging/event
GET /logging/event/{id}
GET /logging/event/count/all
GET /logging/event/count
GET /logging/event/archive
GET /logging/event/supporting-info
GET /logging/event/archive/import/status
GET /logging/event/monitor/{id}
GET /logging/event/{id}/usage
POST /logging/event/archive/import
POST /logging/event/{id}
POST /logging/event/note
POST /logging/event/monitor/start
POST /logging/event/monitor/{id}/stop

EventAction

POST /policy/event-action
POST /policy/event-action/delete
DELETE /policy/event-action/{id}
POST /policy/event-action/{id}/delete
GET /policy/event-action/supporting-info
GET /policy/event-action
GET /policy/event-action/{id}
GET /policy/event-action/{id}/usage
POST /policy/event-action/{id}

EventToAlarmMapping

POST /logging/event-alarm-mapping
POST /logging/event-alarm-mapping/modify
POST /logging/event-alarm-mapping/delete
DELETE /logging/event-alarm-mapping/{id}
POST /logging/event-alarm-mapping/{id}/delete
POST /logging/event-alarm-mapping/disable
POST /logging/event-alarm-mapping/enable
GET /logging/event-alarm-mapping
GET /logging/event-alarm-mapping/{id}
GET /logging/event-alarm-mapping/count/all
GET /logging/event-alarm-mapping/count
GET /logging/event-alarm-mapping/{id}/usage
GET /logging/event-alarm-mapping/supporting-info
POST /logging/event-alarm-mapping/{id}

EventTypes

GET /logging/event-types
GET /logging/event-types/{id}
GET /logging/event-types/count/all
GET /logging/event-types/count
GET /logging/event-types/thresholds
POST /logging/event-types/thresholds
POST /logging/event-types/group
POST /logging/event-types/logging-strategy

FSSO

6/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /settings/integration/FSSO/password
GET /settings/integration/FSSO
POST /settings/integration/FSSO

Fingerprint

POST /host/fingerprint
POST /host/fingerprint/delete
DELETE /host/fingerprint/{id}
POST /host/fingerprint/{id}/delete
GET /host/fingerprint
GET /host/fingerprint/{id}
GET /host/fingerprint/count/all
GET /host/fingerprint/count
POST /host/fingerprint/{id}

FirewallSession

POST /dynamic/dynamic-connection
POST /dynamic/dynamic-connection/delete
DELETE /dynamic/dynamic-connection/{id}
POST /dynamic/dynamic-connection/{id}/delete
GET /dynamic/dynamic-connection
GET /dynamic/dynamic-connection/{id}
GET /dynamic/dynamic-connection/host/{id}
GET /dynamic/dynamic-connection/{id}/usage
GET /dynamic/dynamic-connection/polling/{id}
POST /dynamic/dynamic-connection/{id}
POST /dynamic/dynamic-connection/polling/{id}/run
POST /dynamic/dynamic-connection/polling/{id}

FirewallTag

POST /settings/integration/firewall-tag
POST /settings/integration/firewall-tag/delete
DELETE /settings/integration/firewall-tag/{id}
POST /settings/integration/firewall-tag/{id}/delete
GET /settings/integration/firewall-tag
GET /settings/integration/firewall-tag/{id}
GET /settings/integration/firewall-tag/{id}/usage
POST /settings/integration/firewall-tag/{id}

FortigateTelemetry

POST /settings/security-fabric
POST /settings/security-fabric/delete
DELETE /settings/security-fabric/{id}
POST /settings/security-fabric/{id}/delete
GET /settings/security-fabric
GET /settings/security-fabric/{id}
GET /settings/security-fabric/{id}/usage
POST /settings/security-fabric/{id}

Google

POST /settings/integration/google/domains
POST /settings/integration/google/domains/delete
GET /settings/integration/google/domains
GET /settings/integration/google/client-id
POST /settings/integration/google/domains/{id}
POST /settings/integration/google/client-id
POST /settings/integration/google/domains/set

Group

POST /system/group/{id}/add-devices
POST /system/group/add-members
POST /system/group/{groupType}
POST /system/group/delete
DELETE /system/group/{id}
POST /system/group/{id}/delete
GET /system/group/by-type
GET /system/group
GET /system/group/{id}
GET /system/group/count/all

7/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /system/group/count
GET /system/group/{id}/descendants
GET /system/group/{id}/member-ids
GET /system/group/{id}/members
GET /system/group/{id}/usage
POST /system/group/membership
POST /system/group/add-to-parents
POST /system/group/{groupType}/{id}
POST /system/group/{id}/remove-devices
POST /system/group/remove-from-parent
POST /system/group/remove-members
POST /system/group/{groupID}/manages
POST /system/group/aging

GuestAccount

POST /user/guest
POST /user/guest/bulk
POST /user/guest/conference
POST /user/guest/delete
DELETE /user/guest/{id}
POST /user/guest/{id}/delete
POST /user/guest/{id}/disable
POST /user/guest/{id}/enable
POST /user/guest/{id}/generate-password
POST /user/guest/generate-password-from-template
GET /user/guest
GET /user/guest/{id}
GET /user/guest/count/all
GET /user/guest/count
GET /user/guest/{id}/get-password
POST /user/guest/{id}
POST /user/guest/reset-password
POST /user/guest/send-email
POST /user/guest/send-sms

GuestTemplate

POST /user/guest-template
POST /user/guest-template/delete
DELETE /user/guest-template/{id}
POST /user/guest-template/{id}/delete
GET /user/guest-template
GET /user/guest-template/{id}
GET /user/guest-template/count/all
GET /user/guest-template/count
GET /user/guest-template/{id}/usage
POST /user/guest-template/{id}
GET /user/guest-template/resolve-ip

HostRecord

POST /host/accept-imported-hosts
POST /host
POST /host/delete
DELETE /host/{id}
POST /host/{id}/delete
POST /host/{id}/disable
POST /host/disable-by-ip
POST /host/disable-by-mac
POST /host/{id}/enable
POST /host/enable-by-ip
POST /host/enable-by-mac
GET /host
GET /host/{id}
GET /host/by-ip/{ip}
GET /host/by-mac/{mac}
GET /host/multifilter
GET /host/multifilter/users
GET /host/client-filters/cached/{name}
GET /host/client-filters
GET /host/count/all
GET /host/count
GET /host/device-types
GET /host/global-allowed-hosts
GET /host/{id}/health-history
8/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /host/connected-to-port
GET /host/for-user
GET /host/ncm-pods
GET /host/{id}/usage
GET /host/{id}/policy
POST /host/import-hosts
POST /host/{id}
POST /host/register-as-device
POST /host/{id}/rescan-with-profile
POST /host/scan
GET /host/search
POST /host/send-persistent-agent-message
POST /host/set-expiration
POST /host/{id}/set-health
POST /host/set-logged-on-user
POST /host/set-role
POST /host/{id}/update-persistent-agent

HostRegistrationRequest

POST /host/registration-request/approve
POST /host/registration-request/delete
DELETE /host/registration-request/{id}
POST /host/registration-request/{id}/delete
POST /host/registration-request/deny
GET /host/registration-request
GET /host/registration-request/{id}

L3Scan

GET /device/l3scan/status
POST /device/l3scan/start
POST /device/l3scan/stop

LDAP

POST /settings/integration/ldap
POST /settings/integration/ldap/delete
DELETE /settings/integration/ldap/{id}
POST /settings/integration/ldap/{id}/delete
GET /settings/integration/ldap
GET /settings/integration/ldap/{id}
GET /settings/integration/ldap/count/all
GET /settings/integration/ldap/count
GET /settings/integration/ldap/{id}/usage
POST /settings/integration/ldap/{id}

LogReceiver

POST /settings/integration/log-receiver
POST /settings/integration/log-receiver/delete
GET /settings/integration/log-receiver

LogicalNetwork

POST /policy/logical-network
GET /policy/logical-network/check-reset-to-defaults
POST /policy/logical-network/delete
DELETE /policy/logical-network/{id}
POST /policy/logical-network/{id}/delete
GET /policy/logical-network
GET /policy/logical-network/{id}
GET /policy/logical-network/{id}/usage
POST /policy/logical-network/{id}
POST /policy/logical-network/reset-to-defaults

LogicalNetworkConfiguration

POST /policy/logical-network-configuration
POST /policy/logical-network-configuration/element/properties
POST /policy/logical-network-configuration/batch-upsert
POST /policy/logical-network-configuration/delete
DELETE /policy/logical-network-configuration/{id}
POST /policy/logical-network-configuration/{id}/delete
GET /policy/logical-network-configuration/element/properties

9/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /policy/logical-network-configuration
GET /policy/logical-network-configuration/{id}
GET /policy/logical-network-configuration/{id}/usage
GET /policy/logical-network-configuration/radius
POST /policy/logical-network-configuration/{id}
POST /policy/logical-network-configuration/element/properties/{deviceID}

MDM

POST /settings/integration/mdm
POST /settings/integration/mdm/authenticate
POST /settings/integration/mdm/delete
DELETE /settings/integration/mdm/{id}
POST /settings/integration/mdm/{id}/delete
GET /settings/integration/mdm
GET /settings/integration/mdm/{id}
GET /settings/integration/mdm/{id}/password
GET /settings/integration/mdm/{id}/usage
POST /settings/integration/mdm/{id}
POST /settings/integration/mdm/{id}/poll
POST /settings/integration/mdm/{id}/test

MacExclusion

POST /settings/device/mac-exclusion
POST /settings/device/mac-exclusion/delete
GET /settings/device/mac-exclusion

MessageTemplate

POST /settings/integration/message-template
POST /settings/integration/message-template/delete
DELETE /settings/integration/message-template/{id}
POST /settings/integration/message-template/{id}/delete
GET /settings/integration/message-template
GET /settings/integration/message-template/{id}
GET /settings/integration/message-template/{id}/usage
POST /settings/integration/message-template/{id}
POST /settings/integration/message-template/test

NetworkAddress

POST /settings/device/network-address
POST /settings/device/network-address/delete
DELETE /settings/device/network-address/{id}
POST /settings/device/network-address/{id}/delete
GET /settings/device/network-address
GET /settings/device/network-address/{id}
GET /settings/device/network-address/{id}/usage
POST /settings/device/network-address/{id}

NetworkAddressGroup

POST /settings/device/network-address-group
POST /settings/device/network-address-group/delete
DELETE /settings/device/network-address-group/{id}
POST /settings/device/network-address-group/{id}/delete
GET /settings/device/network-address-group
GET /settings/device/network-address-group/{id}
GET /settings/device/network-address-group/{id}/usage
POST /settings/device/network-address-group/{id}

NetworkDevice

POST /device/pingable
POST /device/snmp
POST /device/delete
DELETE /device/{id}
POST /device/{id}/delete
GET /device
GET /device/{id}
GET /device/count/all
GET /device/count
GET /device/monitor/{id}
GET /device/properties

10/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /device/{id}/usage
POST /device/pingable/{id}
POST /device/snmp/{id}
POST /device/move
POST /device/polling/l3
POST /device/properties
POST /device/monitor/start
POST /device/monitor/{id}/stop

PAPacketTransportConfig

POST /settings/agent/pa-packet-transport-config
POST /settings/agent/pa-packet-transport-config/delete
DELETE /settings/agent/pa-packet-transport-config/{id}
POST /settings/agent/pa-packet-transport-config/{id}/delete
POST /settings/agent/pa-packet-transport-config/deploy
GET /settings/agent/pa-packet-transport-config
GET /settings/agent/pa-packet-transport-config/{id}
GET /settings/agent/pa-packet-transport-config/{id}/usage
GET /settings/agent/pa-packet-transport-config/performance
POST /settings/agent/pa-packet-transport-config/{id}

PatchManagement

POST /settings/integration/patch-management
GET /settings/integration/patch-management
POST /settings/integration/patch-management/properties/big-fix/{id}
POST /settings/integration/patch-management/test/{id}

Policy

POST /policy/endpoint-compliance/custom-scan
POST /policy/endpoint-compliance-configuration
POST /policy/endpoint-compliance
POST /policy/endpoint-compliance/custom-scan/delete
POST /policy/endpoint-compliance-configuration/delete
POST /policy/endpoint-compliance/delete
DELETE /policy/endpoint-compliance-configuration/{id}
DELETE /policy/endpoint-compliance/{id}
POST /policy/endpoint-compliance-configuration/{id}/delete
POST /policy/endpoint-compliance/{id}/delete
POST /policy/endpoint-compliance/{id}/disable
POST /policy/endpoint-compliance/{id}/enable
GET /policy/endpoint-compliance-configuration
GET /policy/endpoint-compliance
GET /policy/endpoint-compliance-configuration/{id}
GET /policy/endpoint-compliance/{id}
GET /policy/endpoint-compliance/custom-scan/html
GET /policy/endpoint-compliance/custom-scan/usage
GET /policy/endpoint-compliance/custom-scan
GET /policy/endpoint-compliance-configuration/{id}/usage
GET /policy/endpoint-compliance/{id}/usage
GET /policy/endpoint-compliance-configuration/supporting-info
GET /policy/endpoint-compliance/supporting-info
POST /policy/endpoint-compliance-configuration/{id}
POST /policy/endpoint-compliance/{id}
POST /policy/endpoint-compliance/custom-scan/global-save
POST /policy/endpoint-compliance/rank/set
POST /policy/endpoint-compliance/rank/swap

Port

GET /device/port-changes
GET /device/port
GET /device/port-changes/{id}
GET /device/port/{id}
GET /device/port-changes/count/all
GET /device/port/count/all
GET /device/port-changes/count
GET /device/port/count
GET /device/port/monitor/{id}
GET /device/port/feature/port-management
GET /device/port/by-device
POST /device/port/properties
POST /device/port/monitor/start

11/615
1/21/22, 11:27 AM FortiNAC REST Schema
POST /device/port/monitor/{id}/stop

PortalPolicy

POST /policy/portal
POST /policy/portal/delete
DELETE /policy/portal/{id}
POST /policy/portal/{id}/delete
POST /policy/portal/{id}/disable
POST /policy/portal/{id}/enable
GET /policy/portal
GET /policy/portal/{id}
GET /policy/portal/supporting-info
POST /policy/portal/{id}
POST /policy/portal/rank/set
POST /policy/portal/rank/swap

Quarantine

GET /settings/device/quarantine
POST /settings/device/quarantine/mark-all-hosts-safe
POST /settings/device/quarantine

RadiusAttributeGroupConfiguration

DELETE /radius/attrgroups/modelcfg/{deviceId}
POST /radius/attrgroups
POST /radius/attrgroups/delete
DELETE /radius/attrgroups/{id}
GET /radius/attrgroups/name/{groupName}
GET /radius/attrgroups/{attrGroupId}
GET /radius/attrgroups/list
GET /radius/attrgroups
GET /radius/attrgroups/modelcfg/{deviceId}
GET /radius/attrgroups/responsevalues/{deviceAttrGrpId}/{logicalNetworkAttrGrpId}
GET /radius/attrgroups/{attrGroupId}/usage
POST /radius/attrgroups/modelcfg/{deviceId}/{attrGroupId}
POST /radius/attrgroups/{id}

RadiusDictionaryConfiguration

POST /radius/dictionary
DELETE /radius/dictionary/{id}
POST /radius/dictionary/delete
GET /radius/dictionary
GET /radius/dictionary/attribute/{name}
POST /radius/dictionary/{id}

RadiusServerConfiguration

POST /radius/config
DELETE /radius/config/{id}
POST /radius/config/delete
POST /radius/config/disable
POST /radius/config/enable
POST /radius/config/nas/fixstale/{id}
GET /radius/config/generateFastPacKey
GET /radius/config
GET /radius/config/global
GET /radius/config/log
GET /radius/config/{id}
GET /radius/config/status
GET /radius/config/eap-types
POST /radius/config/{id}
POST /radius/config/global

Role

POST /policy/role-mapping
POST /policy/role
POST /policy/role-mapping/delete
POST /policy/role/delete
DELETE /policy/role-mapping/{id}
DELETE /policy/role/{id}
POST /policy/role-mapping/{id}/delete

12/615
1/21/22, 11:27 AM FortiNAC REST Schema
POST /policy/role/{id}/delete
GET /policy/role/simple
GET /policy/role-mapping
GET /policy/role
GET /policy/role-mapping/{id}
GET /policy/role/{id}
GET /policy/role-mapping/direct-configuration
GET /policy/role-mapping/{id}/usage
GET /policy/role/{id}/usage
GET /policy/role-mapping/membership
GET /policy/role/supporting-info
GET /policy/role-mapping/supporting-info
POST /policy/role-mapping/{id}
POST /policy/role/{id}
POST /policy/role-mapping/rank/set
POST /policy/role/rank/set
POST /policy/role-mapping/rank/swap
POST /policy/role/rank/swap

SMSProvider

POST /settings/integration/sms
POST /settings/integration/sms/delete
DELETE /settings/integration/sms/{id}
POST /settings/integration/sms/{id}/delete
POST /settings/integration/sms/{id}/disable
POST /settings/integration/sms/{id}/enable
GET /settings/integration/sms
GET /settings/integration/sms/{id}
GET /settings/integration/sms/count/all
GET /settings/integration/sms/count
GET /settings/integration/sms/global/max-length
GET /settings/integration/sms/{id}/usage
POST /settings/integration/sms/{id}
POST /settings/integration/sms/global/max-length

ScanResult

POST /host/scan/archive/create
GET /host/scan/archives
GET /host/scan
GET /host/scan/{id}
GET /host/scan/count/all
GET /host/scan/count
GET /host/scan/archive/import/status
POST /host/scan/archive/import

ScannedApplication

POST /host/scanned-application/delete
DELETE /host/scanned-application/{id}
POST /host/scanned-application/{id}/delete
GET /host/scanned-application
GET /host/scanned-application/{id}
GET /host/scanned-application/{id}/usage
GET /host/scanned-application/for-host
POST /host/scanned-application/threat

Scheduler

POST /system/scheduler/delete
DELETE /system/scheduler/{id}
POST /system/scheduler/{id}/delete
POST /system/scheduler/{id}/disable
POST /system/scheduler/{id}/enable
GET /system/scheduler/activity-types
GET /system/scheduler
GET /system/scheduler/{id}
GET /system/scheduler/count/all
GET /system/scheduler/count
GET /system/scheduler/{name}/running
POST /system/scheduler/run

SecurityEvent

13/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /policy/security-alarm
GET /policy/security-event
GET /policy/security-alarm/{id}
GET /policy/security-event/{id}
GET /policy/security-event-summary/dash-security-hosts-for-alarm
GET /policy/security-event-summary/hosts/remediated
GET /policy/security-alarm/{id}/monitor
GET /policy/security-event/{id}/monitor
GET /policy/security-event-summary/hosts/isolated
GET /policy/security-event-summary/statistics
GET /policy/security-event-summary/alarms/top
GET /policy/security-event-summary/hosts/top
GET /policy/security-event-summary/events/top
POST /policy/security-alarm/monitor/start
POST /policy/security-event/monitor/start
POST /policy/security-alarm/{id}/monitor/stop
POST /policy/security-event/{id}/monitor/stop

SecurityEventParser

POST /settings/integration/security-event-parser
POST /settings/integration/security-event-parser/delete
DELETE /settings/integration/security-event-parser/{id}
POST /settings/integration/security-event-parser/{id}/delete
POST /settings/integration/security-event-parser/disable
POST /settings/integration/security-event-parser/enable
GET /settings/integration/security-event-parser
GET /settings/integration/security-event-parser/{id}
GET /settings/integration/security-event-parser/{id}/usage
GET /settings/integration/security-event-parser/recent-syslog
POST /settings/integration/security-event-parser/{id}
POST /settings/integration/security-event-parser/parse-message
POST /settings/integration/security-event-parser/{id}/test

SecurityRule

POST /policy/security-rule
POST /policy/security-rule-trigger
POST /policy/security-rule/delete
POST /policy/security-rule-trigger/delete
DELETE /policy/security-rule/{id}
DELETE /policy/security-rule-trigger/{id}
POST /policy/security-rule/{id}/delete
POST /policy/security-rule-trigger/{id}/delete
POST /policy/security-rule/{id}/disable
POST /policy/security-rule/{id}/enable
GET /policy/security-rule
GET /policy/security-rule-trigger
GET /policy/security-rule/{id}
GET /policy/security-rule-trigger/{id}
GET /policy/security-rule-trigger/{id}/usage
POST /policy/security-rule/{id}
POST /policy/security-rule-trigger/{id}
POST /policy/security-rule/rank/set
POST /policy/security-rule/rank/swap

SelfRegistration

POST /user/guest-self-registration/{id}/approve
POST /user/guest-self-registration/{id}/deny
GET /user/guest-self-registration
GET /user/guest-self-registration/{id}
GET /user/guest-self-registration/{id}/details

ServerManagement

POST /system/managed-server
GET /system/properties/license
GET /system/managed-server/summary
GET /system/properties/hardware
GET /system/managed-server/{id}/scans
GET /system/managed-server/{id}/properties
POST /system/managed-server/ping
POST /system/managed-server/delete
POST /system/managed-server/{id}/properties

14/615
1/21/22, 11:27 AM FortiNAC REST Schema
POST /system/managed-server/sync

ServiceConnector

GET /system/service-connector

Services

POST /system/ntp

SupplicantPolicy

POST /policy/supplicant-configuration
POST /policy/supplicant
POST /policy/supplicant-configuration/delete
POST /policy/supplicant/delete
DELETE /policy/supplicant-configuration/{id}
DELETE /policy/supplicant/{id}
POST /policy/supplicant-configuration/{id}/delete
POST /policy/supplicant/{id}/delete
POST /policy/supplicant/{id}/disable
POST /policy/supplicant/{id}/enable
GET /policy/supplicant-configuration
GET /policy/supplicant
GET /policy/supplicant-configuration/{id}
GET /policy/supplicant/{id}
GET /policy/supplicant-configuration/{id}/usage
GET /policy/supplicant/supporting-info
GET /policy/supplicant-configuration/supporting-info
POST /policy/supplicant-configuration/{id}
POST /policy/supplicant/{id}
POST /policy/supplicant/rank/set
POST /policy/supplicant/rank/swap

Syslog

POST /settings/integration/syslog
POST /settings/integration/syslog/delete
DELETE /settings/integration/syslog/{id}
POST /settings/integration/syslog/{id}/delete
POST /settings/integration/syslog/{id}/disable
POST /settings/integration/syslog/{id}/enable
GET /settings/integration/syslog
GET /settings/integration/syslog/{id}
GET /settings/integration/syslog/{id}/usage
POST /settings/integration/syslog/{id}

System

POST /system/local-properties/license/apply
POST /system/local-properties/passwords/change
POST /system/debug/elements/attributes/set
POST /system/debug/elements/attributes/delete
GET /system/debug/database/table/data
GET /system/debug/database/tables
GET /system/debug/elements
GET /system/debug/plugin/resources/reloaders
GET /system/debug/database/relations
POST /system/debug/plugin/resources/reload
POST /system/debug/gui/snapshot
GET /system/debug/gui
GET /system/debug/gui/experiments
GET /system/local-properties/license/concurrent
GET /system/local-properties/license
GET /system/debug/elements/attributes
GET /system/debug/log
GET /system/debug/plugin-performance
GET /system/local-properties/hardware
GET /system/local-properties/hardware/performance
GET /system/debug/plugin-status
GET /system/local-properties/software-details
GET /system/local-properties/cluster
GET /system/local-properties/config-status
POST /system/local-properties/cluster/application/primary/restart
POST /system/local-properties/cluster/control/primary/restart

15/615
1/21/22, 11:27 AM FortiNAC REST Schema
POST /system/debug/gui
POST /system/local-properties/system/initialize
POST /system/local-properties/hardware/thresholds
POST /system/debug/plugin

TLSServiceConfiguration

POST /settings/tls-service-configuration
GET /settings/tls-service-configuration/aliases
GET /settings/tls-service-configuration/radiusciphers
POST /settings/tls-service-configuration/delete
DELETE /settings/tls-service-configuration/{id}
POST /settings/tls-service-configuration/{id}/delete
POST /settings/tls-service-configuration/deploy
GET /settings/tls-service-configuration
GET /settings/tls-service-configuration/{id}
GET /settings/tls-service-configuration/{id}/usage
POST /settings/tls-service-configuration/{id}

Task

POST /system/task
POST /system/task/delete
DELETE /system/task/{id}
POST /system/task/{id}/delete
GET /system/task
GET /system/task/{id}
GET /system/task/count/all
GET /system/task/count
GET /system/task/{id}/usage
POST /system/task/{id}

Update

POST /system/update/test

User

POST /user/current-session/accept-usage-policy
POST /user/current-session/bookmark
POST /user/current-session/cache
POST /user/current-session/bookmark/uuid/{uuid}/delete
POST /user/current-session/bookmark/delete
DELETE /user/current-session/bookmark/{id}
POST /user/current-session/bookmark/{id}/delete
GET /user/current-session/bookmark
GET /user/attributes/{name}
GET /user/current-session/feature-visibility
GET /user/current-session/cache
GET /user/current-session/navigation-settings
GET /user/current-session/timeout
GET /user/current-session/securityKey
GET /user/attributes/user/{name}
POST /user/current-session/intialize-root-user
POST /user/current-session/login
POST /user/current-session/logout
POST /user/current-session/bookmark/{id}
POST /user/attributes/{name}
POST /user/current-session/feature-visibility
POST /user/attributes/user/{name}
POST /user/current-session/bookmark/sync

UserHostProfile

POST /policy/user-host-profile
POST /policy/user-host-profile/delete
DELETE /policy/user-host-profile/{id}
POST /policy/user-host-profile/{id}/delete
GET /policy/user-host-profile
GET /policy/user-host-profile/{id}
GET /policy/user-host-profile/{id}/usage
GET /policy/user-host-profile/supporting-info
POST /policy/user-host-profile/{id}

UserRecord

16/615
1/21/22, 11:27 AM FortiNAC REST Schema
POST /user
POST /user/delete
DELETE /user/{id}
POST /user/{id}/delete
POST /user/disable
POST /user/{id}/disable
POST /user/enable
POST /user/{id}/enable
GET /user/{id}/get-agent
GET /user
GET /user/{id}
GET /user/count/all
GET /user/count
GET /user/{id}/usage
GET /user/{id}/get-policy
GET /user/allowed-hosts
POST /user/{id}
POST /user/set-profile
POST /user/set-password
POST /user/set-role
POST /user/allowed-hosts
GET /user/has-hosts

VendorOUI

POST /settings/integration/vendor-oui
POST /settings/integration/vendor-oui/delete
DELETE /settings/integration/vendor-oui/{id}
POST /settings/integration/vendor-oui/{id}/delete
GET /settings/integration/vendor-oui
GET /settings/integration/vendor-oui/{id}
GET /settings/integration/vendor-oui/count/all
GET /settings/integration/vendor-oui/count
GET /settings/integration/vendor-oui/supporting-info
POST /settings/integration/vendor-oui/{id}

VulnerabilityScanner

POST /settings/integration/vulnerability-scanner
POST /settings/integration/vulnerability-scanner/delete
DELETE /settings/integration/vulnerability-scanner/{id}
POST /settings/integration/vulnerability-scanner/{id}/delete
GET /settings/integration/vulnerability-scanner
GET /settings/integration/vulnerability-scanner/{id}
GET /settings/integration/vulnerability-scanner/{id}/usage
GET /settings/integration/vulnerability-scanner/{id}/qualys-appliances
GET /settings/integration/vulnerability-scanner/{id}/scans
POST /settings/integration/vulnerability-scanner/{id}
POST /settings/integration/vulnerability-scanner/{id}/poll
POST /settings/integration/vulnerability-scanner/{id}/test

WebServiceDefinition

POST /settings/security/web-service-definition
POST /settings/security/web-service-definition/delete
DELETE /settings/security/web-service-definition/{id}
POST /settings/security/web-service-definition/{id}/delete
POST /settings/security/web-service-definition/deploy
GET /settings/security/web-service-definition
GET /settings/security/web-service-definition/{id}
GET /settings/security/web-service-definition/{id}/usage
POST /settings/security/web-service-definition/{id}

WinbindConfiguration

POST /winbind/config
DELETE /winbind/config/{id}
POST /winbind/config/delete
POST /winbind/config/disable
POST /winbind/config/enable
GET /winbind/config/all
GET /winbind/config
GET /winbind/config/global
GET /winbind/config/log
GET /winbind/config/{id}

17/615
1/21/22, 11:27 AM FortiNAC REST Schema
GET /winbind/config/status
POST /winbind/config/joinDomain/{id}
POST /winbind/config/{id}

AAAServer

POST /settings/integration/aaa Up
Adds a new AAA Server record to the database (addNewObject40)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AuthServer (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/aaa-mappings/local-domains Up
Adds a new local domain for roaming guests (addRadiusLocalDomain)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
domainName (optional)
Form Parameter —
domainName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/aaa-mappings Up
Adds a new RADIUS Domain Mapping (addRadiusMapping)

Consumes
This API call consumes the following media types via the Content-Type request header:

18/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/x-www-form-urlencoded
multipart/form-data

Form parameters
radiusServer (optional)
Form Parameter —
domainName (optional)
Form Parameter —
radiusServer (optional)
Form Parameter —
domainName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/aaa/delete Up
Deletes the AAA Server record or records supplied, if they are not currently in use (deleteMultiple44)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/aaa-mappings/local-domains/delete Up
Deletes one or more domains from the list of local domains (deleteRadiusLocalDomain)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
domain (optional)
Form Parameter —
domain (optional)
19/615
1/21/22, 11:27 AM FortiNAC REST Schema
( p )
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/aaa-mappings/delete Up
Deletes one or more RADIUS Domain Mappings (deleteRadiusMappings)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DeleteAAAServerMappingsRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/aaa/{id} Up
Deletes the AAA Server record supplied, if it is not currently in use (deleteSingle44)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/aaa/{id}/delete Up
Deletes the AAA Server record supplied, if it is not currently in use (deleteViaPost44)

Path parameters

20/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/aaa Up
Returns all AAA Server records which match the supplied filter (getByFilter54)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AuthServerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuthServerResult

GET /settings/integration/aaa/{id} Up
Returns the AAA Server record with the supplied DBID (getByID51)

Path parameters
id (required)
Path Parameter — format: int64

Return type
AuthServerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuthServerResult

21/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/integration/aaa/count/all Up
Returns the count of all AAA Server records in the database (getCountOfAll17)

Return type
AuthServerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuthServerResult

GET /settings/integration/aaa/count Up
Returns the count of all AAA Server records in the database that match the provided filter (getCountOfFilter17)

Query parameters
filter (optional)
Query Parameter —

Return type
AuthServerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuthServerResult

GET /settings/integration/aaa/{id}/usage Up
Returns a list of records that reference this AAA Server record (getObjectUsage36)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /settings/integration/aaa-mappings/defaults Up
Returns the default RADIUS servers, primary and secondary, to use if there are no mappings (getRadiusDefaults)

Return type
RADIUSDefaultsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.
22/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
RADIUSDefaultsResult

GET /settings/integration/aaa-mappings/local-domains Up
Returns the set of domains configured for roaming guests (getRadiusLocalDomains)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /settings/integration/aaa-mappings Up
Returns all RADIUS Domain Mappings (getRadiusMappings)

Return type
RadiusMappingsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RadiusMappingsResult

GET /settings/integration/aaa/{id}/secret Up
Returns the secret stored for the AAA server (getRadiusServerSecret)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /settings/integration/aaa/{id}/validation-user-password Up
Returns the password stored for the Validation Account user (getRadiusServerValidationAccountPassword)

Path parameters
id (required)

23/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

POST /settings/integration/aaa/{id} Up
Updates an existing AAA Server record in the database (modifyObject40)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AuthServer (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/aaa-mappings/defaults Up
Saves the Primary and Secondary RADIUS servers to use as defaults (saveRadiusDefaults)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
primaryRadiusServer (optional)
Form Parameter —
secondaryRadiusServer (optional)
Form Parameter —
primaryRadiusServer (optional)
Form Parameter —
secondaryRadiusServer (optional)
Form Parameter —

Return type
BaseResult

24/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/aaa-mappings/swap Up
Swaps the priority of two RADIUS Domain Mappings (swapPriority)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AAAServerMapEntry (required)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

AccessConfiguration

POST /policy/access-configuration Up
Creates a new Access Configuration record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject12)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AccessConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/access-configuration/delete Up
Deletes a list of Access Configuration records supplied under the id parameter (deleteMultiple16)
25/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/access-configuration/{id} Up
Deletes a single Access Configuration record by ID (deleteSingle16)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/access-configuration/{id}/delete Up
Deletes a single Access Configuration record by ID (deleteViaPost16)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

26/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /policy/access-configuration Up
Returns a list of Access Configuration records matching the supplied filter (getByFilter21)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AccessConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessConfigurationResult

GET /policy/access-configuration/{id} Up
Returns a list of Access Configuration records matching the supplied filter (getByID21)

Path parameters
id (required)
Path Parameter — format: int64

Return type
AccessConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessConfigurationResult

GET /policy/access-configuration/count/all Up
Returns a total count of all Access Configuration records (getCountOfAll15)

Return type
AccessConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessConfigurationResult

27/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /policy/access-configuration/count Up
Returns a count of Access Configuration records matching the supplied filter (getCountOfFilter15)

Query parameters
filter (optional)
Query Parameter —

Return type
AccessConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessConfigurationResult

GET /policy/access-configuration/{id}/usage Up
Returns a list of records that reference this Access Configuration record (getObjectUsage12)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /policy/access-configuration/supporting-info Up
Returns the information necessary to create an Access Configuration (getSupportingAccessConfigInfo)

Return type
AccessConfigurationSupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessConfigurationSupportingInfoResult

POST /policy/access-configuration/{id} Up
Updates an Access Configuration record, creating it if no record is found with that DBID (modifyObject12)

Path parameters
id (required)
Path Parameter — format: int64

28/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AccessConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

AccessPointManagement

POST /settings/device/access-point-management/ip-ranges Up
Adds a new Ip range (addAccessPointManagementIPRange)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
startIP (required)
Form Parameter —
endIP (required)
Form Parameter —
dbid (required)
Form Parameter — format: int64
startIP (required)
Form Parameter —
endIP (required)
Form Parameter —
dbid (required)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/access-point-management/ip-ranges/{id} Up
Modifies the existing ip ranges (addModifyAccessPointManagementIPRange)

Path parameters
id (required)
29/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
startIP (required)
Form Parameter —
endIP (required)
Form Parameter —
dbid (required)
Form Parameter — format: int64
startIP (required)
Form Parameter —
endIP (required)
Form Parameter —
dbid (required)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/access-point-management/ip-ranges/delete Up
Deletes one or more IP Ranges (deleteAccessPointManagementIPRange)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/device/access-point-management Up
Returns the currently configured Properties (getAccessPointManagement)

30/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
AccessPointManagementResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessPointManagementResult

GET /settings/device/access-point-management/ip-ranges Up
Returns the currently set IP Ranges (getAccessPointManagementIPRanges)

Return type
APMIPRangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
APMIPRangeResult

POST /settings/device/access-point-management Up
Sets the properties (setAccessPointManagement)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
updatePeriod (required)
Form Parameter —
apmEnabled (required)
Form Parameter —
updatePeriod (required)
Form Parameter —
apmEnabled (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

AccessPolicy

POST /policy/access Up
Creates a new Access Policy record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject13)

31/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AccessPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/access/delete Up
Deletes a list of Access Policy records supplied under the id parameter (deleteMultiple17)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/access/{id} Up
Deletes a single Access Policy record by ID (deleteSingle17)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

32/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
BaseResult

POST /policy/access/{id}/delete Up
Deletes a single Access Policy record by ID (deleteViaPost17)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/access/{id}/disable Up
Disables the supplied Access Policy (disableItem5)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/access/{id}/enable Up
Enables the supplied Access Policy (enableItem5)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

33/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /policy/access Up
Returns a list of Access Policy records matching the supplied filter (getByFilter22)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AccessPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessPolicyResult

GET /policy/access/{id} Up
Returns a list of Access Policy records matching the supplied filter (getByID22)

Path parameters
id (required)
Path Parameter — format: int64

Return type
AccessPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessPolicyResult

GET /policy/access/supporting-info Up
Returns the information necessary to create an Access Policy (getSupportingAccessPolicyInfo)

Return type
AccessPolicySupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AccessPolicySupportingInfoResult

34/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /policy/access/{id} Up
Updates an Access Policy record, creating it if no record is found with that DBID (modifyObject13)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AccessPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/access/rank/set Up
Sets the rank of the supplied Access Policy, shifting other ranks as necessary (setRank2)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/access/rank/swap Up
Swaps the rank position of the two supplied Access Policies (swapRanks2)

35/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

AdapterRecord

POST /adapter Up
Adds a new Adapter record to the database (addNewObject2)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DynamicClient (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /adapter/delete Up
Deletes the Adapter record or records supplied, if they are not currently in use (deleteMultiple3)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters

36/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /adapter/{id} Up
Deletes the Adapter record supplied, if it is not currently in use (deleteSingle3)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /adapter/{id}/delete Up
Deletes the Adapter record supplied, if it is not currently in use (deleteViaPost3)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /adapter/{id}/disable Up
Disables the Adapter that matches the supplied DBID (disableItem)

Path parameters
id (required)
Path Parameter — format: int64
37/615
1/21/22, 11:27 AM FortiNAC REST Schema

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /adapter/{id}/enable Up
Enables the Adapter that matches the supplied DBID (enableItem)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /adapter/connected-to-ports Up
Returns a list of adapters connected to the ports provided. (getAdaptersConnectedToPorts)

Query parameters
portID (required)
Query Parameter — format: int64

Return type
AdapterRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdapterRecordResult

GET /adapter/for-host Up
Returns a list of adapters for the host object with the provided id. (getAdaptersForHost)

Query parameters
hostID (required)
Query Parameter — format: int64

Return type
AdapterRecordResult
Produces
38/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdapterRecordResult

GET /adapter Up
Returns all Adapter records which match the supplied filter (getByFilter5)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AdapterRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdapterRecordResult

GET /adapter/{id} Up
Returns the Adapter record with the supplied DBID (getByID5)

Path parameters
id (required)
Path Parameter — format: int64

Return type
AdapterRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdapterRecordResult

GET /adapter/count/all Up
Returns the count of all Adapter records in the database (getCountOfAll4)

Return type
AdapterRecordResult
Produces

39/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdapterRecordResult

GET /adapter/count Up
Returns the count of all Adapter records in the database that match the provided filter (getCountOfFilter4)

Query parameters
filter (optional)
Query Parameter —

Return type
AdapterRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdapterRecordResult

GET /adapter/{id}/usage Up
Returns a list of records that reference this Adapter record (getObjectUsage3)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /adapter/{id}/get-port Up
Returns the port ID that the adapter was most recently connected to. (getPortID)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

40/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
StringResult

POST /adapter/{id} Up
Updates an existing Adapter record in the database (modifyObject2)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DynamicClient (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /adapter/reprofile-rogues Up
Reprofile the rogue devices with the supplied mac addresses (reprofileRogues)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
mac (optional)
Form Parameter —
mac (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /adapter/run-nmap-scan Up
Run an NMAP scan for the adapter by the IP address provided. (runNmapScan)

41/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
ip-address (optional)
Form Parameter —
ip-address (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

AdminProfile

POST /user/admin-profile/mapping Up
Creates a new Admin Profile Mapping record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject10)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AdminProfileMapping (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/admin-profile Up
Creates a new Admin Profile record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject11)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AdminProfile (optional)
Body Parameter —

Return type

42/615
1/21/22, 11:27 AM FortiNAC REST Schema
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/admin-profile/mapping/delete Up
Deletes a list of Admin Profile Mapping records supplied under the id parameter (deleteMultiple14)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/admin-profile/delete Up
Deletes a list of Admin Profile records supplied by the id parameter (deleteMultiple15)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

43/615
1/21/22, 11:27 AM FortiNAC REST Schema

DELETE /user/admin-profile/mapping/{id} Up
Deletes a single Admin Profile Mapping record by ID (deleteSingle14)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /user/admin-profile/{id} Up
Deletes a single Admin Profile record by ID (deleteSingle15)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/admin-profile/mapping/{id}/delete Up
Deletes a single Admin Profile Mapping record by ID (deleteViaPost14)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/admin-profile/{id}/delete Up
Deletes a single Admin Profile record by ID (deleteViaPost15)

44/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /user/admin-profile/mapping Up
Returns a list of Admin Profile Mapping records matching the supplied filter (getByFilter19)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AdminProfileMappingResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdminProfileMappingResult

GET /user/admin-profile Up
Returns a list of Admin Profile records matching the supplied filter (getByFilter20)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AdminProfileResult
Produces

45/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdminProfileResult

GET /user/admin-profile/mapping/{id} Up
Returns a list of Admin Profile Mapping records matching the supplied filter (getByID19)

Path parameters
id (required)
Path Parameter — format: int64

Return type
AdminProfileMappingResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdminProfileMappingResult

GET /user/admin-profile/{id} Up
Returns a list of Admin Profile matching both the ID passed as a parameter, and the supplied filter (getByID20)

Path parameters
id (required)
Path Parameter — format: int64

Return type
AdminProfileResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdminProfileResult

GET /user/admin-profile/new Up
Returns a new, empty Admin Profile that can be used to check the available permission sets (getNewAdminProfile)

Return type
AdminProfileResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdminProfileResult

46/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /user/admin-profile/{id}/usage Up
Returns a list of records that reference this Admin Profile record by ID (getObjectUsage11)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /user/admin-profile/permission-view-map Up
Returns a map of Permission Sets to Views (getPermissionViewMap)

Return type
PermissionViewMap
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PermissionViewMap

GET /user/admin-profile/mapping/supporting-info Up
Retrieves information necessary to create or modify an Admin Profile Mapping (getSupportingInfo)

Return type
AdminProfileMappingSupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AdminProfileMappingSupportingInfoResult

POST /user/admin-profile/mapping/{id} Up
Updates an Admin Profile Mapping record, creating it if no record is found with that DBID (modifyObject10)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

47/615
1/21/22, 11:27 AM FortiNAC REST Schema
Request body
body AdminProfileMapping (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /user/admin-profile/{id} Up
Updates, or creates, an Admin Profile record with the supplied ID and values (modifyObject11)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AdminProfile (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/admin-profile/mapping/rank/set Up
Sets the rank of the supplied Admin Profile Mapping, shifting other ranks as necessary (setRank1)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

48/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/admin-profile/mapping/rank/swap Up
Swaps the rank position of the two supplied Admin Profile Mappings (swapRanks1)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Aging

POST /host/aging/clear-registered Up
Clear Aging values for all registered and guest hosts (clearRegistered)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/aging/clear-unregistered Up
Clear Aging values for all unregistered ( rogue ) hosts (clearUnRegistered)

49/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/aging/clear-users Up
Clear Aging values for all Users (clearUsers)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host/aging Up
Returns the currently configured Host Aging Settings (getLogReceivers)

Return type
AgingSettingsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AgingSettingsResult

POST /host/aging Up
Adds or modifies the Host Aging Settings (setAgingSettings)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
registeredHostValidTime (required)
Form Parameter — format: int64
registeredHostInactiveTime (required)
Form Parameter — format: int64
unregHostValidTime (required)
Form Parameter — format: int64
unregHostInactiveTime (required)
Form Parameter — format: int64
userValidTime (required)
Form Parameter — format: int64
userInactiveTime (required)
50/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter — format: int64
deleteRegHostsWithUser (required)
Form Parameter —
registeredHostValidTime (required)
Form Parameter — format: int64
registeredHostInactiveTime (required)
Form Parameter — format: int64
unregHostValidTime (required)
Form Parameter — format: int64
unregHostInactiveTime (required)
Form Parameter — format: int64
userValidTime (required)
Form Parameter — format: int64
userInactiveTime (required)
Form Parameter — format: int64
deleteRegHostsWithUser (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Alarm

POST /logging/alarm/acknowledge Up
Marks one or more alarms as Acknowledged, resolving any applied actions actions (acknowledgeAlarms)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/alarm/{id}/acknowledge Up
Marks an alarm as Acknowledged, resolving any applied actions actions (acknowledgeSingleAlarm)

Path parameters
51/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/alarm/delete Up
Deletes the Alarm record or records supplied, if they are none are currently in use (deleteMultiple11)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /logging/alarm/{id} Up
Deletes the Alarm record supplied, if it is not currently in use (deleteSingle11)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/alarm/{id}/delete Up

52/615
1/21/22, 11:27 AM FortiNAC REST Schema
Deletes the Alarm record supplied, if it is not currently in use (deleteViaPost11)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /logging/alarm/archive Up
Returns the names of all alarm archives currently on the system (getAlarmArchiveNames)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /logging/alarm/supporting-info Up
Returns the information related to displaying alarms (getAlarmPanelSupportingData)

Return type
AlarmSupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AlarmSupportingInfoResult

GET /logging/alarm Up
Returns all Alarm records which match the supplied filter (getByFilter14)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —
53/615
1/21/22, 11:27 AM FortiNAC REST Schema

Return type
YamsAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
YamsAlarmResult

GET /logging/alarm/{id} Up
Returns the Alarm record with the supplied DBID (getByID14)

Path parameters
id (required)
Path Parameter — format: int64

Return type
YamsAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
YamsAlarmResult

GET /logging/alarm/count/all Up
Returns the count of all Alarm records in the database (getCountOfAll10)

Return type
YamsAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
YamsAlarmResult

GET /logging/alarm/count Up
Returns a count of Alarm records matching the supplied filter (getCountOfFilter10)

Query parameters
filter (optional)
Query Parameter —

Return type
YamsAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

54/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
YamsAlarmResult

GET /logging/alarm/archive/import/status Up
Returns the status of the most recent alarm archive import (getImportArchiveStatus1)

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /logging/alarm/monitor/{id} Up
Gets all changes to Alarm records since the Alarms were last polled (getMonitorChanges3)

Path parameters
id (required)
Path Parameter — format: int64

Return type
ContainerChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ContainerChangeResult

GET /logging/alarm/{id}/usage Up
Returns a list of records that reference this Alarm record (getObjectUsage8)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /logging/alarm/archive/import Up
Imports an alarm archive from the filesystem back into the database (importArchive1)

55/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
name (optional)
Form Parameter —
name (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/alarm/monitor/start Up
Begins collecting changes made to Alarm records matching the supplied filter (startMonitorPolling3)

Return type
ContainerMonitorResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ContainerMonitorResult

POST /logging/alarm/monitor/{id}/stop Up
Stops collecting changes made to Alarm records for the specified monitor (stopMonitorPolling3)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

AuditLog

GET /logging/audit/count Up
Returns a count of the total number of audit logs (getAuditLogCount)

56/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query parameters
filter (optional)
Query Parameter —

Return type
NumberResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NumberResult

GET /logging/audit Up
Returns all of the matching audit logs. Includes a hash of DBID to name mappings per record type. (getAuditLogs)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AuditLogResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuditLogResult

AuthenticationConfiguration

POST /policy/authentication-configuration Up
Creates a new Authentication Configuration record, updating instead if the supplied profile has a DBID of one that already exists
(addNewObject14)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AuthenticationConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces

57/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/authentication-configuration/delete Up
Deletes a list of Authentication Configuration records supplied under the id parameter (deleteMultiple18)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/authentication-configuration/{id} Up
Deletes a single Authentication Configuration record by ID (deleteSingle18)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/authentication-configuration/{id}/delete Up
Deletes a single Authentication Configuration record by ID (deleteViaPost18)

Path parameters
id (required)
Path Parameter — format: int64

58/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/authentication-configuration Up
Returns a list of Authentication Configuration records matching the supplied filter (getByFilter23)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AuthenticationConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuthenticationConfigurationResult

GET /policy/authentication-configuration/{id} Up
Returns a list of Authentication Configuration records matching the supplied filter (getByID23)

Path parameters
id (required)
Path Parameter — format: int64

Return type
AuthenticationConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuthenticationConfigurationResult

GET /policy/authentication-configuration/{id}/usage Up
Returns a list of records that reference this Authentication Configuration record (getObjectUsage13)

59/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /policy/authentication-configuration/{id} Up
Updates an Authentication Configuration record, creating it if no record is found with that DBID (modifyObject14)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AuthenticationConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

AuthenticationPolicy

POST /policy/authentication Up
Creates a new Authentication Policy record, updating instead if the supplied policy has a DBID of one that already exists (addNewObject15)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AuthenticationPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces

60/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/authentication/delete Up
Deletes a list of Authentication Policy records supplied under the id parameter (deleteMultiple19)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/authentication/{id} Up
Deletes a single Authentication Policy record by ID (deleteSingle19)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/authentication/{id}/delete Up
Deletes a single Authentication Policy record by ID (deleteViaPost19)

Path parameters
id (required)
Path Parameter — format: int64

61/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/authentication/{id}/disable Up
Disables the supplied Authentication Policy (disableItem6)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/authentication/{id}/enable Up
Enables the supplied Authentication Policy (enableItem6)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/authentication Up
Returns a list of Authentication Policy records matching the supplied filter (getByFilter24)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)

62/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
AuthenticationPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuthenticationPolicyResult

GET /policy/authentication/{id} Up
Returns a list of Authentication Policy records matching the supplied filter (getByID24)

Path parameters
id (required)
Path Parameter — format: int64

Return type
AuthenticationPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
AuthenticationPolicyResult

POST /policy/authentication/{id} Up
Updates an Authentication Policy record, creating it if no record is found with that DBID (modifyObject15)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body AuthenticationPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

63/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /policy/authentication/rank/set Up
Sets the rank of the supplied Authentication Policy, shifting other ranks as necessary (setRank3)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/authentication/rank/swap Up
Swaps the rank position of the two supplied Authentication Policies (swapRanks3)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

BackgroundTask

64/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /system/background-task Up
Adds a new BackgroundTask record to the database (addNewObject47)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body BackgroundTask (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/background-task/delete Up
Deletes the BackgroundTask record or records supplied (deleteMultiple51)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /system/background-task Up
Returns all BackgroundTask records which match the supplied filter (getByFilter61)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)

65/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
BackgroundTaskResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BackgroundTaskResult

GET /system/background-task/{id} Up
Returns the BackgroundTask record with the supplied DBID (getByID58)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BackgroundTaskResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BackgroundTaskResult

GET /system/background-task/current-user Up
Returns all tasks assigned to or created by the current user (getMyTasks)

Query parameters
includeAssigner (optional)
Query Parameter —
includeDescendants (optional)
Query Parameter —

Return type
BackgroundTaskResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BackgroundTaskResult

POST /system/background-task/{id}/complete Up
Marks a BackgroundTask record as completed (modifyObject47)

Path parameters
id (required)
66/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/background-task/{id} Up
Updates an existing BackgroundTask record in the database (modifyObject48)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body BackgroundTask (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

BackupConfiguration

GET /system/backup/configuration/ftp Up
Returns the FTP remote backup configuration settings (getFTPConfiguration)

Return type
FTPBackupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FTPBackupResult

GET /system/backup/configuration/ssh Up
Returns the FTP remote backup configuration settings (getSSHConfiguration)

67/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
SSHBackupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SSHBackupResult

POST /system/backup/configuration/ftp Up
Returns the FTP remote backup configuration settings (setFTPConfiguration)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body FTPBackupRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/backup/configuration/ssh Up
Returns the SSH remote backup configuration settings (setSSHConfiguration)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SSHBackupRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

BackupSettings

68/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /system/backup-settings/archives Up
Returns the currently configured database archive settings (getDatabaseArchiveSettings)

Return type
BackupSettingsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BackupSettingsResult

GET /system/backup-settings/database/archive Up
Returns a list of available local backups (getDatabaseArchives)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /system/backup-settings/database Up
Returns the currently configured database backup settings (getDatabaseBackupSettings)

Return type
DatabaseBackupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DatabaseBackupResult

GET /system/backup-settings/system-backup Up
Returns the currently configured system backup settings (getSystemBackupSettings)

Return type
SystemBackupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SystemBackupResult

POST /system/backup-settings/database/restore-archives Up
69/615
1/21/22, 11:27 AM FortiNAC REST Schema

Restore the Database Archives (restoreDBArchive)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
archiveName (required)
Form Parameter —
backupDays (required)
Form Parameter —
archiveName (required)
Form Parameter —
backupDays (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/backup-settings/database Up
Sets the Database backup settings (setDatabaseArchiveSettings)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
archiveName (required)
Form Parameter —
backupDays (required)
Form Parameter —
archiveName (required)
Form Parameter —
backupDays (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/backup-settings/archives Up
Add Database Archive settings (setDatabaseArchiveSettings1)

70/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
dbArchiveBackupDays (required)
Form Parameter —
evtAlarmAgeTime (required)
Form Parameter —
scanResultsAgeTime (required)
Form Parameter —
connectionAgeTime (required)
Form Parameter —
dbArchiveBackupDays (required)
Form Parameter —
evtAlarmAgeTime (required)
Form Parameter —
scanResultsAgeTime (required)
Form Parameter —
connectionAgeTime (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/backup-settings/system-backup Up
Sets the System Backup settings (setDatabaseArchiveSettings2)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
systemBackupDays (required)
Form Parameter —
systemBackupDays (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Certificate

71/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/security/certificate-server/copy Up
Copies an uploaded certificate from one target to another (copyCertificate)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
sourceCert (optional)
Form Parameter —
targetCert (optional)
Form Parameter —
sourceCert (optional)
Form Parameter —
targetCert (optional)
Form Parameter —

Return type
CertificateUploadResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
CertificateUploadResult

POST /settings/security/certificate-server/{name}/deleteServerCert Up
Deletes server certificate at the specified target (deleteServerCert)

Path parameters
name (required)
Path Parameter —

Return type
CertificateDeleteResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
CertificateDeleteResult

POST /settings/security/certificate-server/{name}/delete Up
Deletes trusted client root CA certificates by SHA1 fingerprint from the trust store at the specified target name (deleteTrustedCaCert)

Path parameters
name (required)
Path Parameter —

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

72/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
fingerprint (optional)
Form Parameter —
fingerprint (optional)
Form Parameter —

Return type
CertificateDeleteResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
CertificateDeleteResult

POST /settings/security/certificate-server/csr/generate Up
Generates a Certificate Signing Request for the upload target (generateCSR)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body GenerateCSRParameters (required)
Body Parameter —

Return type
GenerateCSRResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GenerateCSRResult

GET /settings/security/certificate-server Up
Returns all certificates uploaded to this server (getAllCerts)

Query parameters
type (optional)
Query Parameter —

Return type
ServerCertificatesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ServerCertificatesResult

73/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/security/certificate-server/restart Up
Restarts the processeses associated with the target certificate (restartCertificateService)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
target (optional)
Form Parameter —
target (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/security/certificate-server/{name} Up
Upload a certificate chain and optional private key to the specified target name. Uploading certificates to a trust store adds them to the list of
trusted certificates. If (uploadCertificate)

Path parameters
name (required)
Path Parameter —

Consumes
This API call consumes the following media types via the Content-Type request header:

multipart/form-data

Form parameters
targetType (optional)
Form Parameter —
privateKeyType (optional)
Form Parameter —
certs (optional)
Form Parameter —
privateKey (optional)
Form Parameter —

Return type
CertificateUploadResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
CertificateUploadResult

ConnectionLog

74/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /logging/connection/archive Up
Returns the name of all connection log archives currently on the system (getArchiveNames1)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /logging/connection Up
Returns all Connection Log records which match the supplied filter (getByFilter15)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
DynamicClientEntryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DynamicClientEntryResult

GET /logging/connection/{id} Up
Returns the Connection Log record with the supplied DBID (getByID15)

Path parameters
id (required)
Path Parameter — format: int64

Return type
DynamicClientEntryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DynamicClientEntryResult

75/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /logging/connection/count/all Up
Returns the count of all Connection Log records in the database (getCountOfAll11)

Return type
DynamicClientEntryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DynamicClientEntryResult

GET /logging/connection/count Up
Returns the count of Connection Log records specified by the provided filter. (getCountOfFilter11)

Query parameters
filter (optional)
Query Parameter —

Return type
DynamicClientEntryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DynamicClientEntryResult

GET /logging/connection/archive/import/status Up
Returns the status of the most recent connection log archive import (getImportArchiveStatus2)

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /logging/connection/top/users/connected-time Up
Returns the top number of users by most connected time (getTopUsersByTime)

Query parameters
numUsers (optional)
Query Parameter — format: int32
filter (optional)
Query Parameter —

Return type
DynamicClientSummaryResult

76/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DynamicClientSummaryResult

POST /logging/connection/archive/import Up
Imports a collection log archive from the filesystem back into the database (importArchive2)

Consumes
This API call consumes the following media types via the Content-Type request header:

multipart/form-data
application/x-www-form-urlencoded

Form parameters
fileName (optional)
Form Parameter —
fileName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Container

POST /device/container Up
Adds a new Container record to the database (addNewObject)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body TopologyContainerRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

77/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /device/container/delete Up
Deletes the Container record or records supplied, if they are not currently in use (deleteMultiple1)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /device/container/{id} Up
Deletes the Container record supplied, if it is not currently in use (deleteSingle1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/container/{id}/delete Up
Deletes the Container record supplied, if it is not currently in use (deleteViaPost1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

78/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

GET /device/container Up
Returns all Container records which match the supplied filter (getByFilter3)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
TopologyContainerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TopologyContainerResult

GET /device/container/{id} Up
Returns the Container record with the supplied DBID (getByID3)

Path parameters
id (required)
Path Parameter — format: int64

Return type
TopologyContainerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TopologyContainerResult

GET /device/container/count/all Up
Returns the count of all Container records in the database (getCountOfAll3)

Return type
TopologyContainerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

79/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
TopologyContainerResult

GET /device/container/count Up
Returns a count of Container records matching the supplied filter (getCountOfFilter3)

Query parameters
filter (optional)
Query Parameter —

Return type
TopologyContainerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TopologyContainerResult

GET /device/container/monitor/{id} Up
Gets all changes to Container records since the Events were last polled (getMonitorChanges2)

Path parameters
id (required)
Path Parameter — format: int64

Return type
ContainerChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ContainerChangeResult

GET /device/container/{id}/usage Up
Returns a list of Container records that reference this record (getObjectUsage1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

80/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /device/container/{id} Up
Updates an existing Container record in the database (modifyObject)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body TopologyContainerRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/container/monitor/start Up
Begins collecting changes made to Container records matching the supplied filter (startMonitorPolling2)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body ManagedElementWatcherSpecification (optional)
Body Parameter —

Return type
ContainerMonitorResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ContainerMonitorResult

POST /device/container/monitor/{id}/stop Up
Stops collecting changes made to Container records for the specified monitor (stopMonitorPolling2)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult

81/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Dashboard

POST /user/dashboard Up
Creates a new User Dashboard record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject48)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body UserDashboard (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/dashboard/delete Up
Deletes a list of User Dashboard records supplied under the id parameter (deleteMultiple52)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

82/615
1/21/22, 11:27 AM FortiNAC REST Schema

DELETE /user/dashboard/{id} Up
Deletes a single User Dashboard record by ID (deleteSingle51)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/dashboard/{id}/delete Up
Deletes a single User Dashboard record by ID (deleteViaPost51)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /user/dashboard/agent-summary Up
(getAgentSummaryData)

Return type
ObjectMapResultListNameValue
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ObjectMapResultListNameValue

GET /user/dashboard Up
Returns a list of User Dashboard records matching the supplied filter owned by the currently logged on user (getByFilter62)

Query parameters
filter (optional)
Query Parameter —
start (optional)

83/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
UserDashboardResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserDashboardResult

GET /user/dashboard/{id} Up
Returns a list of User Dashboard records matching the supplied filter (getByID59)

Path parameters
id (required)
Path Parameter — format: int64

Return type
UserDashboardResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserDashboardResult

GET /user/dashboard/device-summary Up
(getDeviceSummaryData)

Return type
ObjectListResultNetworkDeviceSummaryType
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ObjectListResultNetworkDeviceSummaryType

GET /user/dashboard/device-summary/device/{tag}/{status} Up
(getDeviceSummaryDetails)

Path parameters
tag (required)
Path Parameter —
status (required)

84/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path Parameter — format: byte

Return type
ObjectListResultNetworkDeviceSummaryDetails
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ObjectListResultNetworkDeviceSummaryDetails

GET /user/dashboard/device-summary/port/offline Up
(getDeviceSummaryPortOfflineDetails)

Return type
ObjectListResultNetworkDeviceSummaryDetails
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ObjectListResultNetworkDeviceSummaryDetails

GET /user/dashboard/device-summary/port/online Up
(getDeviceSummaryPortOnlineDetails)

Return type
ObjectListResultNetworkDeviceSummaryDetails
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ObjectListResultNetworkDeviceSummaryDetails

GET /user/dashboard/host-summary Up
(getHostSummaryData)

Return type
HostSummaryDataResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostSummaryDataResult

GET /user/dashboard/{id}/usage Up
Returns a list of records that reference this User Dashboard record (getObjectUsage42)

85/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /user/dashboard/scan-summary/per-day Up
Returns a summary of the number of scans per hour over a date range, grouped by the start of the hour (getScanSummaryDataPerDay)

Query parameters
startDate (required)
Query Parameter — format: int64
endDate (required)
Query Parameter — format: int64
type (optional)
Query Parameter — format: int32
platform (optional)
Query Parameter —
scan (optional)
Query Parameter —

Return type
ObjectListResultScanSummaryType
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ObjectListResultScanSummaryType

GET /user/dashboard/scan-summary/per-hour Up
Returns a summary of the number of scans per hour over a date range, grouped by the start of the hour (getScanSummaryDataPerHour)

Query parameters
startDate (required)
Query Parameter — format: int64
endDate (required)
Query Parameter — format: int64
type (optional)
Query Parameter — format: int32
platform (optional)
Query Parameter —
scan (optional)
Query Parameter —

Return type
ObjectListResultScanSummaryType
Produces

86/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ObjectListResultScanSummaryType

GET /user/dashboard/user-summary Up
(getUserSummaryData)

Return type
UserSummaryDataResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserSummaryDataResult

POST /user/dashboard/{id} Up
Updates an User Dashboard record, creating it if no record is found with that DBID (modifyObject49)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body UserDashboard (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /user/dashboard/{id}/resetToDefault Up
Resets the Dashboard Tiles to default if the currently logged on user owns that dashboard (resetDashboardToDefault)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BooleanResult

87/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

POST /user/dashboard/rank/set Up
Sets the rank of the supplied User Dashboard, shifting other ranks as necessary (setRank11)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DeviceIdentity

POST /host/device-identity Up
Adds a new Device Identity record to the database (addNewObject3)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DeviceIdentity (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
88/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

POST /host/device-identity/confirm-rule Up
Confirms a rule in Profiled Devices view (confirmRule)

Consumes
This API call consumes the following media types via the Content-Type request header:

multipart/form-data
application/x-www-form-urlencoded

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

POST /host/device-identity/delete Up
Deletes the Device Identity record or records supplied, if they are not currently in use (deleteMultiple4)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /host/device-identity/{id} Up
Deletes the Device Identity record supplied, if it is not currently in use (deleteSingle4)

Path parameters
id (required)
Path Parameter — format: int64

89/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-identity/{id}/delete Up
Deletes the Device Identity record supplied, if it is not currently in use (deleteViaPost4)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host/device-identity Up
Returns all Device Identity records which match the supplied filter (getByFilter6)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
FingerprintResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FingerprintResult

GET /host/device-identity/{id} Up
Returns the Device Identity record that matches the supplied DBID (getByID6)

90/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Return type
FingerprintResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FingerprintResult

GET /host/device-identity/count/all Up
Returns the count of all Device Identity records in the database (getCountOfAll5)

Return type
FingerprintResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FingerprintResult

GET /host/device-identity/count Up
Gets a count of Device Identity records that match the provided filter. (getCountOfFilter5)

Query parameters
filter (optional)
Query Parameter —

Return type
FingerprintResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FingerprintResult

GET /host/device-identity/fingerprints Up
Returns the full Fingerprint information, including attributes, for a specified fingerprint (getFingerprintByID)

Query parameters
ids (optional)
Query Parameter — format: int64

Return type
Fingerprint
Produces

91/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Fingerprint response
Fingerprint

GET /host/device-identity/fingerprint/{id} Up
Returns the full Fingerprint information, including attributes, for a specified fingerprint (getFingerprintByID1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
Fingerprint
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Fingerprint response
Fingerprint

GET /host/device-identity/{id}/usage Up
Returns a list of records that reference this Device Identity record (getObjectUsage4)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /host/device-identity/{id} Up
Updates an existing Device Identity record in the database (modifyObject3)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DeviceIdentity (optional)

92/615
1/21/22, 11:27 AM FortiNAC REST Schema
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DeviceIdentitySource

POST /host/device-identity-source Up
Creates a new Device Identity Source record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject6)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body FingerprintSource (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-identity-source/delete Up
Deletes a list of Device Identity Source records supplied under the id parameter (deleteMultiple7)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

93/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
BaseResult

DELETE /host/device-identity-source/{id} Up
Deletes a single Device Identity Source record by ID (deleteSingle7)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-identity-source/{id}/delete Up
Deletes a single Device Identity Source record by ID (deleteViaPost7)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-identity-source/{id}/disable Up
Disables the supplied Device Identity Source (disableItem2)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

94/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /host/device-identity-source/{id}/enable Up
Enables the supplied Device Identity Source (enableItem2)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host/device-identity-source Up
Returns a list of Device Identity Source records matching the supplied filter (getByFilter9)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
FingerprintSourceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FingerprintSourceResult

GET /host/device-identity-source/{id} Up
Returns a list of Device Identity Source records matching the supplied filter (getByID9)

Path parameters
id (required)
Path Parameter — format: int64

Return type
FingerprintSourceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

95/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
FingerprintSourceResult

POST /host/device-identity-source/{id} Up
Updates an Device Identity Source record, creating it if no record is found with that DBID (modifyObject6)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body FingerprintSource (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /host/device-identity-source/rank/set Up
Sets the rank of the supplied Device Identity Source, shifting other ranks as necessary (setRank)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

96/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /host/device-identity-source/rank/swap Up
Swaps the rank position of the two supplied Device Identity Sources (swapRanks)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DeviceProfiler

GET /DeviceProfiler/Rule/export Up
Exports the configured Device Profiler rules as a download (exportDPCRules)

Return type
DpcRules
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/octet-stream

Responses
default
Default Response Value
DpcRules

GET /settings/device/device-profiler Up
Returns the currently configured Device Profiler settings (getDeviceProfilerProperties)

Return type
DeviceProfilerPropertiesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DeviceProfilerPropertiesResult

97/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/device/device-profiler Up
Adds a new device profiler configuration (setDeviceProfilerProperties)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
createRogues (optional)
Form Parameter —
disablePing (optional)
Form Parameter —
collectEnabled (optional)
Form Parameter —
collectUrl (optional)
Form Parameter —
queryUrl (optional)
Form Parameter —
createRogues (optional)
Form Parameter —
disablePing (optional)
Form Parameter —
collectEnabled (optional)
Form Parameter —
collectUrl (optional)
Form Parameter —
queryUrl (optional)
Form Parameter —

Return type
DeviceProfilerPropertiesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DeviceProfilerPropertiesResult

DeviceProfilingRule

POST /host/device-profiling-rule Up
Adds a new Device Profiling Rule record to the database (addNewObject4)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DpcRule (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

98/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-profiling-rule/delete Up
Deletes the Device Profiling Rule record or records supplied, if they are not currently in use (deleteMultiple5)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /host/device-profiling-rule/{id} Up
Deletes the Device Profiling Rule record supplied, if it is not currently in use (deleteSingle5)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-profiling-rule/{id}/delete Up
Deletes the Device Profiling Rule record supplied, if it is not currently in use (deleteViaPost5)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult

99/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-profiling-rule/{id}/disable Up
Disables the Device Profiling Rule that matches the supplied DBID (disableItem1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-profiling-rule/{id}/enable Up
Enables the Device Profiling Rule that matches the supplied DBID (enableItem1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host/device-profiling-rule Up
Returns all Device Profiling Rule records which match the supplied filter (getByFilter7)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)

100/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter —

Return type
DpcRuleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DpcRuleResult

GET /host/device-profiling-rule/{id} Up
Returns the Device Profiling Rule record with the supplied DBID (getByID7)

Path parameters
id (required)
Path Parameter — format: int64

Return type
DpcRuleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DpcRuleResult

GET /host/device-profiling-rule/count/all Up
Returns the count of all Device Profiling Rule records in the database (getCountOfAll6)

Return type
DpcRuleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DpcRuleResult

GET /host/device-profiling-rule/count Up
Returns the count of all Device Profiling Rule records in the database that match the provided filter (getCountOfFilter6)

Query parameters
filter (optional)
Query Parameter —

Return type
DpcRuleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

101/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
DpcRuleResult

GET /host/device-profiling-rule/create-from-adapter Up
Returns the potential contents of a new Device Profiling Rule created from an existing adapter. This is not automatically added to the database.
(getDpcRuleDataForAdapter)

Query parameters
macAddress (required)
Query Parameter —

Return type
DpcRuleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DpcRuleResult

GET /host/device-profiling-rule/{id}/usage Up
Returns a list of Device Profiling Rule records that reference this record (getObjectUsage5)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /host/device-profiling-rule/queue Up
Returns the number of MAC addresses currently queued to be profiled (getScanQueueSize)

Return type
NumberResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NumberResult

POST /host/device-profiling-rule/{id} Up

102/615
1/21/22, 11:27 AM FortiNAC REST Schema
Updates an existing Device Profiling Rule record in the database (modifyObject4)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DpcRule (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-profiling-rule/scan Up
Queues all unprofiled rogues to be scanned for matching Device Profiling Rules (profileRogues)

Return type
NumberResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NumberResult

POST /host/device-profiling-rule/swap-rule-ranks Up
Swaps the ranks of two Device Profiling Rules with provided database ids (swapRuleRank)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult

103/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/device-profiling-rule/test Up
Tests to see if the Device Profiling Rule with the supplied name would match the supplied adapter (testDpcRuleDataForAdapter)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
ruleName (optional)
Form Parameter —
macAddress (optional)
Form Parameter —
ruleName (optional)
Form Parameter —
macAddress (optional)
Form Parameter —

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

DeviceType

POST /settings/device/device-type Up
Creates a new Device Type record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject33)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DeviceType (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
104/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

POST /settings/device/device-type/createFromArchive Up
Creates a new Device Type record, and assigns it an image from the image archive (addNewObjectFromArchive)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
name (optional)
Form Parameter —
imageName (optional)
Form Parameter —
name (optional)
Form Parameter —
imageName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/device-type/delete Up
Deletes a list of Device Type records supplied under the id parameter (deleteMultiple37)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/device/device-type/{id} Up
Deletes a single Device Type record by ID (deleteSingle37)

105/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/device-type/{id}/delete Up
Deletes a single Device Type record by ID (deleteViaPost37)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/device/device-type/image/archive Up
Returns the images currently uploaded to the system (getArchiveImages)

Return type
UploadedImageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UploadedImageResult

GET /settings/device/device-type Up
Returns a list of Device Type records matching the supplied filter (getByFilter47)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)

106/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
DeviceTypeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DeviceTypeResult

GET /settings/device/device-type/{id} Up
Returns a list of Device Type records matching the supplied filter (getByID44)

Path parameters
id (required)
Path Parameter — format: int64

Return type
DeviceTypeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DeviceTypeResult

GET /settings/device/device-type/{id}/usage Up
Returns a list of records that reference this Device Type record (getObjectUsage29)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/device/device-type/{id} Up
Updates an Device Type Device Type record, creating it if no record is found with that DBID (modifyObject33)

Path parameters
id (required)
Path Parameter — format: int64

107/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DeviceType (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

DirectoryAgentConfig

POST /settings/agent/directory-agent/subnet Up
Adds a new IP range or subnet to allow for the Directory Agent Configurations (addIPRange)

Consumes
This API call consumes the following media types via the Content-Type request header:

multipart/form-data
application/x-www-form-urlencoded

Form parameters
startIP (optional)
Form Parameter —
endIP (optional)
Form Parameter —
startIP (optional)
Form Parameter —
endIP (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/agent/directory-agent Up
Creates a new Directory Agent Configurations record, updating instead if the supplied profile has a DBID of one that already exists
(addNewObject31)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
108/615
1/21/22, 11:27 AM FortiNAC REST Schema

body DirectoryAgentConfiguration (optional)

Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/agent/directory-agent/subnet/delete Up
Deletes the subnet or subnets from the set of configured IP ranges (deleteIPRanges)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body IPRange (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/agent/directory-agent/delete Up
Deletes a list of Directory Agent Configuration records supplied under the id parameter (deleteMultiple35)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

109/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

DELETE /settings/agent/directory-agent/{id} Up
Deletes a single Directory Agent Configuration record by ID (deleteSingle35)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/agent/directory-agent/{id}/delete Up
Deletes a single Directory Agent Configuration record by ID (deleteViaPost35)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/agent/directory-agent/{id}/disable Up
Disables the supplied Directory Agent Configuration (disableItem11)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

110/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/agent/directory-agent/{id}/enable Up
Enables the supplied Directory Agent Configuration (enableItem11)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/agent/directory-agent/groups Up
Returns all Device Groups for use when creating Directory Agent Configurations (getAllClientGroups)

Return type
NameIDObjectListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NameIDObjectListResult

GET /settings/agent/directory-agent Up
Returns a list of Directory Agent Configurations records matching the supplied filter (getByFilter45)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
DirectoryAgentConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DirectoryAgentConfigurationResult

111/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/agent/directory-agent/{id} Up
Returns a list of Directory Agent Configuration records matching the supplied filter (getByID42)

Path parameters
id (required)
Path Parameter — format: int64

Return type
DirectoryAgentConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DirectoryAgentConfigurationResult

GET /settings/agent/directory-agent/directory-groups Up
Returns all Device Groups for use when creating Directory Agent Configurations (getDirGroupNames)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /settings/agent/directory-agent/subnet Up
Returns all currently IP ranges currently configured for the Directory Agent Configurations (getIPRanges)

Return type
IPRangeListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
IPRangeListResult

GET /settings/agent/directory-agent/{id}/usage Up
Returns a list of records that reference this Directory Agent Configuration record (getObjectUsage27)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.
112/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/agent/directory-agent/{id} Up
Updates an Directory Agent Configurations record, creating it if no record is found with that DBID (modifyObject31)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DirectoryAgentConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /settings/agent/directory-agent/rank/set Up
Sets the rank of the supplied Directory Agent Configuration, shifting other ranks as necessary (setRank10)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
113/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
BaseResult

POST /settings/agent/directory-agent/rank/swap Up
Swaps the rank position of the two supplied Directory Agent Configurations (swapRanks10)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/agent/directory-agent/test Up
Tests the Directory Agent Configurations using the supplied Username and Domain Name (testConfigs)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
username (optional)
Form Parameter —
domain (optional)
Form Parameter —
username (optional)
Form Parameter —
domain (optional)
Form Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

114/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/agent/directory-agent/subnet/test Up
Tests if the supplied IP address exists in any configured IP ranges (testIP)

Query parameters
ip (required)
Query Parameter —

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

Discovery

GET /device/discovery/discover/status Up
Returns the discovery status for a single container (discoveryStatus)

Query parameters
containerName (optional)
Query Parameter —

Return type
DiscoveryStatusResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DiscoveryStatusResult

GET /device/discovery/discover/status/all Up
Returns the percentage complete for all discoveries across all containers (getOverallDiscoveryStatus)

Return type
SingleObjectResultDouble
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SingleObjectResultDouble

POST /device/discovery/discover Up
Starts a discovery for one or more IP ranges or seeds into adding discovered devices to the specified container (startDiscovery)

Consumes
This API call consumes the following media types via the Content-Type request header:

115/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Request body
body DiscoveryData (optional)
Body Parameter —

Return type
BooleanMapResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanMapResult

POST /device/discovery/discover/stop Up
Stops discovery on a single container (stopDiscovery)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
containerName (optional)
Form Parameter —
containerName (optional)
Form Parameter —

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

EPCScan

POST /policy/endpoint-compliance/scan Up
Adds a new Endpoint Compliance Scan (addModifyPolicy)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body ScriptProfile (optional)
Body Parameter —

Return type
BaseResult
Produces

116/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance/scan/copy Up
Copies all content from the supplied Scan to a new Scan (copyPolicy)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
policyName (optional)
Form Parameter —
newPolicyName (optional)
Form Parameter —
policyName (optional)
Form Parameter —
newPolicyName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance/scan/delete Up
Deletes one or more Endpoint Compliance Scans (deletePolicies)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
117/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
BaseResult

GET /policy/endpoint-compliance/scan/available Up
Returns the full set of tests and custom scans available for each operating system (getAllPossibleTests)

Return type
ScriptProfileDetailsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScriptProfileDetailsResult

GET /policy/endpoint-compliance/scan Up
Returns all Endpoint Compliance Scans which match the supplied filter (getByFilter27)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
ScriptProfileResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScriptProfileResult

GET /policy/endpoint-compliance/scan/{id}/usage Up
Returns a list of records that reference this Endpoint Compliance Scan by ID (getObjectUsage16)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default

118/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
RecordUsageResult

GET /policy/endpoint-compliance/scan/details Up
Returns the selected tests and monitors for the Endpoint Compliance Scan (getPolicyDetails)

Query parameters
policyName (optional)
Query Parameter —

Return type
ScriptProfileDetailsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScriptProfileDetailsResult

GET /policy/endpoint-compliance/scan/product Up
Returns the details used to display and edit a product within the policy. Each product supplies its own markup and scripts that may be used to
create a valid configuration. (getProductDetails)

Query parameters
policyName (optional)
Query Parameter —
productName (optional)
Query Parameter —
osName (optional)
Query Parameter —
familyName (optional)
Query Parameter —

Return type
ScriptProfileProductDetailsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScriptProfileProductDetailsResult

Email

POST /settings/integration/email/delete Up
Resets the e-mail server settings for this appliance (deleteEmailSettings)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

119/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

GET /settings/integration/email/password Up
Returns the password for the currently configured e-mail server. This is done separately so that passwords may be restricted. (getEmailPassword)

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /settings/integration/email Up
Returns the currently configured e-mail server settings (getEmailSettings)

Return type
EmailSettingsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EmailSettingsResult

POST /settings/integration/email Up
Sets the e-mail server settings for this appliance (setEmailSettings)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
smtpTimeout (required)
Form Parameter — format: int64
smtpConnectionTimeout (required)
Form Parameter — format: int64
emailPassword (required)
Form Parameter —
emailAuthType (required)
Form Parameter —
emailPort (required)
Form Parameter —
emailUsername (required)
Form Parameter —
emailServer (required)
Form Parameter —
emailAuth (required)
Form Parameter —
emailSender (required)
Form Parameter —
alwaysSendAsSender (required)

120/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —
smtpTimeout (required)
Form Parameter — format: int64
smtpConnectionTimeout (required)
Form Parameter — format: int64
emailPassword (required)
Form Parameter —
emailAuthType (required)
Form Parameter —
emailPort (required)
Form Parameter —
emailUsername (required)
Form Parameter —
emailServer (required)
Form Parameter —
emailAuth (required)
Form Parameter —
emailSender (required)
Form Parameter —
alwaysSendAsSender (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/email/test Up
Sends a test e-mail to the supplied address, either using the current settings or those supplied in this request (testEmailSettings)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
smtpTimeout (required)
Form Parameter — format: int64
smtpConnectionTimeout (required)
Form Parameter — format: int64
emailPassword (required)
Form Parameter —
emailAuthType (required)
Form Parameter —
emailPort (required)
Form Parameter —
emailUsername (required)
Form Parameter —
emailServer (required)
Form Parameter —
emailAuth (required)
Form Parameter —
emailSender (required)
Form Parameter —
alwaysSendAsSender (required)

121/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —
email (required)
Form Parameter —
recipient (required)
Form Parameter —
smtpTimeout (required)
Form Parameter — format: int64
smtpConnectionTimeout (required)
Form Parameter — format: int64
emailPassword (required)
Form Parameter —
emailAuthType (required)
Form Parameter —
emailPort (required)
Form Parameter —
emailUsername (required)
Form Parameter —
emailServer (required)
Form Parameter —
emailAuth (required)
Form Parameter —
emailSender (required)
Form Parameter —
alwaysSendAsSender (required)
Form Parameter —
email (required)
Form Parameter —
recipient (required)
Form Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

Event

POST /logging/event Up
Adds a new event record to the database (addNewObject8)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body YamsEvent (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

122/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event/delete Up
Deletes the event record or records that match the supplied DBID(s), if they are not currently in use (deleteMultiple12)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /logging/event/{id} Up
Deletes the event record that matches the supplied DBID, if it is not currently in use (deleteSingle12)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event/{id}/delete Up
Deletes the event record that matches the supplied DBID, if it is not currently in use (deleteViaPost12)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces

123/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /logging/event Up
Returns all event records which match the supplied filter (getByFilter16)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
YamsEventResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
YamsEventResult

GET /logging/event/{id} Up
Returns the event record that matched the supplied DBID (getByID16)

Path parameters
id (required)
Path Parameter — format: int64

Return type
YamsEventResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
YamsEventResult

GET /logging/event/count/all Up
Returns the count of all event records in the database (getCountOfAll12)

Return type
YamsEventResult
Produces

124/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
YamsEventResult

GET /logging/event/count Up
Returns a count of all event records that match the provided filter (getCountOfFilter12)

Query parameters
filter (optional)
Query Parameter —

Return type
YamsEventResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
YamsEventResult

GET /logging/event/archive Up
Returns the event archives currently stored on the filesystem (getEventArchiveNames)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /logging/event/supporting-info Up
Returns a list of all supported event types. (getEventPanelSupportingData)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /logging/event/archive/import/status Up
Returns the status of the most recent event archive import (getImportArchiveStatus3)

125/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /logging/event/monitor/{id} Up
Gets all changes to event records since the Events were last polled (getMonitorChanges4)

Path parameters
id (required)
Path Parameter — format: int64

Return type
ContainerChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ContainerChangeResult

GET /logging/event/{id}/usage Up
Returns a list of records that reference this event record (getObjectUsage9)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /logging/event/archive/import Up
Imports an event archive from the filesystem back into the database (importArchive3)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
fileName (optional)
Form Parameter —

126/615
1/21/22, 11:27 AM FortiNAC REST Schema

fileName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event/{id} Up
Updates an existing event record in the database (modifyObject8)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body YamsEvent (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event/note Up
Sets the note for one or more events (setEventNote)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
note (optional)
Form Parameter —
id (optional)
Form Parameter — format: int64
note (optional)
Form Parameter —
id (optional)
Form Parameter — format: int64

127/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event/monitor/start Up
Begins collecting changes made to event records matching the supplied filter (startMonitorPolling4)

Return type
ContainerMonitorResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ContainerMonitorResult

POST /logging/event/monitor/{id}/stop Up
Stops collecting changes made to event records for the specified monitor (stopMonitorPolling4)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

EventAction

POST /policy/event-action Up
Creates a new Event Action record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject18)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EventAction (optional)
Body Parameter —

Return type
BaseResult
128/615
1/21/22, 11:27 AM FortiNAC REST Schema

Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/event-action/delete Up
Deletes a list of Event Action records supplied under the id parameter (deleteMultiple22)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/event-action/{id} Up
Deletes a single Event Action record by ID (deleteSingle22)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/event-action/{id}/delete Up
Deletes a single Event Action record by ID (deleteViaPost22)

Path parameters
id (required)
Path Parameter — format: int64

129/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/event-action/supporting-info Up
Returns the additional information needed to create a Security Rule (getActivityRequiredInfo)

Return type
EventActionSupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventActionSupportingInfoResult

GET /policy/event-action Up
Returns a list of Event Action records matching the supplied filter (getByFilter28)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
EventActionResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventActionResult

GET /policy/event-action/{id} Up
Returns a list of Event Action records matching the supplied filter (getByID27)

Path parameters
id (required)
Path Parameter — format: int64

130/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
EventActionResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventActionResult

GET /policy/event-action/{id}/usage Up
Returns a list of records that reference this Event Actionrecord (getObjectUsage17)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /policy/event-action/{id} Up
Updates an Event Action record, creating it if no record is found with that DBID (modifyObject18)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EventAction (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

EventToAlarmMapping

131/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /logging/event-alarm-mapping Up
Adds a new event to alarm mapping record to the database (addNewObject9)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EventToAlarm (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event-alarm-mapping/modify Up
Sets common configuration values for several Event to Alarm Mappings in a single request (bulkModifyEventMappings)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
severity (optional)
Form Parameter — format: int32
notifyGroupID (optional)
Form Parameter — format: int64
notifyByEmail (optional)
Form Parameter —
notifyBySMS (optional)
Form Parameter —
ids (optional)
Form Parameter — format: int64
severity (optional)
Form Parameter — format: int32
notifyGroupID (optional)
Form Parameter — format: int64
notifyByEmail (optional)
Form Parameter —
notifyBySMS (optional)
Form Parameter —
ids (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

132/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
BaseResult

POST /logging/event-alarm-mapping/delete Up
Deletes the event to alarm mapping record or records matching the supplied id(s), if they are none are currently in use (deleteMultiple13)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /logging/event-alarm-mapping/{id} Up
Deletes the event to alarm mapping record that matches the supplied id, if it is not currently in use (deleteSingle13)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event-alarm-mapping/{id}/delete Up
Deletes the event to alarm mapping record that matches the supplied id, if it is not currently in use (deleteViaPost13)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

133/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event-alarm-mapping/disable Up
Disables the supplied event to alarm mapping (disableItem4)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event-alarm-mapping/enable Up
Enables the supplied event to alarm mapping (enableItem4)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /logging/event-alarm-mapping Up
Returns all event to alarm mapping records which match the supplied filter (getByFilter17)

134/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
EventToAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventToAlarmResult

GET /logging/event-alarm-mapping/{id} Up
Returns the event to alarm mapping record that matches the supplied DBID (getByID17)

Path parameters
id (required)
Path Parameter — format: int64

Return type
EventToAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventToAlarmResult

GET /logging/event-alarm-mapping/count/all Up
Returns the count of all event to alarm mapping records in the database (getCountOfAll13)

Return type
EventToAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventToAlarmResult

GET /logging/event-alarm-mapping/count Up
Returns the count of all event to alarm mapping records that match the provided filter (getCountOfFilter13)

135/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query parameters
filter (optional)
Query Parameter —

Return type
EventToAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventToAlarmResult

GET /logging/event-alarm-mapping/{id}/usage Up
Returns a list of records that reference this event to alarm mapping record (getObjectUsage10)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /logging/event-alarm-mapping/supporting-info Up
Returns information needed to create an Event to Alarm mapping, such as the list of possible events (getSupportingEventMappingInfo)

Return type
EventMappingSupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventMappingSupportingInfoResult

POST /logging/event-alarm-mapping/{id} Up
Updates an existing event to alarm mapping record in the database (modifyObject9)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

136/615
1/21/22, 11:27 AM FortiNAC REST Schema
Request body
body EventToAlarm (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

EventTypes

GET /logging/event-types Up
Returns all Event Type records which match the supplied filter (getByFilter18)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
PossibleEventTypeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PossibleEventTypeResult

GET /logging/event-types/{id} Up
Returns the Event Type record that matches the supplied DBID (getByID18)

Path parameters
id (required)
Path Parameter — format: int64

Return type
PossibleEventTypeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
137/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
PossibleEventTypeResult

GET /logging/event-types/count/all Up
Returns the count of all Event Type records in the database (getCountOfAll14)

Return type
PossibleEventTypeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PossibleEventTypeResult

GET /logging/event-types/count Up
Returns the count of all Event Type records that match the provided filter (getCountOfFilter14)

Query parameters
filter (optional)
Query Parameter —

Return type
PossibleEventTypeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PossibleEventTypeResult

GET /logging/event-types/thresholds Up
Returns the thresholds for several system events, such as CPU usage, before they are triggered (getEventThresholds)

Return type
EventThresholdsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventThresholdsResult

POST /logging/event-types/thresholds Up
Sets the thresholds for generating system events (setEventThresholds)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body

138/615
1/21/22, 11:27 AM FortiNAC REST Schema

body EventThresholds (optional)

Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event-types/group Up
Sets the targeted group for one or more event types (setPossibleEventGroup)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
groupID (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
groupID (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /logging/event-types/logging-strategy Up
Sets the logging strategy for one or more event types (setPossibleEventLogging)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
logLevel (optional)
Form Parameter —
id (optional)
Form Parameter — format: int64
logLevel (optional)
Form Parameter —
id (optional)
Form Parameter — format: int64

139/615
1/21/22, 11:27 AM FortiNAC REST Schema

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

FSSO

GET /settings/integration/FSSO/password Up
Returns the password for the currently configured FSSO server (getFSSOPassword)

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /settings/integration/FSSO Up
Returns the currently configured FSSO server settings (getFSSOSettings)

Return type
FSSOSettingsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FSSOSettingsResult

POST /settings/integration/FSSO Up
Add FSSO settings (setFSSOSettings)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
enabled (required)
Form Parameter —
port (required)
Form Parameter —
password (required)
Form Parameter —
enabled (required)
Form Parameter —

140/615
1/21/22, 11:27 AM FortiNAC REST Schema

port (required)
Form Parameter —
password (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Fingerprint

POST /host/fingerprint Up
Creates a new Fingerprint record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject5)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body Fingerprint (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/fingerprint/delete Up
Deletes a list of Fingerprint records supplied under the id parameter (deleteMultiple6)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

141/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /host/fingerprint/{id} Up
Deletes a single Fingerprint record by ID (deleteSingle6)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/fingerprint/{id}/delete Up
Deletes a single Fingerprint record by ID (deleteViaPost6)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host/fingerprint Up
Returns a list of Fingerprint records matching the supplied filter (getByFilter8)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type

142/615
1/21/22, 11:27 AM FortiNAC REST Schema
Fingerprint
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
Fingerprint

GET /host/fingerprint/{id} Up
Returns a list of Fingerprint records matching the supplied filter (getByID8)

Path parameters
id (required)
Path Parameter — format: int64

Return type
Fingerprint
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
Fingerprint

GET /host/fingerprint/count/all Up
Returns the count of all Fingerprint records in the database (getCountOfAll7)

Return type
Fingerprint
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
Fingerprint

GET /host/fingerprint/count Up
Returns the count of all Fingerprint records in the database that match the provided filter (getCountOfFilter7)

Query parameters
filter (optional)
Query Parameter —

Return type
Fingerprint
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
143/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
Fingerprint

POST /host/fingerprint/{id} Up
Updates an Fingerprint record, creating it if no record is found with that DBID (modifyObject5)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body Fingerprint (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

FirewallSession

POST /dynamic/dynamic-connection Up
Creates a new record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject1)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DynamicConnection (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /dynamic/dynamic-connection/delete Up
Deletes a list of records supplied under the id parameter (deleteMultiple2)

Consumes
This API call consumes the following media types via the Content-Type request header:

144/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /dynamic/dynamic-connection/{id} Up
Deletes a single record by ID (deleteSingle2)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /dynamic/dynamic-connection/{id}/delete Up
Deletes a single record by ID (deleteViaPost2)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /dynamic/dynamic-connection Up
Returns a list of records matching the supplied filter (getByFilter4)

145/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
DynamicConnectionResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DynamicConnectionResult

GET /dynamic/dynamic-connection/{id} Up
Returns a list of records matching the supplied filter (getByID4)

Path parameters
id (required)
Path Parameter — format: int64

Return type
DynamicConnectionResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DynamicConnectionResult

GET /dynamic/dynamic-connection/host/{id} Up
Returns a list of adapter MAC addresses owned by the supplied Host Record (getMacAddressesForHost)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

146/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /dynamic/dynamic-connection/{id}/usage Up
Returns a list of records that reference this record (getObjectUsage2)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /dynamic/dynamic-connection/polling/{id} Up
Returns the firewall session polling status for the supplied device (getPollingStatus)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /dynamic/dynamic-connection/{id} Up
Updates an record, creating it if no record is found with that DBID (modifyObject1)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body DynamicConnection (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

147/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
200
Default Response Value
BaseResult

POST /dynamic/dynamic-connection/polling/{id}/run Up
Queues a poll for firewall sessions on the supplied device (runPollNow)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /dynamic/dynamic-connection/polling/{id} Up
Updates the firewall session polling configuration for the supplied device (setPollingStatus)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PollingStatus (optional)
Body Parameter —

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

FirewallTag

POST /settings/integration/firewall-tag Up
Creates a new Firewall Tag record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject36)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

148/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Request body
body FirewallTag (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/firewall-tag/delete Up
Deletes a list of Firewall Tag records supplied under the id parameter (deleteMultiple40)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/firewall-tag/{id} Up
Deletes a single Firewall Tag record by ID (deleteSingle40)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

149/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/integration/firewall-tag/{id}/delete Up
Deletes a single Firewall Tag record by ID (deleteViaPost40)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/firewall-tag Up
Returns a list of Firewall Tag records matching the supplied filter (getByFilter50)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
FirewallTagResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FirewallTagResult

GET /settings/integration/firewall-tag/{id} Up
Returns a list of Firewall Tag records matching the supplied filter (getByID47)

Path parameters
id (required)
Path Parameter — format: int64

Return type
FirewallTagResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

150/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
FirewallTagResult

GET /settings/integration/firewall-tag/{id}/usage Up
Returns a list of records that reference this Firewall Tag record (getObjectUsage32)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/integration/firewall-tag/{id} Up
Updates an Firewall Tag record, creating it if no record is found with that DBID (modifyObject36)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body FirewallTag (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

FortigateTelemetry

POST /settings/security-fabric Up
Creates a new Security Fabric Connection source, updating instead if the supplied profile has a DBID of one that already exists
(addNewObject29)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

151/615
1/21/22, 11:27 AM FortiNAC REST Schema
Request body
body TelemetryDevice (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/security-fabric/delete Up
Deletes a list of Security Fabric Connection sources supplied under the id parameter (deleteMultiple33)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/security-fabric/{id} Up
Deletes a single Security Fabric Connection source by ID (deleteSingle33)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

152/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/security-fabric/{id}/delete Up
Deletes a single Security Fabric Connection source by ID (deleteViaPost33)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/security-fabric Up
Returns a list of Security Fabric Connection sources matching the supplied filter (getByFilter42)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
FortigateTelemetryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FortigateTelemetryResult

GET /settings/security-fabric/{id} Up
Returns a list of Security Fabric Connection sources matching the supplied filter (getByID40)

Path parameters
id (required)
Path Parameter — format: int64

Return type
FortigateTelemetryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

153/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
FortigateTelemetryResult

GET /settings/security-fabric/{id}/usage Up
Returns a list of records that reference this Security Fabric Connection source (getObjectUsage25)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/security-fabric/{id} Up
Updates a Security Fabric Connection source, creating it if no record is found with that DBID (modifyObject29)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body TelemetryDevice (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

Google

POST /settings/integration/google/domains Up
Adds a new Google authentication domain (addGoogleAuthDomain)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

154/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
domainName (optional)
Form Parameter —
domainName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/google/domains/delete Up
Deletes one or more Google authentication domains (deleteGoogleAuthDomain)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/google/domains Up
Returns the list of domains configured to work with the Google directory (getGoogleAuthDomains)

Return type
NameIDObjectListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NameIDObjectListResult

GET /settings/integration/google/client-id Up
Returns the configured Google Client ID, Project Number, and API Key (getGoogleClientID)

155/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
GoogleClientIDResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GoogleClientIDResult

POST /settings/integration/google/domains/{id} Up
Modifies an existing Google authentication domain (modifyGoogleAuthDomain)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
domainName (optional)
Form Parameter —
domainName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/google/client-id Up
Sets the Google Client ID, Project Number, and API Key (setGoogleClientID)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
clientID (optional)
Form Parameter —
senderID (optional)
Form Parameter —
apiKey (optional)
Form Parameter —
clientID (optional)
Form Parameter —
senderID (optional)
Form Parameter —
apiKey (optional)

156/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/google/domains/set Up
Sets the configured Google authentication domains to the list supplied, removing any that are not in that list (syncGoogleAuthDomains)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
domainName (optional)
Form Parameter —
domainName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Group

POST /system/group/{id}/add-devices Up
Deprecated. Adds one or more devices to the specified group (addDevicesToGroup)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
deviceList (optional)
Form Parameter — format: int64
deviceList (optional)
Form Parameter — format: int64

Return type
BaseResult

157/615
1/21/22, 11:27 AM FortiNAC REST Schema

Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/add-members Up
Adds members to a group or groups of a certain type and also adds groups to a group of a certain type. (addMembersToGroups)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
type (optional)
Form Parameter — format: byte
elemID (optional)
Form Parameter — format: int64
groupID (optional)
Form Parameter — format: int64
type (optional)
Form Parameter — format: byte
elemID (optional)
Form Parameter — format: int64
groupID (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/{groupType} Up
Adds a new user group to the database (addNewObject49)

Path parameters
groupType (required)
Path Parameter —

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body Group (optional)
Body Parameter —

Return type
BaseResult

158/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/delete Up
Deletes the group record or records supplied, if they are not currently in use (deleteMultiple53)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /system/group/{id} Up
Deletes the group record supplied, if it is not currently in use (deleteSingle52)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/{id}/delete Up
Deletes the group record supplied, if it is not currently in use (deleteViaPost52)

Path parameters
id (required)
Path Parameter — format: int64

159/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /system/group/by-type Up
Deprecated. Returns all Groups divided by the object type they hold (getAllGroupsByType)

Return type
GroupsByTypeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GroupsByTypeResult

GET /system/group Up
Returns all group records which match the supplied filter (getByFilter63)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
ManagedGroupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ManagedGroupResult

GET /system/group/{id} Up
Returns the group record with the supplied DBID (getByID60)

Path parameters
id (required)
Path Parameter — format: int64

160/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
ManagedGroupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ManagedGroupResult

GET /system/group/count/all Up
Returns the count of all group records in the database (getCountOfAll20)

Return type
ManagedGroupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ManagedGroupResult

GET /system/group/count Up
Returns a count of group records matching the supplied filter (getCountOfFilter20)

Query parameters
filter (optional)
Query Parameter —

Return type
ManagedGroupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ManagedGroupResult

GET /system/group/{id}/descendants Up
Returns all groups that are descendants of the supplied group. If includeParentGroup is true, the list of groups will also include the supplied group
(getDescendantGroups)

Path parameters
id (required)
Path Parameter — format: int64

Query parameters
includeParent (optional)
Query Parameter —

Return type
ManagedGroupListResult
Produces

161/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ManagedGroupListResult

GET /system/group/{id}/member-ids Up
Returns the member IDs of all descendant members (getGroupMemberIDs)

Path parameters
id (required)
Path Parameter — format: int64

Return type
NumberListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NumberListResult

GET /system/group/{id}/members Up
Returns all descendant members and subgroups for this group (getGroupMembers)

Path parameters
id (required)
Path Parameter — format: int64

Query parameters
getImages (optional)
Query Parameter —
getSubGroups (optional)
Query Parameter —

Return type
GroupMembersResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GroupMembersResult

GET /system/group/{id}/usage Up
Returns a list of group records that reference this record (getObjectUsage43)

Path parameters
id (required)
Path Parameter — format: int64

Return type
162/615
1/21/22, 11:27 AM FortiNAC REST Schema
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /system/group/membership Up
Sets the Group Membership for the supplied groups for the supplied member. (modifyGroupMembership)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
memberID (optional)
Form Parameter — format: int64
type (optional)
Form Parameter — format: byte
serverIP (optional)
Form Parameter —
groupID (optional)
Form Parameter — format: int64
memberID (optional)
Form Parameter — format: int64
type (optional)
Form Parameter — format: byte
serverIP (optional)
Form Parameter —
groupID (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/add-to-parents Up
Sets the parent groups to the supplied group of same type. If replace is true it also removes from any groups that this supplied group currently
belongs to and by default replace is true. (modifyGroupParents)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
groupID (optional)
Form Parameter — format: int64
parentID (optional)

163/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter — format: int64
replace (optional)
Form Parameter —
groupID (optional)
Form Parameter — format: int64
parentID (optional)
Form Parameter — format: int64
replace (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/{groupType}/{id} Up
Updates an existing user group in the database (modifyObject50)

Path parameters
groupType (required)
Path Parameter —
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body Group (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/{id}/remove-devices Up
Deprecated. Remove one or more devices from the specified group (removeDevicesFromGroup)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

164/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/x-www-form-urlencoded
multipart/form-data

Form parameters
deviceList (optional)
Form Parameter — format: int64
deviceList (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/remove-from-parent Up
Removes one or more groups from the supplied parent group (removeGroupFromParent)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
parentID (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
parentID (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/remove-members Up
Removes a set of member IDs from a set of group IDs, if the member exists within the group (removeMembersFromGroups)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
elemID (optional)
Form Parameter — format: int64
groupID (optional)
165/615
1/21/22, 11:27 AM FortiNAC REST Schema
g p ( p )
Form Parameter — format: int64
elemID (optional)
Form Parameter — format: int64
groupID (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/{groupID}/manages Up
Sets the User, Host, and Port groups that may be managed by members of this group (setAdminGroupManagesInfo)

Path parameters
groupID (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/group/aging Up
Sets the aging time for records in the group or groups (setGroupAging)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
daysValid (optional)
Form Parameter — format: int32
daysInactive (optional)
166/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter — format: int32
id (optional)
Form Parameter — format: int64
daysValid (optional)
Form Parameter — format: int32
daysInactive (optional)
Form Parameter — format: int32

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GuestAccount

POST /user/guest Up
Adds a new guest record to the database using the provided guest template and sponsor (addNewObject51)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body GuestRecord (optional)
Body Parameter —

Query parameters
template (optional)
Query Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest/bulk Up
Creates one or more guest accounts in a single request, each using the same guest template (createBulkAccounts)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body GuestRecord (optional)
Body Parameter —

167/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query parameters
template (optional)
Query Parameter —

Return type
NumberListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NumberListResult

POST /user/guest/conference Up
Creates a conference account and any subsequent guest accounts (createConferenceAccounts)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
name (required)
Form Parameter —
type (required)
Form Parameter —
attendeeCount (required)
Form Parameter — format: int32
startTime (required)
Form Parameter — format: int64
endTime (required)
Form Parameter — format: int64
templateID (required)
Form Parameter — format: int64
password (required)
Form Parameter —
name (required)
Form Parameter —
type (required)
Form Parameter —
attendeeCount (required)
Form Parameter — format: int32
startTime (required)
Form Parameter — format: int64
endTime (required)
Form Parameter — format: int64
templateID (required)
Form Parameter — format: int64
password (required)
Form Parameter —

Return type
NumberListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

168/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
NumberListResult

POST /user/guest/delete Up
Deletes the guest account record or records supplied, if they are none are currently in use (deleteMultiple56)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /user/guest/{id} Up
Deletes the guest account record supplied, if it is not currently in use (deleteSingle55)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest/{id}/delete Up
Deletes the guest account record supplied, if it is not currently in use (deleteViaPost55)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

169/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest/{id}/disable Up
Disables the supplied guest account (disableItem15)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest/{id}/enable Up
Enables the supplied guest account (enableItem15)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest/{id}/generate-password Up
Generates a new password using the template associated with the guest record, but does not modify that guest record (generatePassword)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
170/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
StringResult

POST /user/guest/generate-password-from-template Up
Generates a new password compliant with the guest template using the provided template id (generatePasswordFromTemmplate)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
templateID (optional)
Form Parameter — format: int64
templateID (optional)
Form Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /user/guest Up
Returns all guest account records which match the supplied filter (getByFilter66)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
GuestRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GuestRecordResult

GET /user/guest/{id} Up
Returns the guest account record with the supplied DBID (getByID63)

Path parameters
id (required)
Path Parameter — format: int64
171/615
1/21/22, 11:27 AM FortiNAC REST Schema

Return type
GuestRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GuestRecordResult

GET /user/guest/count/all Up
Returns the count of all guest account records in the database (getCountOfAll23)

Return type
GuestRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GuestRecordResult

GET /user/guest/count Up
Returns a count of guest account records matching the supplied filter (getCountOfFilter23)

Query parameters
filter (optional)
Query Parameter —

Return type
GuestRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GuestRecordResult

GET /user/guest/{id}/get-password Up
gets the password from the guest record using the provided record id (getPassword)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

172/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
StringResult

POST /user/guest/{id} Up
Updates an existing guest account record in the database (modifyObject52)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body GuestRecord (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest/reset-password Up
Resets the password for one or more guest accounts (resetPassword)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest/send-email Up
Sends an email to one or more email addresses associated with the supplied guest account ids (sendGuestEmail)

173/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
messageTemplate (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
messageTemplate (optional)
Form Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

POST /user/guest/send-sms Up
Sends an SMS to one or more mobile numbers associated with the supplied guest account ids (sendGuestSMS)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
messageTemplate (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
messageTemplate (optional)
Form Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GuestTemplate

POST /user/guest-template Up
Adds a new guest template record to the database (addNewObject52)

174/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body GuestTemplate (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest-template/delete Up
Deletes the guest template record or records supplied, if they are none are currently in use (deleteMultiple57)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /user/guest-template/{id} Up
Deletes the guest template record supplied, if it is not currently in use (deleteSingle56)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

175/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
BaseResult

POST /user/guest-template/{id}/delete Up
Deletes the guest template record supplied, if it is not currently in use (deleteViaPost56)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /user/guest-template Up
Returns all guest template records which match the supplied filter (getByFilter67)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
GuestTemplateResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GuestTemplateResult

GET /user/guest-template/{id} Up
Returns the guest template record with the supplied DBID (getByID64)

Path parameters
id (required)
Path Parameter — format: int64

Return type
GuestTemplateResult
Produces

176/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GuestTemplateResult

GET /user/guest-template/count/all Up
Returns the count of all guest template records in the database (getCountOfAll24)

Return type
GuestTemplateResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GuestTemplateResult

GET /user/guest-template/count Up
Returns a count of guest template records matching the supplied filter (getCountOfFilter24)

Query parameters
filter (optional)
Query Parameter —

Return type
GuestTemplateResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GuestTemplateResult

GET /user/guest-template/{id}/usage Up
Returns a list of guest template records that reference this record (getObjectUsage45)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

177/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /user/guest-template/{id} Up
Updates an existing guest template record in the database (modifyObject53)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body GuestTemplate (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /user/guest-template/resolve-ip Up
Resolves an IP address from a supplied URL or hostname (resolveUrl)

Query parameters
url (optional)
Query Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

HostRecord

POST /host/accept-imported-hosts Up
Accept the hosts imported to add them into database (acceptImportedHosts)

Return type
AcceptHostImportResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

178/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
AcceptHostImportResult

POST /host Up
Adds a new Host Record to the database (addNewObject7)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body HostRecord (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/delete Up
Deletes the Host Record or records supplied, if they are not currently in use (deleteMultiple9)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /host/{id} Up
Deletes the Host Record supplied, if it is not currently in use (deleteSingle9)

Path parameters
id (required)
Path Parameter — format: int64

Return type

179/615
1/21/22, 11:27 AM FortiNAC REST Schema
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/{id}/delete Up
Deletes the Host Record supplied, if it is not currently in use (deleteViaPost9)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/{id}/disable Up
Disables the Host Record that matches the supplied DBID (disableItem3)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/disable-by-ip Up
Disables the Host Record that matches the supplied ip address (disableItemByIp)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
ip (optional)
Form Parameter —
ip (optional)

180/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/disable-by-mac Up
Disables the Host Record that matches the supplied mac address (disableItemByMac)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
mac (optional)
Form Parameter —
mac (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/{id}/enable Up
Enables the Host Record that matches the supplied DBID (enableItem3)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/enable-by-ip Up
Enables the Host Record that matches the supplied ip address (enableItemByIp)

181/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
ip (optional)
Form Parameter —
ip (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/enable-by-mac Up
Enables the Host Record that matches the supplied mac address (enableItemByMac)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
mac (optional)
Form Parameter —
mac (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host Up
Returns all Host Records which match the supplied filter (getByFilter11)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)

182/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter —

Return type
HostRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordResult

GET /host/{id} Up
Returns the Host Record with the supplied DBID (getByID11)

Path parameters
id (required)
Path Parameter — format: int64

Return type
HostRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordResult

GET /host/by-ip/{ip} Up
Returns the Host Record that matches the supplied IP Address (getByIp)

Path parameters
ip (required)
Path Parameter —

Return type
HostRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordResult

GET /host/by-mac/{mac} Up
Returns the Host Record that matches the supplied MAC Address (getByMac)

Path parameters
mac (required)
Path Parameter —

Return type
HostRecordResult

183/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordResult

GET /host/multifilter Up
Returns all Host Records, with User and Adapter information, which match the supplied multifilter string (getByMultiFilterHostAdapter)

Query parameters
filter (optional)
Query Parameter —
pods (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
MultifilterResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
MultifilterResult

GET /host/multifilter/users Up
Returns all Host Records, with User and Adapter information, which match the supplied multifilter string (getByMultiFilterUsers)

Query parameters
filter (optional)
Query Parameter —
pods (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
MultifilterResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

184/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
MultifilterResult

GET /host/client-filters/cached/{name} Up
Returns the cached filter with the supplied name (getCachedFilter)

Path parameters
name (required)
Path Parameter —

Return type
ClientFilterResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ClientFilterResult

GET /host/client-filters Up
Returns all private Client Filters, used for multifilter queries. If allowed, shared Client Filters are also included (getClientFilters)

Query parameters
serverIP (optional)
Query Parameter —

Return type
ClientFilterResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ClientFilterResult

GET /host/count/all Up
Returns the count of all Host Records in the database (getCountOfAll8)

Return type
HostRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordResult

GET /host/count Up

185/615
1/21/22, 11:27 AM FortiNAC REST Schema
Returns the count of all Host Records in the database that match the provided filter (getCountOfFilter8)

Query parameters
filter (optional)
Query Parameter —

Return type
HostRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordResult

GET /host/device-types Up
Returns all private Client Filters, used for multifilter queries. If allowed, shared Client Filters are also included (getDeviceTypes)

Return type
DeviceTypesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DeviceTypesResult

GET /host/global-allowed-hosts Up
Returns the count of allowed Host Records on this system. (getGlobalAllowedHosts)

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /host/{id}/health-history Up
Returns the health history of the Host Record with the supplied DBID (getHealthHistory)

Path parameters
id (required)
Path Parameter — format: int64

Return type
HealthHistoryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

186/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
HealthHistoryResult

GET /host/connected-to-port Up
Returns a list of Host Records connected to the port id provided. (getHostsConnectedToPort)

Query parameters
portID (required)
Query Parameter — format: int64

Return type
HostRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordResult

GET /host/for-user Up
Returns a list of Host Records for the user object with the provided id. (getHostsForUser)

Query parameters
userID (required)
Query Parameter —

Return type
HostRecordForUserResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordForUserResult

GET /host/ncm-pods Up
Returns all Host Records, with User and Adapter information, which match the supplied multifilter string (getNCMPods)

Return type
NCMPodResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NCMPodResult

GET /host/{id}/usage Up
Returns a list of records that reference this Host Record (getObjectUsage7)
187/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /host/{id}/policy Up
Returns the policy info for a Host Record based on the provided id (getPolicyForHost)

Path parameters
id (required)
Path Parameter — format: int64

Return type
PolicyForHostResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PolicyForHostResult

POST /host/import-hosts Up
Imports hosts into database (importHosts)

Consumes
This API call consumes the following media types via the Content-Type request header:

multipart/form-data

Form parameters
file (optional)
Form Parameter —

Return type
HostImportResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostImportResult

POST /host/{id} Up
Updates an existing Host Record in the database (modifyObject7)

188/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body HostRecord (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/register-as-device Up
Registers the provided Host Record as a device (registerAsDevice)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
role (optional)
Form Parameter —
devType (optional)
Form Parameter —
domainID (optional)
Form Parameter —
ip (optional)
Form Parameter —
regType (optional)
Form Parameter —
id (optional)
Form Parameter — format: int64
role (optional)
Form Parameter —
devType (optional)
Form Parameter —
domainID (optional)
Form Parameter —
ip (optional)
Form Parameter —
regType (optional)
Form Parameter —

Return type
BaseResult
Produces

189/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/{id}/rescan-with-profile Up
Re-Scans a Host Record with a particular script profile (rescanWithProfile)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
profileID (optional)
Form Parameter — format: int64
profileID (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/scan Up
Triggers a scan of Host Record for the ids provided (scanHosts)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
190/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
BaseResult

GET /host/search Up
Returns all Host Records which match the supplied filter, searching Hosts, Users, and Adapters (searchByMultiFilter)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
HostRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRecordResult

POST /host/send-persistent-agent-message Up
Sends a message to a list of Host Records via the Persistent Agent (sendPAMessage)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
message (optional)
Form Parameter —
url (optional)
Form Parameter —
duration (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
message (optional)
Form Parameter —
url (optional)
Form Parameter —
duration (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
191/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/set-expiration Up
Sets the expiration parameters for a list of Host Records (setExpiration)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
setExpiration (optional)
Form Parameter —
setInactivity (optional)
Form Parameter —
expireDays (optional)
Form Parameter — format: int32
expireDateMS (optional)
Form Parameter — format: int64
inactiveDays (optional)
Form Parameter — format: int32
id (optional)
Form Parameter — format: int64
setExpiration (optional)
Form Parameter —
setInactivity (optional)
Form Parameter —
expireDays (optional)
Form Parameter — format: int32
expireDateMS (optional)
Form Parameter — format: int64
inactiveDays (optional)
Form Parameter — format: int32

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/{id}/set-health Up
Sets the health status of the Host Record for the provided id (setHealth)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

192/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/x-www-form-urlencoded
multipart/form-data

Form parameters
profileName (optional)
Form Parameter —
status (optional)
Form Parameter — format: byte
profileID (optional)
Form Parameter — format: int64
profileName (optional)
Form Parameter —
status (optional)
Form Parameter — format: byte
profileID (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/set-logged-on-user Up
Sets the logged on user for the Host Record that matches the supplied mac address (setLoggedOnUser)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
mac (optional)
Form Parameter —
userID (optional)
Form Parameter —
mac (optional)
Form Parameter —
userID (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/set-role Up
Sets the role for a list of Host Records (setRole)

193/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
role (optional)
Form Parameter —
id (optional)
Form Parameter — format: int64
role (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/{id}/update-persistent-agent Up
Updates the persistent agent for the Host Record with the provied id (updatePersistentAgent)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
uuid (optional)
Form Parameter —
uuid (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

HostRegistrationRequest

POST /host/registration-request/approve Up
Approves one or more Host Registration requests. Requests must be pending to be approved (approveRequests)

194/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

*/*

Request body
body body_74 (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/registration-request/delete Up
Deletes a list of Host Registration Request records supplied under the id parameter (deleteMultiple10)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /host/registration-request/{id} Up
Deletes a single Host Registration Request record by ID (deleteSingle10)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

195/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

POST /host/registration-request/{id}/delete Up
Deletes a single Host Registration Request record by ID (deleteViaPost10)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/registration-request/deny Up
Denies one or more Host Registration requests. Requests must be pending to be denied (denyRequests)

Consumes
This API call consumes the following media types via the Content-Type request header:

*/*

Request body
body body_73 (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host/registration-request Up
Returns a list of Host Registration Request records matching the supplied filter (getByFilter12)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

196/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
HostRegistrationRequestResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRegistrationRequestResult

GET /host/registration-request/{id} Up
Returns a list of Host Registration Request records matching the supplied filter (getByID12)

Path parameters
id (required)
Path Parameter — format: int64

Return type
HostRegistrationRequestResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HostRegistrationRequestResult

L3Scan

GET /device/l3scan/status Up
Returns the results for the last completed scan or the one currently in progress. (getStatus)

Return type
L3ScannerStatusResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/xml
application/json

Responses
default
Default Response Value
L3ScannerStatusResult

POST /device/l3scan/start Up
Starts an L3 scan of all the devices in order to identify potential L3 sources (startScan)

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/xml
application/json

Responses
default
Default Response Value
BooleanResult

197/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /device/l3scan/stop Up
Stops an L3 scan if its currently running. (stopScan)

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/xml
application/json

Responses
default
Default Response Value
BooleanResult

LDAP

POST /settings/integration/ldap Up
Adds a new Container record to the database (addNewObject37)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body LDAPConfigRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/ldap/delete Up
Deletes the Container record or records supplied, if they are not currently in use (deleteMultiple41)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

198/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/ldap/{id} Up
Deletes the Container record supplied, if it is not currently in use (deleteSingle41)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/ldap/{id}/delete Up
Deletes the Container record supplied, if it is not currently in use (deleteViaPost41)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/ldap Up
Returns all Container records which match the supplied filter (getByFilter51)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
LDAPConfigResult

199/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LDAPConfigResult

GET /settings/integration/ldap/{id} Up
Returns the Container record with the supplied DBID (getByID48)

Path parameters
id (required)
Path Parameter — format: int64

Return type
LDAPConfigResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LDAPConfigResult

GET /settings/integration/ldap/count/all Up
Returns the count of all Container records in the database (getCountOfAll16)

Return type
LDAPConfigResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LDAPConfigResult

GET /settings/integration/ldap/count Up
Returns a count of Container records matching the supplied filter (getCountOfFilter16)

Query parameters
filter (optional)
Query Parameter —

Return type
LDAPConfigResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LDAPConfigResult

200/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/integration/ldap/{id}/usage Up
Returns a list of Container records that reference this record (getObjectUsage33)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/integration/ldap/{id} Up
Updates an existing Container record in the database (modifyObject37)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body LDAPConfigRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

LogReceiver

POST /settings/integration/log-receiver Up
Adds or modifies a Log Receiver (addLogReceiver)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body LogHostObject (required)
Body Parameter —

201/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/log-receiver/delete Up
Delete a Log Receiver (deleteLogReceiver)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
dbid (optional)
Form Parameter — format: int64
dbid (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/log-receiver Up
Returns the currently configured Log Receivers (getLogReceivers1)

Return type
LogReceiversResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LogReceiversResult

LogicalNetwork

POST /policy/logical-network Up
Creates a new record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject20)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml
202/615
1/21/22, 11:27 AM FortiNAC REST Schema
Request body
body LogicalNetwork (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/logical-network/check-reset-to-defaults Up
Checks if the GUI should offer a reset to defaults for Logical Networks (checkResetToDefaults)

Return type
CheckResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
CheckResult

POST /policy/logical-network/delete Up
Deletes a list of records supplied under the id parameter (deleteMultiple24)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/logical-network/{id} Up
Deletes a single record by ID (deleteSingle24)

Path parameters

203/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/logical-network/{id}/delete Up
Deletes a single record by ID (deleteViaPost24)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/logical-network Up
Returns a list of records matching the supplied filter (getByFilter30)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
LogicalNetworkResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LogicalNetworkResult

204/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /policy/logical-network/{id} Up
Returns a list of records matching the supplied filter (getByID29)

Path parameters
id (required)
Path Parameter — format: int64

Return type
LogicalNetworkResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LogicalNetworkResult

GET /policy/logical-network/{id}/usage Up
Returns a list of records that reference this record (getObjectUsage19)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /policy/logical-network/{id} Up
Updates an record, creating it if no record is found with that DBID (modifyObject20)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body LogicalNetwork (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

205/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/logical-network/reset-to-defaults Up
Creates a default set of Logical Networks and Policies (resetToDefaults)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

LogicalNetworkConfiguration

POST /policy/logical-network-configuration Up
Creates a new logical network record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject19)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body LogicalNetworkConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/logical-network-configuration/element/properties Up
Sets attributes for a number of devices in one request (batchUpdateActionStates)

Consumes
This API call consumes the following media types via the Content-Type request header:

*/*

Request body
body BatchPropertiesRequest (optional)
Body Parameter —

Return type
BaseResult
Produces

206/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/logical-network-configuration/batch-upsert Up
Performs add or modify requests for a series of logical network configurations at once (batchUpsert)

Consumes
This API call consumes the following media types via the Content-Type request header:

*/*

Request body
body BatchConfigurationRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/logical-network-configuration/delete Up
Deletes a list of logical network records supplied under the id parameter (deleteMultiple23)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/logical-network-configuration/{id} Up
Deletes a single logical network record by ID (deleteSingle23)

Path parameters
207/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/logical-network-configuration/{id}/delete Up
Deletes a single logical network record by ID (deleteViaPost23)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/logical-network-configuration/element/properties Up
Returns all topology properties required to configure a device and the current configuration (getActionStatesForElement)

Query parameters
deviceID (optional)
Query Parameter — format: int64
readFromDevice (optional)
Query Parameter —

Return type
PropertiesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PropertiesResult

GET /policy/logical-network-configuration Up
Returns a list of logical network records matching the supplied filter (getByFilter29)

Query parameters
filter (optional)
Query Parameter —
208/615
1/21/22, 11:27 AM FortiNAC REST Schema

start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
LogicalNetworkConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LogicalNetworkConfigurationResult

GET /policy/logical-network-configuration/{id} Up
Returns a list of logical network records matching the supplied filter (getByID28)

Path parameters
id (required)
Path Parameter — format: int64

Return type
LogicalNetworkConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LogicalNetworkConfigurationResult

GET /policy/logical-network-configuration/{id}/usage Up
Returns a list of records that reference this logical network record (getObjectUsage18)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /policy/logical-network-configuration/radius Up
Returns a list of configured RADIUS servers and the current default primary and secondary (getRadiusServers)
209/615
1/21/22, 11:27 AM FortiNAC REST Schema
g p y y( )
Return type
RadiusServersList
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RadiusServersList

POST /policy/logical-network-configuration/{id} Up
Updates an logical network record, creating it if no record is found with that DBID (modifyObject19)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body LogicalNetworkConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/logical-network-configuration/element/properties/{deviceID} Up
Updates the topology properties on a single device (updateActionStatesForElement)

Path parameters
deviceID (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PropertiesResult (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

210/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

MDM

POST /settings/integration/mdm Up
Creates a new MDM record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject38)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body MdmDevice (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/mdm/authenticate Up
Authenticates against an MDM server and returns the refresh token. This is not required for all vendors (authenticateMdmService)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
mdmVendor (optional)
Form Parameter —
applicationID (optional)
Form Parameter —
identifier (optional)
Form Parameter —
appAccessKey (optional)
Form Parameter —
platformID (optional)
Form Parameter —
authCode (optional)
Form Parameter —
mdmVendor (optional)
Form Parameter —
applicationID (optional)
Form Parameter —
identifier (optional)
Form Parameter —
appAccessKey (optional)
Form Parameter —

211/615
1/21/22, 11:27 AM FortiNAC REST Schema

platformID (optional)
Form Parameter —
authCode (optional)
Form Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

POST /settings/integration/mdm/delete Up
Deletes a list of MDM records supplied under the id parameter (deleteMultiple42)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
ids (optional)
Form Parameter — format: int64
ids (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/mdm/{id} Up
Deletes a single MDM record by ID (deleteSingle42)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

212/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/integration/mdm/{id}/delete Up
Deletes a single MDM record by ID (deleteViaPost42)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/mdm Up
Returns a list of MDM records matching the supplied filter (getByFilter52)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
MdmDeviceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
MdmDeviceResult

GET /settings/integration/mdm/{id} Up
Returns a list of MDM records matching the supplied filter (getByID49)

Path parameters
id (required)
Path Parameter — format: int64

Return type
MdmDeviceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

213/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
MdmDeviceResult

GET /settings/integration/mdm/{id}/password Up
Returns the configured password used to communicate with the MDM server (getMdmServicePassword)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /settings/integration/mdm/{id}/usage Up
Returns a list of records that reference this MDM record (getObjectUsage34)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/integration/mdm/{id} Up
Updates an MDM record, creating it if no record is found with that DBID (modifyObject38)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body MdmDevice (optional)
Body Parameter —

Return type
BaseResult

214/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /settings/integration/mdm/{id}/poll Up
Polls and resynchronizes with an MDM service (pollMdmService)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/mdm/{id}/test Up
Tests connection with the MDM server, but does not update or synchronize (testMdmService)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

MacExclusion

POST /settings/device/mac-exclusion Up
Adds a Mac Exclusion range (addMacExclusionRange)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
startMac (required)
Form Parameter —

215/615
1/21/22, 11:27 AM FortiNAC REST Schema

endMac (required)
Form Parameter —
dbid (required)
Form Parameter — format: int64
name (required)
Form Parameter —
startMac (required)
Form Parameter —
endMac (required)
Form Parameter —
dbid (required)
Form Parameter — format: int64
name (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/mac-exclusion/delete Up
Delete a Mac Exclusion range (deleteMacExclusionRange)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
dbid (optional)
Form Parameter — format: int64
dbid (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/device/mac-exclusion Up
Returns the currently configured Mac Exclusion Ranges (getMacExclusionProperties)

Return type
MacExclusionPropertiesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

216/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
MacExclusionPropertiesResult

MessageTemplate

POST /settings/integration/message-template Up
Creates a new Message Template record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject39)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body MessageTemplate (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/message-template/delete Up
Deletes a list of Message Template records supplied under the id parameter (deleteMultiple43)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/message-template/{id} Up
Deletes a single Message Template record by ID (deleteSingle43)

217/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/message-template/{id}/delete Up
Deletes a single Message Template record by ID (deleteViaPost43)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/message-template Up
Returns a list of Message Template records matching the supplied filter (getByFilter53)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
MessageTemplateResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
MessageTemplateResult

218/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/integration/message-template/{id} Up
Returns a list of Message Template records matching the supplied filter (getByID50)

Path parameters
id (required)
Path Parameter — format: int64

Return type
MessageTemplateResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
MessageTemplateResult

GET /settings/integration/message-template/{id}/usage Up
Returns a list of records that reference this Message Template record (getObjectUsage35)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/integration/message-template/{id} Up
Updates an Message Template record, creating it if no record is found with that DBID (modifyObject39)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body MessageTemplate (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

219/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/message-template/test Up
Previews the supplied Message Template with the supplied context (testMessageTemplate)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body TestMessageTemplateRequest (optional)
Body Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

NetworkAddress

POST /settings/device/network-address Up
Creates a new Address record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject35)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body NetworkAddress (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/network-address/delete Up
Deletes a list of Address records supplied under the id parameter (deleteMultiple39)

Consumes
This API call consumes the following media types via the Content-Type request header:

220/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/device/network-address/{id} Up
Deletes a single Address record by ID (deleteSingle39)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/network-address/{id}/delete Up
Deletes a single Address record by ID (deleteViaPost39)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/device/network-address Up
Returns a list of Address records matching the supplied filter (getByFilter49)

221/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
NetworkAddressResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkAddressResult

GET /settings/device/network-address/{id} Up
Returns a list of Address records matching the supplied filter (getByID46)

Path parameters
id (required)
Path Parameter — format: int64

Return type
NetworkAddressResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkAddressResult

GET /settings/device/network-address/{id}/usage Up
Returns a list of records that reference this Address record (getObjectUsage31)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

222/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/device/network-address/{id} Up
Updates an Address record, creating it if no record is found with that DBID (modifyObject35)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body NetworkAddress (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

NetworkAddressGroup

POST /settings/device/network-address-group Up
Creates a new Address record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject34)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body NetworkAddressGroup (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/network-address-group/delete Up
Deletes a list of Address records supplied under the id parameter (deleteMultiple38)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data
223/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/device/network-address-group/{id} Up
Deletes a single Address record by ID (deleteSingle38)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/network-address-group/{id}/delete Up
Deletes a single Address record by ID (deleteViaPost38)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/device/network-address-group Up
Returns a list of Address records matching the supplied filter (getByFilter48)

Query parameters
filter (optional)
224/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
NetworkAddressGroupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkAddressGroupResult

GET /settings/device/network-address-group/{id} Up
Returns a list of Address records matching the supplied filter (getByID45)

Path parameters
id (required)
Path Parameter — format: int64

Return type
NetworkAddressGroupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkAddressGroupResult

GET /settings/device/network-address-group/{id}/usage Up
Returns a list of records that reference this Address record (getObjectUsage30)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/device/network-address-group/{id} Up

225/615
1/21/22, 11:27 AM FortiNAC REST Schema
Updates an Address record, creating it if no record is found with that DBID (modifyObject34)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body NetworkAddressGroup (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

NetworkDevice

POST /device/pingable Up
Adds a new pingable device to the database (addNewPingableObject)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PingableRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/snmp Up
Adds a new SNMP device to the database (addNewSNMPObject)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body

226/615
1/21/22, 11:27 AM FortiNAC REST Schema

body AddSNMPDeviceRequest (optional)

Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/delete Up
Deletes the Network Device record or records supplied, if they are none are currently in use (deleteMultiple)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /device/{id} Up
Deletes the Network Device record supplied, if it is not currently in use (deleteSingle)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/{id}/delete Up

227/615
1/21/22, 11:27 AM FortiNAC REST Schema
Deletes the Network Device record supplied, if it is not currently in use (deleteViaPost)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /device Up
Returns all Network Device records which match the supplied filter (getByFilter)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
NetworkDeviceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkDeviceResult

GET /device/{id} Up
Returns the Network Device record with the supplied DBID (getByID)

Path parameters
id (required)
Path Parameter — format: int64

Return type
NetworkDeviceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default

228/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
NetworkDeviceResult

GET /device/count/all Up
Returns the count of all Network Device records in the database (getCountOfAll)

Return type
NetworkDeviceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkDeviceResult

GET /device/count Up
Returns a count of Network Device records matching the supplied filter (getCountOfFilter)

Query parameters
filter (optional)
Query Parameter —

Return type
NetworkDeviceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkDeviceResult

GET /device/monitor/{id} Up
Gets all changes to Network Device records since the Events were last polled (getMonitorChanges)

Path parameters
id (required)
Path Parameter — format: int64

Return type
NetworkDeviceChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkDeviceChangeResult

GET /device/properties Up
Returns the currently configured network device settings (getNetworkDeviceProperties)

Return type
NetworkDevicePropertiesResult

229/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkDevicePropertiesResult

GET /device/{id}/usage Up
Returns a list of Network Device records that reference this record (getObjectUsage)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /device/pingable/{id} Up
Updates an existing pingable device in the database (modifyPingableObject)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PingableRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/snmp/{id} Up
Updates an existing SNMP device in the database (modifySNMPObject)

Path parameters

230/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body UpdateSNMPDeviceRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/move Up
Moves an existing Network Device from one container to other (moveDevicesToDomain)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
isHost (optional)
Form Parameter —
containerID (optional)
Form Parameter — format: int64
deviceID (optional)
Form Parameter — format: int64
isHost (optional)
Form Parameter —
containerID (optional)
Form Parameter — format: int64
deviceID (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/polling/l3 Up
Sets the L3 polling properties for the supplied devices (setL3Polling)

Consumes
231/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
enabled (optional)
Form Parameter —
createRogues (optional)
Form Parameter —
frequencySeconds (optional)
Form Parameter — format: int64
priority (optional)
Form Parameter — format: int32
id (optional)
Form Parameter — format: int64
enabled (optional)
Form Parameter —
createRogues (optional)
Form Parameter —
frequencySeconds (optional)
Form Parameter — format: int64
priority (optional)
Form Parameter — format: int32
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/properties Up
Sets the properties for a Network Device (setNetworkDeviceProperties)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
agentDelayStr (required)
Form Parameter —
minTrapPeriodStr (required)
Form Parameter —
maxTrapPeriodsStr (required)
Form Parameter —
coldWarmTrapDelayStr (required)
Form Parameter —
regDelayStr (required)
Form Parameter —
uplinkCountStr (required)
Form Parameter —
telnetTimeoutStr (required)
Form Parameter —
vlanResetDelayStr (required)

232/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —
vlanSwitchingDelayStr (required)
Form Parameter —
macSpoofDelayStr (required)
Form Parameter —
multiAccessStr (required)
Form Parameter —
multiAccessThreshold (required)
Form Parameter —
ciscoDiscoveryStr (required)
Form Parameter —
lldpDiscoveryStr (required)
Form Parameter —
cdpMaxHopsStr (required)
Form Parameter —
ignoreMacNotifyOnPhoneStr (required)
Form Parameter —
meAccessPolicy (required)
Form Parameter —
vlanSwitchingDelay (required)
Form Parameter —
telnetTimeout (required)
Form Parameter —
agentDelay (required)
Form Parameter —
minTrapPeriod (required)
Form Parameter —
getmaxTrapPeriods (required)
Form Parameter —
coldWarmTrapDelay (required)
Form Parameter —
regDelay (required)
Form Parameter —
uplinkCount (required)
Form Parameter —
vlanResetDelay (required)
Form Parameter —
macSpoofDelay (required)
Form Parameter —
multiAccess (required)
Form Parameter —
ciscoDiscovery (required)
Form Parameter —
lldpDiscovery (required)
Form Parameter —
ciscoDiscoveryMaxHops (required)
Form Parameter —
ignoreMacNotifyOnPhone (required)
Form Parameter —
agentDelayStr (required)
Form Parameter —
minTrapPeriodStr (required)
Form Parameter —
maxTrapPeriodsStr (required)
Form Parameter —
coldWarmTrapDelayStr (required)
Form Parameter —
regDelayStr (required)
Form Parameter —
uplinkCountStr (required)
Form Parameter —
telnetTimeoutStr (required)

233/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —
vlanResetDelayStr (required)
Form Parameter —
vlanSwitchingDelayStr (required)
Form Parameter —
macSpoofDelayStr (required)
Form Parameter —
multiAccessStr (required)
Form Parameter —
multiAccessThreshold (required)
Form Parameter —
ciscoDiscoveryStr (required)
Form Parameter —
lldpDiscoveryStr (required)
Form Parameter —
cdpMaxHopsStr (required)
Form Parameter —
ignoreMacNotifyOnPhoneStr (required)
Form Parameter —
meAccessPolicy (required)
Form Parameter —
vlanSwitchingDelay (required)
Form Parameter —
telnetTimeout (required)
Form Parameter —
agentDelay (required)
Form Parameter —
minTrapPeriod (required)
Form Parameter —
getmaxTrapPeriods (required)
Form Parameter —
coldWarmTrapDelay (required)
Form Parameter —
regDelay (required)
Form Parameter —
uplinkCount (required)
Form Parameter —
vlanResetDelay (required)
Form Parameter —
macSpoofDelay (required)
Form Parameter —
multiAccess (required)
Form Parameter —
ciscoDiscovery (required)
Form Parameter —
lldpDiscovery (required)
Form Parameter —
ciscoDiscoveryMaxHops (required)
Form Parameter —
ignoreMacNotifyOnPhone (required)
Form Parameter —

Return type
NetworkDevicePropertiesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkDevicePropertiesResult

234/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /device/monitor/start Up
Begins collecting changes made to Network Device records matching the supplied filter (startMonitorPolling)

Return type
NetworkDeviceMonitorResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NetworkDeviceMonitorResult

POST /device/monitor/{id}/stop Up
Stops collecting changes made to Network Device records for the specified monitor (stopMonitorPolling)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

PAPacketTransportConfig

POST /settings/agent/pa-packet-transport-config Up
Creates a new Persistent Agent Transport record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject32)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PAPacketTransportConfig (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/agent/pa-packet-transport-config/delete Up
235/615
1/21/22, 11:27 AM FortiNAC REST Schema

Deletes a list of Persistent Agent Transport records supplied under the id parameter (deleteMultiple36)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/agent/pa-packet-transport-config/{id} Up
Deletes a single Persistent Agent Transport record by ID (deleteSingle36)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/agent/pa-packet-transport-config/{id}/delete Up
Deletes a single Persistent Agent Transport record by ID (deleteViaPost36)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

236/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /settings/agent/pa-packet-transport-config/deploy Up
Reinitializes Persistent Agent transports from the configurations in the database (deployTransportConfigs)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/agent/pa-packet-transport-config Up
Returns a list of Persistent Agent Transport records matching the supplied filter (getByFilter46)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
PAPacketTransportConfigResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PAPacketTransportConfigResult

GET /settings/agent/pa-packet-transport-config/{id} Up
Returns a list of Persistent Agent Transport records matching the supplied filter (getByID43)

Path parameters
id (required)
Path Parameter — format: int64

Return type
PAPacketTransportConfigResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PAPacketTransportConfigResult

237/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/agent/pa-packet-transport-config/{id}/usage Up
Returns a list of Persistent Agent Transport records that reference this record (getObjectUsage28)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /settings/agent/pa-packet-transport-config/performance Up
Reinitializes Persistent Agent transports from the configurations in the database (getPATransportConfigPerformance)

Return type
PAPacketPerformanceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PAPacketPerformanceResult

POST /settings/agent/pa-packet-transport-config/{id} Up
Updates an Persistent Agent Transport record, creating it if no record is found with that DBID (modifyObject32)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PAPacketTransportConfig (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

238/615
1/21/22, 11:27 AM FortiNAC REST Schema

PatchManagement

POST /settings/integration/patch-management Up
Adds a new Patch Management server (addPatchMgmtServer)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PatchManagementServer (required)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/patch-management Up
Returns all Patch Management Server records (getAllPatchMgmtServers)

Return type
PatchManagementResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PatchManagementResult

POST /settings/integration/patch-management/properties/big-fix/{id} Up
set BigFix server properties (setBigFixProperties)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
bigFixPort (optional)
Form Parameter — format: int32
bigFixUser (optional)
Form Parameter —
bigFixName (optional)
Form Parameter —
bigFixPassword (optional)
239/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —
pollingInterval (optional)
Form Parameter —
bigFixPort (optional)
Form Parameter — format: int32
bigFixUser (optional)
Form Parameter —
bigFixName (optional)
Form Parameter —
bigFixPassword (optional)
Form Parameter —
pollingInterval (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/patch-management/test/{id} Up
Test BigFix Server connection (testBigFixConnection)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

Policy

POST /policy/endpoint-compliance/custom-scan Up
Adds a new Custom Scan for the supplied OS of the supplied type (addModifyCustomScan)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
osName (required)
Form Parameter —
csType (required)
Form Parameter —
scanName (required)
Form Parameter —
240/615
1/21/22, 11:27 AM FortiNAC REST Schema

formData (required)
Form Parameter —
isModify (required)
Form Parameter —
modify (required)
Form Parameter —
global (required)
Form Parameter —
osName (required)
Form Parameter —
csType (required)
Form Parameter —
scanName (required)
Form Parameter —
formData (required)
Form Parameter —
isModify (required)
Form Parameter —
modify (required)
Form Parameter —
global (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance-configuration Up
Creates a new Endpoint Compliance Configuration record, updating instead if the supplied profile has a DBID of one that already exists
(addNewObject16)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EPCConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance Up

241/615
1/21/22, 11:27 AM FortiNAC REST Schema
Creates a new Endpoint Compliance Policy record, updating instead if the supplied profile has a DBID of one that already exists
(addNewObject17)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EPCPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance/custom-scan/delete Up
Deletes s custom scan uniquely identified by it's combination of OS, scan type, and scan name (deleteCustomScan)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
os (optional)
Form Parameter —
scanType (optional)
Form Parameter —
scanName (optional)
Form Parameter —
os (optional)
Form Parameter —
scanType (optional)
Form Parameter —
scanName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance-configuration/delete Up
Deletes a list of Endpoint Compliance Configuration records supplied under the id parameter (deleteMultiple20)

Consumes
This API call consumes the following media types via the Content-Type request header:

242/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance/delete Up
Deletes a list of Endpoint Compliance Policy records supplied under the id parameter (deleteMultiple21)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/endpoint-compliance-configuration/{id} Up
Deletes a single Endpoint Compliance Configuration record by ID (deleteSingle20)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
243/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

DELETE /policy/endpoint-compliance/{id} Up
Deletes a single Endpoint Compliance Policy record by ID (deleteSingle21)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance-configuration/{id}/delete Up
Deletes a single Endpoint Compliance Configuration record by ID (deleteViaPost20)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance/{id}/delete Up
Deletes a single Endpoint Compliance Policy ecord by ID (deleteViaPost21)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

244/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /policy/endpoint-compliance/{id}/disable Up
Disables the supplied Endpoint Compliance Policy (disableItem7)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance/{id}/enable Up
Enables the supplied Endpoint Compliance Policy (enableItem7)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/endpoint-compliance-configuration Up
Returns a list of Endpoint Compliance Configuration records matching the supplied filter (getByFilter25)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
EPCConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

245/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
EPCConfigurationResult

GET /policy/endpoint-compliance Up
Returns a list of Endpoint Compliance Policy records matching the supplied filter (getByFilter26)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
EPCPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EPCPolicyResult

GET /policy/endpoint-compliance-configuration/{id} Up
Returns a list of Endpoint Compliance Configuration records matching the supplied filter (getByID25)

Path parameters
id (required)
Path Parameter — format: int64

Return type
EPCConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EPCConfigurationResult

GET /policy/endpoint-compliance/{id} Up
Returns a list of Endpoint Compliance Policy records matching the supplied filter (getByID26)

Path parameters
id (required)
Path Parameter — format: int64

Return type
EPCPolicyResult
Produces

246/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EPCPolicyResult

GET /policy/endpoint-compliance/custom-scan/html Up
Returns the HTML content of a custom scan for the supplied OS, Scan Type, and Scan Name (getCustomScanHTML)

Query parameters
os (optional)
Query Parameter —
type (optional)
Query Parameter —
scanName (optional)
Query Parameter —

Return type
HTMLContentResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HTMLContentResult

GET /policy/endpoint-compliance/custom-scan/usage Up
Returns a list of records that reference this Custom Scan record (getCustomScanUsage)

Query parameters
os (optional)
Query Parameter —
scanType (optional)
Query Parameter —
scanName (optional)
Query Parameter —

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /policy/endpoint-compliance/custom-scan Up
Returns all Custom Scans currently stored on the filesystem (getCustomScans)

Return type
CustomScansResult
Produces

247/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
CustomScansResult

GET /policy/endpoint-compliance-configuration/{id}/usage Up
Returns a list of records that reference this Endpoint Compliance Configuration record (getObjectUsage14)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /policy/endpoint-compliance/{id}/usage Up
Returns a list of Endpoint Compliance Policy records that reference this record (getObjectUsage15)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /policy/endpoint-compliance-configuration/supporting-info Up
Returns the information used to create an Endpoint Compliance Configuration (getSupportingEPCConfigInfo)

Return type
EPCConfigurationSupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EPCConfigurationSupportingInfoResult

248/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /policy/endpoint-compliance/supporting-info Up
Returns the information used to create an Endpoint Compliance Policy (getSupportingEPCPolicyInfo)

Return type
EPCPolicySupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EPCPolicySupportingInfoResult

POST /policy/endpoint-compliance-configuration/{id} Up
Updates an Endpoint Compliance Configuration record, creating it if no record is found with that DBID (modifyObject16)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EPCConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/endpoint-compliance/{id} Up
Updates an Endpoint Compliance Policy record, creating it if no record is found with that DBID (modifyObject17)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EPCPolicy (optional)
Body Parameter —

Return type
BaseResult

249/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/endpoint-compliance/custom-scan/global-save Up
Deprecated. Updates the NCM to store the list of configured scans for distribution to managed pods (saveGlobalCustomScansList)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance/rank/set Up
Sets the rank of the supplied Endpoint Compliance Policy, shifting other ranks as necessary (setRank4)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/endpoint-compliance/rank/swap Up
Swaps the rank position of the two supplied Endpoint Compliance Policies (swapRanks4)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data
250/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Port

GET /device/port-changes Up
Returns all Port Change records which match the supplied filter (getByFilter1)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
PortChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortChangeResult

GET /device/port Up
Returns a list of Port records matching the supplied filter (getByFilter2)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64

251/615
1/21/22, 11:27 AM FortiNAC REST Schema

sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
PortHBResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortHBResult

GET /device/port-changes/{id} Up
Returns the Port Change record with the supplied DBID (getByID1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
PortChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortChangeResult

GET /device/port/{id} Up
Returns the Port record that matches the provided id (getByID2)

Path parameters
id (required)
Path Parameter — format: int64

Return type
PortHBResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortHBResult

GET /device/port-changes/count/all Up
Returns the count of all Port Change records in the database (getCountOfAll1)

Return type
PortChangeResult
Produces
252/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortChangeResult

GET /device/port/count/all Up
Returns the count of all Port records in the database (getCountOfAll2)

Return type
PortHBResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortHBResult

GET /device/port-changes/count Up
Returns a count of Port Change records matching the supplied filter (getCountOfFilter1)

Query parameters
filter (optional)
Query Parameter —

Return type
PortChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortChangeResult

GET /device/port/count Up
Returns a count of Port records matching the supplied filter (getCountOfFilter2)

Query parameters
filter (optional)
Query Parameter —

Return type
PortHBResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortHBResult

253/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /device/port/monitor/{id} Up
Gets all changes to Port records since they were last polled (getMonitorChanges1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
PortHBChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortHBChangeResult

GET /device/port/feature/port-management Up
When modifying multiple ports at once, lists the number of devices that do and do not allow port management settings
(getPortManagementSupport)

Query parameters
devID (required)
Query Parameter — format: int64

Return type
PortManagementSupportResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortManagementSupportResult

GET /device/port/by-device Up
Returns a summary of all ports associated with the supplied network devices (getPortsForDevices)

Query parameters
devID (optional)
Query Parameter — format: int64

Return type
PortsForDevicesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortsForDevicesResult

POST /device/port/properties Up
Sets administration properties for the port or ports (setPortProperties)

254/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PortPropertiesRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /device/port/monitor/start Up
Begins collecting changes made to Port records matching the supplied filter (startMonitorPolling1)

Return type
PortHBMonitorResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortHBMonitorResult

POST /device/port/monitor/{id}/stop Up
Stops collecting changes made to Port records for the specified monitor (stopMonitorPolling1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

PortalPolicy

POST /policy/portal Up
Creates a new portal policy record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject21)

Consumes
This API call consumes the following media types via the Content-Type request header:
255/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Request body
body PortalPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/portal/delete Up
Deletes a list of portal policy records supplied under the id parameter (deleteMultiple25)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/portal/{id} Up
Deletes a single portal policy record by ID (deleteSingle25)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

256/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /policy/portal/{id}/delete Up
Deletes a single portal policy record by ID (deleteViaPost25)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/portal/{id}/disable Up
Disables the supplied portal policy (disableItem8)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/portal/{id}/enable Up
Enables the supplied portal policy (enableItem8)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/portal Up
Returns a list of portal policy records matching the supplied filter (getByFilter31)

257/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
PortalPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortalPolicyResult

GET /policy/portal/{id} Up
Returns a list of portal policy records matching the supplied filter (getByID30)

Path parameters
id (required)
Path Parameter — format: int64

Return type
PortalPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortalPolicyResult

GET /policy/portal/supporting-info Up
Returns the information used to create portal policies (getSupportingPortalPolicyInfo)

Return type
PortalPolicySupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PortalPolicySupportingInfoResult

POST /policy/portal/{id} Up
Updates an portal policy record, creating it if no record is found with that DBID (modifyObject21)

258/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PortalPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/portal/rank/set Up
Sets the rank of the supplied portal policy, shifting other ranks as necessary (setRank5)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/portal/rank/swap Up
Swaps the rank position of the two supplied portal policies (swapRanks5)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data
259/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Quarantine

GET /settings/device/quarantine Up
Returns the currently configured Quarantine Properties (getQuarantineProperties)

Return type
QuarantinePropertiesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
QuarantinePropertiesResult

POST /settings/device/quarantine/mark-all-hosts-safe Up
Sets all the hosts from Risk State to Safe (markAllHostsSafe)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/device/quarantine Up
Sets the Quarantine properties (setQuarantineProperties)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

260/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
quarantineVlanSwitching (required)
Form Parameter —
quarantineVlanSwitching (required)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

RadiusAttributeGroupConfiguration

DELETE /radius/attrgroups/modelcfg/{deviceId} Up
Clear the RADIUS attribute group ID (if one exists) for the model configuration ID, or if specified it's logical network
(clearModelConfigAttrGroupId)

Path parameters
deviceId (required)
Path Parameter — format: int64

Query parameters
logicalNetwork (optional)
Query Parameter —

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
BooleanResult

POST /radius/attrgroups Up
Create new RADIUS attribute group (createGroup)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body
body RadiusAttributeGroupWrapper (required)
Body Parameter —

Return type
RadiusAttributeGroupWrapperResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

261/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
RadiusAttributeGroupWrapperResult

POST /radius/attrgroups/delete Up
Delete multiple RADIUS attribute groups by ID (deleteDictionaryEntry2)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
BooleanResult

DELETE /radius/attrgroups/{id} Up
Delete RADIUS attribute group by ID (deleteGroup)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RadiusAttributeGroupResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
RadiusAttributeGroupResult

GET /radius/attrgroups/name/{groupName} Up
Get RADIUS attribute group by name (getGroup)

Path parameters
groupName (required)
Path Parameter —

Return type
RadiusAttributeGroupWrapperResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

262/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
RadiusAttributeGroupWrapperResult

GET /radius/attrgroups/{attrGroupId} Up
Get RADIUS attribute group w/ specified ID (getGroup1)

Path parameters
attrGroupId (required)
Path Parameter — format: int64

Return type
RadiusAttributeGroupWrapperResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
RadiusAttributeGroupWrapperResult

GET /radius/attrgroups/list Up
Get list of defined RADIUS attribute groups, returns name and id of each (getGroupList)

Return type
RadiusAttributeGroupNameListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
RadiusAttributeGroupNameListResult

GET /radius/attrgroups Up
Get all defined RADIUS attribute groups, or if provided those matching specified filter (getGroups)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int32
count (optional)
Query Parameter — format: int32
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
RadiusAttributeGroupListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
RadiusAttributeGroupListResult

263/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /radius/attrgroups/modelcfg/{deviceId} Up
Get the RADIUS attribute group ID for the specified device ID, or if specified it's logical network (getModelConfigAttrGroupId)

Path parameters
deviceId (required)
Path Parameter — format: int64

Query parameters
logicalNetwork (optional)
Query Parameter —

Return type
NumberResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
NumberResult

Up
GET /radius/attrgroups/responsevalues/{deviceAttrGrpId}/{logicalNetworkAttrGrpId}
Get the response values for the device attribute group ID and logical network attribute group ID (getRadiusResponseValues)

Path parameters
deviceAttrGrpId (required)
Path Parameter — format: int64
logicalNetworkAttrGrpId (required)
Path Parameter — format: int64

Return type
StringMapResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
StringMapResult

GET /radius/attrgroups/{attrGroupId}/usage Up
Get the usage data for the specified attribute group ID (getUsage)

Path parameters
attrGroupId (required)
Path Parameter — format: int64

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
StringResult

264/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /radius/attrgroups/modelcfg/{deviceId}/{attrGroupId} Up
Assign the specified RADIUS attribute group ID to the specified device ID, or if specified it's logical network (setModelConfigAttrGroupId)

Path parameters
deviceId (required)
Path Parameter — format: int64
attrGroupId (required)
Path Parameter — format: int64

Query parameters
logicalNetwork (optional)
Query Parameter —

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
BooleanResult

POST /radius/attrgroups/{id} Up
Update RADIUS attribute group by ID (updateGroup)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body
body RadiusAttributeGroupWrapper (required)
Body Parameter —

Return type
RadiusAttributeGroupWrapperResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
RadiusAttributeGroupWrapperResult

RadiusDictionaryConfiguration

POST /radius/dictionary Up
Create user-defined RADIUS dictionary entry (createDictionaryEntry)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body

265/615
1/21/22, 11:27 AM FortiNAC REST Schema

body RadiusDictionaryEntry (required)

Body Parameter —

Return type
RadiusDictionaryEntryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
RadiusDictionaryEntryResult

DELETE /radius/dictionary/{id} Up
Delete user-defined RADIUS dictionary entry by ID (deleteDictionaryEntry)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
BooleanResult

POST /radius/dictionary/delete Up
Delete multiple user-defined RADIUS dictionary entries by ID (deleteDictionaryEntry1)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
BooleanResult

GET /radius/dictionary Up
Get RADIUS dictionary entries (if filter is specified, matching attribute, vendor, vendorId, isCustom) (getDictionaryEntries)

Query parameters
266/615
1/21/22, 11:27 AM FortiNAC REST Schema

filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int32
count (optional)
Query Parameter — format: int32
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
RadiusDictionary
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
RadiusDictionary

GET /radius/dictionary/attribute/{name} Up
Get RADIUS dictionary entry of the specified name (getDictionaryEntry)

Path parameters
name (required)
Path Parameter —

Return type
RadiusDictionaryEntryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
RadiusDictionaryEntryResult

POST /radius/dictionary/{id} Up
Update user-defined RADIUS dictionary entry by ID (updateDictionaryEntry)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body
body RadiusDictionaryEntry (required)
Body Parameter —

Return type
RadiusDictionaryEntryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

267/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json

Responses
default
Default Response Value
RadiusDictionaryEntryResult

RadiusServerConfiguration

POST /radius/config Up
Create a RADIUS server configuration object (createServerConfig)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body
body RadiusServerConfig (required)
Body Parameter —

Return type
LocalRadiusConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
LocalRadiusConfigurationResult

DELETE /radius/config/{id} Up
Deletes RADIUS server configuration object by ID (deleteServerConfig)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

POST /radius/config/delete Up
Delete multiple RADIUS server configuration objects by ID (deleteServerConfigs)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)

268/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /radius/config/disable Up
Disables the Radius Server service for the system (disableService)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /radius/config/enable Up
Enables the RadiusServer service for the system (enableService)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /radius/config/nas/fixstale/{id} Up
Update all NAS that are configured to use a RADIUS server configuration that no longer exists to use the specified cfg ID (fixStaleNasClients)

Path parameters
id (required)
Path Parameter — format: int64

Return type
LocalRadiusConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
LocalRadiusConfigurationResult

269/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /radius/config/generateFastPacKey Up
Returns a 32 Byte random string for use with EAP-FAST (pac_opaque_key) (generatePacKey)

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /radius/config Up
Returns all RADIUS server configuration objects (getByFilter41)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
LocalRadiusServerConfigListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LocalRadiusServerConfigListResult

GET /radius/config/global Up
Retrieves the global configuration settings for the local RADIUS service (getGlobalConfig)

Return type
LocalRadiusGlobalConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LocalRadiusGlobalConfigurationResult

GET /radius/config/log Up
Retrieves the RADIUS service log (/var/log/radius/radius.log), systemd journal, and output.master entries containing 'RadiusAccess' (getLog)

270/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query parameters
lines (optional)
Query Parameter — format: int32

Return type
RadiusServerLogResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RadiusServerLogResult

GET /radius/config/{id} Up
Returns RADIUS server configuration object by ID (getServerConfig)

Path parameters
id (required)
Path Parameter — format: int64

Return type
LocalRadiusConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LocalRadiusConfigurationResult

GET /radius/config/status Up
Retrieves the current status for the RADIUS service (getServiceStatus)

Return type
RadiusServerStatusResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RadiusServerStatusResult

GET /radius/config/eap-types Up
Returns the list of EAP types that are supported by the Local RADIUS server (getSupportedEapTypes)

Return type
LocalRadiusEapTypesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
271/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
LocalRadiusEapTypesResult

POST /radius/config/{id} Up
Update an existing RADIUS server configuration object (modifyServerConfig)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body
body RadiusServerUpdateConfig (required)
Body Parameter —

Return type
LocalRadiusConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
LocalRadiusConfigurationResult

POST /radius/config/global Up
Set the global Local Radius config that applies to all LocalRadiusConfiguration instances, such as auth port (setGlobalConfig)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body
body RadiusServerGlobalConfig (required)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Role

POST /policy/role-mapping Up
Creates a new role mapping record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject22)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

272/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Request body
body RoleMapping (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/role Up
Creates a new role record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject23)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body Role (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/role-mapping/delete Up
Deletes a list of role mapping records supplied under the id parameter (deleteMultiple26)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

273/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/role/delete Up
Deletes a list of role records supplied under the id parameter (deleteMultiple27)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/role-mapping/{id} Up
Deletes a single role mapping record by ID (deleteSingle26)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/role/{id} Up
Deletes a single role record by ID (deleteSingle27)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces

274/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/role-mapping/{id}/delete Up
Deletes a single role mapping record by ID (deleteViaPost26)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/role/{id}/delete Up
Deletes a single role record by ID (deleteViaPost27)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/role/simple Up
Returns the Name and ID of all Roles (getAllRolesSimple)

Return type
NameIDObjectListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NameIDObjectListResult

275/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /policy/role-mapping Up
Returns a list of role mapping records matching the supplied filter (getByFilter32)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
RoleMappingResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RoleMappingResult

GET /policy/role Up
Returns a list of role records matching the supplied filter (getByFilter33)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
RoleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RoleResult

GET /policy/role-mapping/{id} Up
Returns a list of role mapping records matching the supplied filter (getByID31)

Path parameters
id (required)
Path Parameter — format: int64

276/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
RoleMappingResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RoleMappingResult

GET /policy/role/{id} Up
Returns a list of role records matching the supplied filter (getByID32)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RoleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RoleResult

GET /policy/role-mapping/direct-configuration Up
Returns the current state of the Direct Configuration flag, used for determining if the legacy configuration mode is available
(getDirectConfiguration)

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

GET /policy/role-mapping/{id}/usage Up
Returns a list of records that reference this role mapping record (getObjectUsage20)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

277/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
RecordUsageResult

GET /policy/role/{id}/usage Up
Returns a list of role records that reference this record (getObjectUsage21)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /policy/role-mapping/membership Up
View a list of the role(s) assigned to the selected device or port and the network access ID for that role on the device (getRoleMembership)

Query parameters
elementID (optional)
Query Parameter — format: int64

Return type
RoleMappingResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RoleMappingResult

GET /policy/role/supporting-info Up
Retrieves information necessary to create or modify a role, such as Host and User groups (getSupportingRoleInfo)

Return type
SupportingRoleInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SupportingRoleInfoResult

GET /policy/role-mapping/supporting-info Up
Retrieves information necessary to create or modify a role mapping, such as Roles, Port and Device Groups, and CLI Configurations
(getSupportingRoleMappingInfo)

278/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
SupportingRoleMappingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SupportingRoleMappingInfoResult

POST /policy/role-mapping/{id} Up
Updates an role mapping record, creating it if no record is found with that DBID (modifyObject22)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body RoleMapping (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/role/{id} Up
Updates an role record, creating it if no record is found with that DBID (modifyObject23)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body Role (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

279/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/role-mapping/rank/set Up
Sets the rank of the supplied role mapping, shifting other ranks as necessary (setRank6)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/role/rank/set Up
Sets the rank of the supplied role, shifting other ranks as necessary (setRank7)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

280/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
BaseResult

POST /policy/role-mapping/rank/swap Up
Swaps the rank position of the two supplied role mappings (swapRanks6)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/role/rank/swap Up
Swaps the rank position of the two supplied roles (swapRanks7)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult
281/615
1/21/22, 11:27 AM FortiNAC REST Schema

SMSProvider

POST /settings/integration/sms Up
Adds a new SMS Provider record to the database (addNewObject41)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SMS (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/sms/delete Up
Deletes the SMS Provider record or records supplied, if they are not currently in use (deleteMultiple45)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/sms/{id} Up
Deletes the SMS Provider record supplied, if it is not currently in use (deleteSingle45)

Path parameters
id (required)
Path Parameter — format: int64

Return type
282/615
1/21/22, 11:27 AM FortiNAC REST Schema
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/sms/{id}/delete Up
Deletes the SMS Provider record supplied, if it is not currently in use (deleteViaPost45)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/sms/{id}/disable Up
Disables the supplied SMS Provider (disableItem12)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/sms/{id}/enable Up
Enables the supplied SMS Provider (enableItem12)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

283/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/sms Up
Returns all SMS Provider records which match the supplied filter (getByFilter55)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
SMSResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SMSResult

GET /settings/integration/sms/{id} Up
Returns the SMS Provider record with the supplied DBID (getByID52)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SMSResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SMSResult

GET /settings/integration/sms/count/all Up
Returns the count of all SMS Provider records in the database (getCountOfAll18)

Return type
SMSResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

284/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
SMSResult

GET /settings/integration/sms/count Up
Returns a count of SMS Provider records matching the supplied filter (getCountOfFilter18)

Query parameters
filter (optional)
Query Parameter —

Return type
SMSResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SMSResult

GET /settings/integration/sms/global/max-length Up
Gets the maximum length of SMS messages for all providers (getMobileProviderGlobalMaxLen)

Return type
NumberResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NumberResult

GET /settings/integration/sms/{id}/usage Up
Returns a list of records that reference this SMS Provider record (getObjectUsage37)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/integration/sms/{id} Up

285/615
1/21/22, 11:27 AM FortiNAC REST Schema
Updates an existing SMS Provider record in the database (modifyObject41)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SMS (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/sms/global/max-length Up
Sets the maximum length of SMS messages for all providers (setMobileProviderGlobalMaxLen)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
maxLength (optional)
Form Parameter — format: int64
maxLength (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

ScanResult

POST /host/scan/archive/create Up
Creates a new archive of all scans or a set of scans by ID (archiveScans)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

286/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host/scan/archives Up
Returns the list of archived scan results available on the filesystem (getArchiveNames)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /host/scan Up
Returns all Scan Result records which match the supplied filter (getByFilter13)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
TestResultResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TestResultResult

GET /host/scan/{id} Up

287/615
1/21/22, 11:27 AM FortiNAC REST Schema
Returns the Scan Result record that matches the supplied DBID (getByID13)

Path parameters
id (required)
Path Parameter — format: int64

Return type
TestResultResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TestResultResult

GET /host/scan/count/all Up
Returns the count of all Scan Results in the database (getCountOfAll9)

Return type
TestResultResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TestResultResult

GET /host/scan/count Up
Gets a count of Scan Results that match the provided filter (getCountOfFilter9)

Query parameters
filter (optional)
Query Parameter —

Return type
TestResultResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TestResultResult

GET /host/scan/archive/import/status Up
Returns the percentage completed for the most recent import of a Scan Results archive (getImportArchiveStatus)

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

288/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
StringResult

POST /host/scan/archive/import Up
Imports the contents of a Scan Results archive into the database from the filesystem (importArchive)

Query parameters
name (optional)
Query Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

ScannedApplication

POST /host/scanned-application/delete Up
Deletes a list of Scanned Application records with the supplied database ids (deleteMultiple8)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /host/scanned-application/{id} Up
Deletes a single Scanned Application record by ID (deleteSingle8)

Path parameters
id (required)
Path Parameter — format: int64

Return type

289/615
1/21/22, 11:27 AM FortiNAC REST Schema
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /host/scanned-application/{id}/delete Up
Deletes a single Scanned Application record by ID (deleteViaPost8)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /host/scanned-application Up
Returns a list of Scanned Application records matching the supplied filter (getByFilter10)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
ScannedApplicationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScannedApplicationResult

GET /host/scanned-application/{id} Up
Returns a list of Scanned Application records matching the supplied filter (getByID10)

Path parameters

290/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (required)
Path Parameter — format: int64

Return type
ScannedApplicationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScannedApplicationResult

GET /host/scanned-application/{id}/usage Up
Returns a list of records that reference this Scanned Application record (getObjectUsage6)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /host/scanned-application/for-host Up
Returns all Scanned Applications that exist on the supplied host (getSecurityApplicationsForHost)

Query parameters
hostID (required)
Query Parameter — format: int64

Return type
ScannedApplicationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScannedApplicationResult

POST /host/scanned-application/threat Up
Sets the Threat Level override for a Scanned Application, allowing it to be marked safe or unsafe (setAppThreatOverride)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

291/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
override (optional)
Form Parameter — format: int32
appID (optional)
Form Parameter — format: int64
override (optional)
Form Parameter — format: int32
appID (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Scheduler

POST /system/scheduler/delete Up
Deletes the scheduled task record or records supplied, if they are none are currently in use (deleteMultiple54)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /system/scheduler/{id} Up
Deletes the scheduled task record supplied, if it is not currently in use (deleteSingle53)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.
292/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/scheduler/{id}/delete Up
Deletes the scheduled task record supplied, if it is not currently in use (deleteViaPost53)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/scheduler/{id}/disable Up
Disables the supplied scheduled task (disableItem14)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/scheduler/{id}/enable Up
Enables the supplied scheduled task (enableItem14)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
293/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
BaseResult

GET /system/scheduler/activity-types Up
Returns the full set of activity types known to the scheduler (getAllActionTypes)

Return type
StringMapResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringMapResult

GET /system/scheduler Up
Returns all scheduled task records which match the supplied filter (getByFilter64)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
ScheduledObjectResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScheduledObjectResult

GET /system/scheduler/{id} Up
Returns the scheduled task record with the supplied DBID (getByID61)

Path parameters
id (required)
Path Parameter — format: int64

Return type
ScheduledObjectResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default

294/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
ScheduledObjectResult

GET /system/scheduler/count/all Up
Returns the count of all scheduled task records in the database (getCountOfAll21)

Return type
ScheduledObjectResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScheduledObjectResult

GET /system/scheduler/count Up
Returns a count of scheduled task records matching the supplied filter (getCountOfFilter21)

Query parameters
filter (optional)
Query Parameter —

Return type
ScheduledObjectResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScheduledObjectResult

GET /system/scheduler/{name}/running Up
Returns if the provided scheduled task is currently running (isActivityRunning)

Path parameters
name (required)
Path Parameter —

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

POST /system/scheduler/run Up
Runs one or more scheduled tasks with the supplied IDs (runActivity)

Consumes
This API call consumes the following media types via the Content-Type request header:

295/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

SecurityEvent

GET /policy/security-alarm Up
Returns a list of Security Alarm records matching the supplied filter (getByFilter34)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
SecurityAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityAlarmResult

GET /policy/security-event Up
Returns a list of Security Event records matching the supplied filter (getByFilter35)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —

296/615
1/21/22, 11:27 AM FortiNAC REST Schema

sortDir (optional)
Query Parameter —

Return type
SecurityEventResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityEventResult

GET /policy/security-alarm/{id} Up
Returns a list of Security Alarm records matching the supplied filter (getByID33)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SecurityAlarmResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityAlarmResult

GET /policy/security-event/{id} Up
Returns a list of Security Event records matching the supplied filter (getByID34)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SecurityEventResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityEventResult

GET /policy/security-event-summary/dash-security-hosts-for-alarm Up
Returns a list of hosts that generated the provided alarm for the specified date range. (getHostsForSecurityAlarm)

Query parameters
startDate (optional)
Query Parameter — format: int64
endDate (optional)
Query Parameter — format: int64
297/615
1/21/22, 11:27 AM FortiNAC REST Schema

ruleName (optional)
Query Parameter —

Return type
SecurityAlarmHostsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityAlarmHostsResult

GET /policy/security-event-summary/hosts/remediated Up
Queries all Hosts which were previously disabled by a Security Alarm that has been undone (getHostsRemediated)

Query parameters
startDate (optional)
Query Parameter — format: int64
endDate (optional)
Query Parameter — format: int64

Return type
NumberListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NumberListResult

GET /policy/security-alarm/{id}/monitor Up
Gets all changes to Security Alarms since the alarms were last polled (getMonitorChanges5)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SecurityAlarmChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityAlarmChangeResult

GET /policy/security-event/{id}/monitor Up
Gets all changes to Security Event records since the Events were last polled (getMonitorChanges6)

Path parameters
id (required)
Path Parameter — format: int64
298/615
1/21/22, 11:27 AM FortiNAC REST Schema

Return type
SecurityEventChangeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityEventChangeResult

GET /policy/security-event-summary/hosts/isolated Up
Queries all Hosts which have an active Disabling action from a Security Alarm (getNumberList)

Query parameters
startDate (optional)
Query Parameter — format: int64
endDate (optional)
Query Parameter — format: int64

Return type
NumberListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NumberListResult

GET /policy/security-event-summary/statistics Up
Retrieves overall statistics about Security Events, Security Alarms, and the associated Hosts (getSecurityEventSummary)

Query parameters
startDate (optional)
Query Parameter — format: int64
endDate (optional)
Query Parameter — format: int64

Return type
SecurityEventSummaryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityEventSummaryResult

GET /policy/security-event-summary/alarms/top Up
Returns the least or most frequently appearing Security Alarms as determined by the Rule Text during the specified time range
(getTopSecurityAlarms)

Query parameters
startDate (optional)

299/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter — format: int64
endDate (optional)
Query Parameter — format: int64
numResults (optional)
Query Parameter — format: int32

Return type
TopSecurityAlarmsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TopSecurityAlarmsResult

GET /policy/security-event-summary/hosts/top Up
Returns the least or most frequently appearing Hosts associated with Security Events during the specified time range (getTopSecurityEventHosts)

Query parameters
startDate (optional)
Query Parameter — format: int64
endDate (optional)
Query Parameter — format: int64
minSev (optional)
Query Parameter — format: int32
maxSev (optional)
Query Parameter — format: int32
numResults (optional)
Query Parameter — format: int32
topEvents (optional)
Query Parameter —

Return type
TopSecurityEventHostsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TopSecurityEventHostsResult

GET /policy/security-event-summary/events/top Up
Returns the least or most frequently appearing Security Events as determined by Event Description during the specified time range
(getTopSecurityEvents)

Query parameters
startDate (optional)
Query Parameter — format: int64
endDate (optional)
Query Parameter — format: int64
minSev (optional)
Query Parameter — format: int32
maxSev (optional)
Query Parameter — format: int32
numResults (optional)
Query Parameter — format: int32
300/615
1/21/22, 11:27 AM FortiNAC REST Schema

topEvents (optional)
Query Parameter —

Return type
TopSecurityEventsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TopSecurityEventsResult

POST /policy/security-alarm/monitor/start Up
Begins collecting changes made to Security Alarms matching the supplied filter (startMonitorPolling5)

Return type
SecurityAlarmMonitorResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityAlarmMonitorResult

POST /policy/security-event/monitor/start Up
Begins collecting changes made to Security Event records matching the supplied filter (startMonitorPolling6)

Return type
SecurityEventMonitorResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityEventMonitorResult

POST /policy/security-alarm/{id}/monitor/stop Up
Stops collecting changes made to Security Alarms for the specified monitor (stopMonitorPolling5)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
301/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
BaseResult

POST /policy/security-event/{id}/monitor/stop Up
Stops collecting changes made to Security Event records for the specified monitor (stopMonitorPolling6)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

SecurityEventParser

POST /settings/integration/security-event-parser Up
Creates a new Security Event Parser record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject42)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SecurityEventParser (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/security-event-parser/delete Up
Deletes a list of Security Event Parser records supplied under the id parameter (deleteMultiple46)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

302/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/security-event-parser/{id} Up
Deletes a single Security Event Parser record by ID (deleteSingle46)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/security-event-parser/{id}/delete Up
Deletes a single Security Event Parser record by ID (deleteViaPost46)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/security-event-parser/disable Up
Disables the supplied Security Event Parser (disableItem13)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64

303/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/security-event-parser/enable Up
Enables the supplied Security Event Parser (enableItem13)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/security-event-parser Up
Returns a list of Security Event Parser records matching the supplied filter (getByFilter56)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
SecurityEventParserResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

304/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
SecurityEventParserResult

GET /settings/integration/security-event-parser/{id} Up
Returns a list of Security Event Parser records matching the supplied filter (getByID53)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SecurityEventParserResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityEventParserResult

GET /settings/integration/security-event-parser/{id}/usage Up
Returns a list of records that reference this Security Event Parser record (getObjectUsage38)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /settings/integration/security-event-parser/recent-syslog Up
Returns several recently received syslog messages in pairs of source IP and message text (getRecentSyslog)

Return type
StringPairListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringPairListResult

POST /settings/integration/security-event-parser/{id} Up

305/615
1/21/22, 11:27 AM FortiNAC REST Schema
Updates an Security Event Parser record, creating it if no record is found with that DBID (modifyObject42)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SecurityEventParser (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /settings/integration/security-event-parser/parse-message Up
Attempts to parse a message using the supplied format and delimiters. On a successful parse of a message, the name/value pairs are returned for
the user to use when building a parser (parseSyslogMessage)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
message (optional)
Form Parameter —
format (optional)
Form Parameter — format: int32
delimiter (optional)
Form Parameter —
tagDelimiter (optional)
Form Parameter —
message (optional)
Form Parameter —
format (optional)
Form Parameter — format: int32
delimiter (optional)
Form Parameter —
tagDelimiter (optional)
Form Parameter —

Return type
StringMapResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

306/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
StringMapResult

POST /settings/integration/security-event-parser/{id}/test Up
Tests parsing a text value into a Security Event, including debug information from the parsing process (testParser)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SecurityEventParserFilter (required)
Body Parameter —

Return type
TestSecurityEventParserResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TestSecurityEventParserResult

SecurityRule

POST /policy/security-rule Up
Creates a new Security Rule record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject24)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EventRule (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/security-rule-trigger Up
Creates a new Security Trigger record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject25)

Consumes

307/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EventTrigger (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/security-rule/delete Up
Deletes a list of Security Rule records supplied under the id parameter (deleteMultiple28)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/security-rule-trigger/delete Up
Deletes a list of Security Trigger records supplied under the id parameter (deleteMultiple29)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult

308/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/security-rule/{id} Up
Deletes a single Security Rule record by ID (deleteSingle28)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/security-rule-trigger/{id} Up
Deletes a single Security Trigger record by ID (deleteSingle29)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/security-rule/{id}/delete Up
Deletes a single Security Rule record by ID (deleteViaPost28)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

309/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/security-rule-trigger/{id}/delete Up
Deletes a single Security Trigger record by ID (deleteViaPost29)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/security-rule/{id}/disable Up
Disables the supplied Security Rule (disableItem9)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/security-rule/{id}/enable Up
Enables the supplied Security Rule (enableItem9)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

310/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /policy/security-rule Up
Returns a list of Security Rule records matching the supplied filter (getByFilter36)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
EventRuleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventRuleResult

GET /policy/security-rule-trigger Up
Returns a list of Security Trigger records matching the supplied filter (getByFilter37)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
EventTriggerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventTriggerResult

GET /policy/security-rule/{id} Up
Returns a list of Security Rule records matching the supplied filter (getByID35)

Path parameters
id (required)

311/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path Parameter — format: int64

Return type
EventRuleResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventRuleResult

GET /policy/security-rule-trigger/{id} Up
Returns a list of Security Trigger records matching the supplied filter (getByID36)

Path parameters
id (required)
Path Parameter — format: int64

Return type
EventTriggerResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
EventTriggerResult

GET /policy/security-rule-trigger/{id}/usage Up
Returns a list of records that reference this Security Trigger record (getObjectUsage22)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /policy/security-rule/{id} Up
Updates an Security Rule record, creating it if no record is found with that DBID (modifyObject24)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

312/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Request body
body EventRule (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/security-rule-trigger/{id} Up
Updates an Security Trigger record, creating it if no record is found with that DBID (modifyObject25)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body EventTrigger (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/security-rule/rank/set Up
Sets the rank of the supplied Security Rule, shifting other ranks as necessary (setRank8)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

313/615
1/21/22, 11:27 AM FortiNAC REST Schema

rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/security-rule/rank/swap Up
Swaps the rank position of the two supplied Security Rules (swapRanks8)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

SelfRegistration

POST /user/guest-self-registration/{id}/approve Up
Approves a self registration request, supplying a message back to the user (approveSelfRegistrationRequest)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
guestMessage (optional)
Form Parameter —
314/615
1/21/22, 11:27 AM FortiNAC REST Schema

requestKey (optional)
Form Parameter —
guestMessage (optional)
Form Parameter —
requestKey (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/guest-self-registration/{id}/deny Up
Denies a self registration request, supplying a message back to the user (denySelfRegistrationRequest)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
guestMessage (optional)
Form Parameter —
requestKey (optional)
Form Parameter —
guestMessage (optional)
Form Parameter —
requestKey (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /user/guest-self-registration Up
Returns a list of self registration request records matching the supplied filter (getByFilter68)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64

315/615
1/21/22, 11:27 AM FortiNAC REST Schema

count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
SelfRegRequestResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SelfRegRequestResult

GET /user/guest-self-registration/{id} Up
Returns a list of self registration request records matching the supplied database id (getByID65)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SelfRegRequestResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SelfRegRequestResult

GET /user/guest-self-registration/{id}/details Up
Returns the supplied guest account details for the self registration request (getSelfRegGuestDetails)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringMapResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringMapResult

ServerManagement

POST /system/managed-server Up

316/615
1/21/22, 11:27 AM FortiNAC REST Schema
Adds a new server to be managed by this server. Managed servers will receive configuration from this server. (addServer)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
ip (optional)
Form Parameter —
ip (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /system/properties/license Up
Returns the current license information for this server and all managed servers (getLicenseInfo)

Return type
NCMLicenseInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NCMLicenseInfoResult

GET /system/managed-server/summary Up
Returns the cluster information for all managed servers, listing Control/Application pairs and High Availability servers
(getManagedServerSummaryInfo)

Return type
ServerClusterInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ServerClusterInfoResult

GET /system/properties/hardware Up
Queries hardware status and performance information (getPerformanceInfo)

Return type
PerformanceInfoResult
Produces

317/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PerformanceInfoResult

GET /system/managed-server/{id}/scans Up
Returns all scan configurations available on the requested managed server (getPolicyNames)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /system/managed-server/{id}/properties Up
Returns additional properties about a server that have been set in the manager (getServerProperties)

Path parameters
id (required)
Path Parameter — format: int64

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

POST /system/managed-server/ping Up
Get server data from a POD managed server from the management server (pingServer)

Query parameters
address (optional)
Query Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

318/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
StringResult

POST /system/managed-server/delete Up
Removes a server from management. The server will no longer recieve configuration changes and will be able to manage all locally defined
configurations. (removeServer)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/managed-server/{id}/properties Up
Sets additional properties about a server in the manager (setServerProperties)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
ip (optional)
Form Parameter —
name (optional)
Form Parameter —
ip (optional)
Form Parameter —
name (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

319/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

POST /system/managed-server/sync Up
Synchronizes data from the management server to the managed server (syncToServer)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
serverIP (optional)
Form Parameter —
serverIP (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

ServiceConnector

GET /system/service-connector Up
Returns a summary of all configured Service Connectors (getServiceConnectors)

Return type
ServiceConnectorsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ServiceConnectorsResult

Services

POST /system/ntp Up
Sets the NTP configuration to use for this appliance (saveNTPConfig)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
timezone (optional)
Form Parameter —
NTPAddr (optional)
Form Parameter —

320/615
1/21/22, 11:27 AM FortiNAC REST Schema

IPParam (optional)
Form Parameter —
timezone (optional)
Form Parameter —
NTPAddr (optional)
Form Parameter —
IPParam (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

SupplicantPolicy

POST /policy/supplicant-configuration Up
Creates a new Supplicant Configuration record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject26)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SupplicantConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/supplicant Up
Creates a new Supplicant Policy record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject27)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SupplicantPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces
321/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/supplicant-configuration/delete Up
Deletes a list of Supplicant Configuration records supplied under the id parameter (deleteMultiple30)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/supplicant/delete Up
Deletes a list of Supplicant Policy records supplied under the id parameter (deleteMultiple31)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/supplicant-configuration/{id} Up
322/615
1/21/22, 11:27 AM FortiNAC REST Schema

Deletes a single Supplicant Configuration record by ID (deleteSingle30)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /policy/supplicant/{id} Up
Deletes a single Supplicant Policy record by ID (deleteSingle31)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/supplicant-configuration/{id}/delete Up
Deletes a single Supplicant Configuration record by ID (deleteViaPost30)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/supplicant/{id}/delete Up
Deletes a single Supplicant Policy record by ID (deleteViaPost31)

Path parameters
id (required)
323/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/supplicant/{id}/disable Up
Disables the supplied Supplicant Policy (disableItem10)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/supplicant/{id}/enable Up
Enables the supplied Supplicant Policy (enableItem10)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/supplicant-configuration Up
Returns a list of Supplicant Configuration records matching the supplied filter (getByFilter38)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
324/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
SupplicantConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SupplicantConfigurationResult

GET /policy/supplicant Up
Returns a list of Supplicant Policy records matching the supplied filter (getByFilter39)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
SupplicantPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SupplicantPolicyResult

GET /policy/supplicant-configuration/{id} Up
Returns a list of Supplicant Configuration records matching the supplied filter (getByID37)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SupplicantConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default

325/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
SupplicantConfigurationResult

GET /policy/supplicant/{id} Up
Returns a list of Supplicant Policy records matching the supplied filter (getByID38)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SupplicantPolicyResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SupplicantPolicyResult

GET /policy/supplicant-configuration/{id}/usage Up
Returns a list of Supplicant Configuration records that reference this record (getObjectUsage23)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /policy/supplicant/supporting-info Up
Returns the information used to create a Supplicant Policy (getSupportingSupplicantPolicyInfo)

Return type
SupplicantPolicySupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SupplicantPolicySupportingInfoResult

GET /policy/supplicant-configuration/supporting-info Up
Returns the information necessary to create a Supplicant Configuration (getSupportingSupplicantProfileInfo)

Return type
SupplicantConfigurationSupportingInfoResult

326/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SupplicantConfigurationSupportingInfoResult

POST /policy/supplicant-configuration/{id} Up
Updates an Supplicant Configuration record, creating it if no record is found with that DBID (modifyObject26)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SupplicantConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /policy/supplicant/{id} Up
Updates an Supplicant Policy record, creating it if no record is found with that DBID (modifyObject27)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SupplicantPolicy (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

327/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
200
Default Response Value
BaseResult

POST /policy/supplicant/rank/set Up
Sets the rank of the supplied Supplicant Policy, shifting other ranks as necessary (setRank9)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
rank (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/supplicant/rank/swap Up
Swaps the rank position of the two supplied Supplicant Policies (swapRanks9)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64
id1 (optional)
Form Parameter — format: int64
id2 (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult
328/615
1/21/22, 11:27 AM FortiNAC REST Schema

Syslog

POST /settings/integration/syslog Up
Creates a new syslog parser record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject43)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SecurityEventParser (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/syslog/delete Up
Deletes a list of syslog parser records supplied under the id parameter (deleteMultiple47)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/syslog/{id} Up
Deletes a single syslog parser record by ID (deleteSingle47)

Path parameters
id (required)
Path Parameter — format: int64

Return type
329/615
1/21/22, 11:27 AM FortiNAC REST Schema
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/syslog/{id}/delete Up
Deletes a single syslog parser record by ID (deleteViaPost47)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/syslog/{id}/disable Up
Disables the Syslog Parser, allowing it to process Syslog messages (disableSyslogFiles)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/syslog/{id}/enable Up
Enables the Syslog Parser, allowing it to process Syslog messages (enableSyslogFiles)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

330/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/syslog Up
Returns a list of syslog parser records matching the supplied filter (getByFilter57)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
SecurityEventParserResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityEventParserResult

GET /settings/integration/syslog/{id} Up
Returns a list of syslog parser records matching the supplied filter (getByID54)

Path parameters
id (required)
Path Parameter — format: int64

Return type
SecurityEventParserResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SecurityEventParserResult

GET /settings/integration/syslog/{id}/usage Up
Returns a list of records that reference this syslog parser record (getObjectUsage39)

Path parameters
id (required)
Path Parameter — format: int64

Return type

331/615
1/21/22, 11:27 AM FortiNAC REST Schema
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/integration/syslog/{id} Up
Updates an syslog parser record, creating it if no record is found with that DBID (modifyObject43)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body SecurityEventParser (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

System

POST /system/local-properties/license/apply Up
Applies a new license key to this appliance (applyLicense)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
licenseKey (optional)
Form Parameter —
licenseKey (optional)
Form Parameter —

Return type
ApplyLicenseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml
332/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
ApplyLicenseResult

POST /system/local-properties/passwords/change Up
Changes the previously configured passwords for the appliance (changeExistingDefaultPasswords)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body PasswordChangeRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/debug/elements/attributes/set Up
Set one or more attributes stored by the system on the elements of a given type and DBID. Allowed types are host, adapter, user, device, and
nselem (debugAddAttribute)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Query parameters
type (optional)
Query Parameter —
id (optional)
Query Parameter — format: int64

Form parameters
attrName (optional)
Form Parameter —
attrVal (optional)
Form Parameter —
isModify (optional)
Form Parameter —
attrName (optional)
Form Parameter —
attrVal (optional)
Form Parameter —
isModify (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

333/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/debug/elements/attributes/delete Up
Deletes one or more attributes stored by the system on the elements of a given type and DBID. Allowed types are host, adapter, user, device, and
nselem (debugDeleteAttribute)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Query parameters
type (optional)
Query Parameter —
id (optional)
Query Parameter — format: int64

Form parameters
attrName (optional)
Form Parameter —
attrName (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /system/debug/database/table/data Up
Queries the table and returns the results of the query as a JSON array (debugGetDBTableData)

Query parameters
countOnly (optional)
Query Parameter —
name (optional)
Query Parameter —
filters (required)
Query Parameter —

Return type
DebugTableDataResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DebugTableDataResult

334/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /system/debug/database/tables Up
Returns a summary of all tables in the database (debugGetDBTableNames)

Return type
DatabaseTableSummaryResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
DatabaseTableSummaryResult

GET /system/debug/elements Up
Returns Name/ID pairs of the elements of a given type. Allowed types are host, adapter, user, and device (debugGetElements)

Query parameters
type (optional)
Query Parameter —
id (optional)
Query Parameter — format: int64
name (optional)
Query Parameter —

Return type
NameIDObjectListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NameIDObjectListResult

GET /system/debug/plugin/resources/reloaders Up
Returns the list of plugins able to dynamically reload system resources (debugGetPropertyReloaders)

Return type
StringListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringListResult

GET /system/debug/database/relations Up
Queries the relations table, a polymorphic associative table between various other tables. (debugGetRelationTableData)

Query parameters
relType (optional)
Query Parameter — format: byte
leftType (optional)

335/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter — format: byte
rightType (optional)
Query Parameter — format: byte
leftID (optional)
Query Parameter — format: byte
rightID (optional)
Query Parameter — format: byte

Return type
RelationTableDataResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RelationTableDataResult

POST /system/debug/plugin/resources/reload Up
Issues a request for the plugin to reload system resources or device mappings, if supported (debugReloadProperties)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Query parameters
name (optional)
Query Parameter —

Form parameters
reloadType (optional)
Form Parameter —
reloadType (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/debug/gui/snapshot Up
Sends an e-mail to FortiNAC support using the configured SMTP server containing a provided snapshot from the GUI (emailSnapshot)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
recipient (optional)
Form Parameter —
subject (optional)
336/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —
message (optional)
Form Parameter —
recipient (optional)
Form Parameter —
subject (optional)
Form Parameter —
message (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /system/debug/gui Up
Deprecated, but may be reintroduced in future releases. Returns if the server is currently configured to send developmental versions of
JavaScript files (getGUIDebugScripts)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /system/debug/gui/experiments Up
Returns if the GUI is currently configured to display any experimental or early development features (getGUIExperimentalFeatures)

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

GET /system/local-properties/license/concurrent Up
Returns the number of used licenses per device and summaries of the results (getLicenseInUseConcurrent)

Query parameters
host (optional)
Query Parameter —

Return type
ConcurrentLicenseUsageResult
337/615
1/21/22, 11:27 AM FortiNAC REST Schema

Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ConcurrentLicenseUsageResult

GET /system/local-properties/license Up
Returns the current license information for this server (getLicenseInfo1)

Return type
LicenseInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LicenseInfoResult

GET /system/debug/elements/attributes Up
Returns attributes stored by the system on the elements of a given type and DBID. Allowed types are host, adapter, user, device, and nselem
(getObjectAttributes)

Query parameters
type (optional)
Query Parameter —
id (optional)
Query Parameter — format: int64

Return type
GetAttributesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
GetAttributesResult

GET /system/debug/log Up
Returns the requested number of lines from the tail of one of the log files on the system (getOutputLog)

Query parameters
logName (optional)
Query Parameter —
tailLog (optional)
Query Parameter —
lastKnownLogLength (optional)
Query Parameter — format: int64
logLines (optional)
Query Parameter —
hostName (optional)
Query Parameter —

338/615
1/21/22, 11:27 AM FortiNAC REST Schema

filter (optional)
Query Parameter —

Return type
OutputLogResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
OutputLogResult

GET /system/debug/plugin-performance Up
Gets the current performance statistics for the supplied plugin (getPerformanceData)

Query parameters
pluginName (optional)
Query Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /system/local-properties/hardware Up
Queries hardware status and performance information (getPerformanceInfo1)

Return type
HardwareInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
HardwareInfoResult

GET /system/local-properties/hardware/performance Up
Queries hardware performance information only (getPerformanceSummary)

Return type
HardwarePerformanceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
339/615
1/21/22, 11:27 AM FortiNAC REST Schema
Default Response Value
HardwarePerformanceResult

GET /system/debug/plugin-status Up
Returns the debug status for all plugins (getPluginDebug)

Return type
PluginDebugResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PluginDebugResult

GET /system/local-properties/software-details Up
Returns the current version and system information for this server (getSoftwareDetails)

Return type
ServiceDocument
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ServiceDocument

GET /system/local-properties/cluster Up
Returns all of the servers in the local cluster, composed of the Control/Application pair and any High Availability servers (getSummaryInfo)

Query parameters
ncmServers (optional)
Query Parameter —

Return type
ServerClusterResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ServerClusterResult

GET /system/local-properties/config-status Up
(getSystemConfigStatus)

Return type
ConfigStatusResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

340/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
ConfigStatusResult

POST /system/local-properties/cluster/application/primary/restart Up
Restarts the Primary Application server in this cluster (restartPrimaryApplicationServer)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/local-properties/cluster/control/primary/restart Up
Restarts the Primary Control server in this cluster (restartPrimaryControlServer)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/debug/gui Up
Deprecated, but may be reintroduced in future releases. Enables the server to send developmental versions of the JavaScript files with full debug
available (setGUIDebugScripts)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
enabled (optional)
Form Parameter —
enabled (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

341/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /system/local-properties/system/initialize Up
Sets initial passwords for the CLI and the Administrative UI and configures the NMAP service. This does not change the CLI passwords immediately,
as the final values are written by the Config Wizard. (setInitialSystemProperties)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body InitialSystemPropertiesRequest (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/local-properties/hardware/thresholds Up
Set the hardware performance thresholds, providing warnings for high utilization (setPerformanceThresholds)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
warningAttrName (optional)
Form Parameter —
warningAttrVal (optional)
Form Parameter —
criticalAttrName (optional)
Form Parameter —
criticalAttrVal (optional)
Form Parameter —
warningAttrName (optional)
Form Parameter —
warningAttrVal (optional)
Form Parameter —
criticalAttrName (optional)
Form Parameter —
criticalAttrVal (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

342/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /system/debug/plugin Up
Sets the debug status to be enabled or disabled for one or more plugins (setPluginDebug)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
enable (optional)
Form Parameter —
plugin (optional)
Form Parameter —
enable (optional)
Form Parameter —
plugin (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

TLSServiceConfiguration

POST /settings/tls-service-configuration Up
Creates a new TLS Service Configuration record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject30)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body TLSServiceConfiguration (optional)
Body Parameter —

Return type
TLSServiceConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TLSServiceConfigurationResult

GET /settings/tls-service-configuration/aliases Up
Returns the list of aliases available to the certificate manager (aliases)

Query parameters
type (optional)

343/615
1/21/22, 11:27 AM FortiNAC REST Schema
Query Parameter —

Return type
CertificateAliasResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
CertificateAliasResult

GET /settings/tls-service-configuration/radiusciphers Up
Returns the list of iana ciphers w/ a corresponding openssl version for use w/ radius (aliases1)

Return type
CipherResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
CipherResult

POST /settings/tls-service-configuration/delete Up
Deletes a list of TLS Service Configuration records supplied under the id parameter (deleteMultiple34)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/tls-service-configuration/{id} Up
Deletes a single TLS Service Configuration record by ID (deleteSingle34)

Path parameters
id (required)
Path Parameter — format: int64

344/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/tls-service-configuration/{id}/delete Up
Deletes a single TLS Service Configuration record by ID (deleteViaPost34)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/tls-service-configuration/deploy Up
Reinitializes Persistent Agent transports from the configurations in the database (deployTransports)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/tls-service-configuration Up
Returns a list of TLS Service Configuration records matching the supplied filter (getByFilter43)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

345/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
TLSServiceConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TLSServiceConfigurationResult

GET /settings/tls-service-configuration/{id} Up
Returns a list of TLS Service Configuration records matching the supplied filter (getByID41)

Path parameters
id (required)
Path Parameter — format: int64

Return type
TLSServiceConfigurationResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TLSServiceConfigurationResult

GET /settings/tls-service-configuration/{id}/usage Up
Returns a list of TLS Service Configuration records that reference this record (getObjectUsage26)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/tls-service-configuration/{id} Up
Updates an TLS Service Configuration record, creating it if no record is found with that DBID (modifyObject30)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

346/615
1/21/22, 11:27 AM FortiNAC REST Schema
Request body
body TLSServiceConfiguration (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Task

POST /system/task Up
Adds a new task record to the database (addNewObject50)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body CommandLineTask (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/task/delete Up
Deletes the taskrecord or records supplied, if they are not currently in use (deleteMultiple55)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
347/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /system/task/{id} Up
Deletes the task record supplied, if it is not currently in use (deleteSingle54)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /system/task/{id}/delete Up
Deletes the task record supplied, if it is not currently in use (deleteViaPost54)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /system/task Up
Returns all task records which match the supplied filter (getByFilter65)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
TaskResult

348/615
1/21/22, 11:27 AM FortiNAC REST Schema
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TaskResult

GET /system/task/{id} Up
Returns the task record with the supplied DBID (getByID62)

Path parameters
id (required)
Path Parameter — format: int64

Return type
TaskResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TaskResult

GET /system/task/count/all Up
Returns the count of all task records in the database (getCountOfAll22)

Return type
TaskResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TaskResult

GET /system/task/count Up
Returns a count of all task records that match the filter specification (getCountOfFilter22)

Query parameters
filter (optional)
Query Parameter —

Return type
TaskResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
TaskResult

349/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /system/task/{id}/usage Up
Returns a list of task records that reference this record (getObjectUsage44)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /system/task/{id} Up
Updates an existing task record in the database (modifyObject51)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body CommandLineTask (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

Update

POST /system/update/test Up
Tests the current System Update settings for auto-definition updates, product distribution, and agent distribution (testSystemUpdateSettings)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
testHost (optional)
Form Parameter —
testAutoDefDir (optional)
350/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —
testProductDistDir (optional)
Form Parameter —
testAgentDistDir (optional)
Form Parameter —
testUser (optional)
Form Parameter —
testPassword (optional)
Form Parameter —
decodePW (optional)
Form Parameter —
protocol (optional)
Form Parameter —
testHost (optional)
Form Parameter —
testAutoDefDir (optional)
Form Parameter —
testProductDistDir (optional)
Form Parameter —
testAgentDistDir (optional)
Form Parameter —
testUser (optional)
Form Parameter —
testPassword (optional)
Form Parameter —
decodePW (optional)
Form Parameter —
protocol (optional)
Form Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

User

POST /user/current-session/accept-usage-policy Up
Performs a login which accepts the Acceptable Usage Policy. The login step must be repeated because the session is not valid until the Acceptable
Usage Policy is accepted (acceptAUP)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded

Form parameters
user (optional)
Form Parameter —
password (optional)
Form Parameter —

Return type
LoginResult
Produces

351/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LoginResult

POST /user/current-session/bookmark Up
Creates a new User Bookmark record, updating instead if the supplied policy has a DBID of one that already exists (addNewObject53)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body UserBookmark (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/current-session/cache Up
Caches a value in the current user session. Use by the GUI for storing temporary values that don't belong in the database (addToUserCache)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
key (optional)
Form Parameter —
value (optional)
Form Parameter —
key (optional)
Form Parameter —
value (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

352/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /user/current-session/bookmark/uuid/{uuid}/delete Up
Deletes a list of User Bookmark records supplied under the id parameter (deleteByUUID)

Path parameters
uuid (required)
Path Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/current-session/bookmark/delete Up
Deletes a list of User Bookmark records supplied under the id parameter (deleteMultiple58)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /user/current-session/bookmark/{id} Up
Deletes a single User Bookmark record by ID (deleteSingle57)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses

353/615
1/21/22, 11:27 AM FortiNAC REST Schema
default
Default Response Value
BaseResult

POST /user/current-session/bookmark/{id}/delete Up
Deletes a single User Bookmark record by ID (deleteViaPost57)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /user/current-session/bookmark Up
Returns a list of User Bookmark records matching the supplied filter (getByFilter69)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
UserBookmarkResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserBookmarkResult

GET /user/attributes/{name} Up
Returns the value currently stored for the requested attribute on the API user (getCurrentUserAttribute)

Path parameters
name (required)
Path Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.
354/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /user/current-session/feature-visibility Up
Returns the currently enabled features for the system. This is a global setting for all users (getFeatureVisibility)

Return type
FeatureVisibilityResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
FeatureVisibilityResult

GET /user/current-session/cache Up
Returns a cached value in the current user session. Used by the GUI for storing temporary values that don't belong in the database
(getFromUserCache)

Query parameters
key (required)
Query Parameter —

Return type
UserCacheResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserCacheResult

GET /user/current-session/navigation-settings Up
Returns the full set of navigation available and favorited by the user, including any custom dashboards and navigation feature settings.
(getNavigationSettings)

Return type
NavigationSettingsResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
NavigationSettingsResult

GET /user/current-session/timeout Up
Returns the number of seconds until the session for the current user expires (getSecondsBeforeUserTimeout)

Return type
355/615
1/21/22, 11:27 AM FortiNAC REST Schema
UserSessionTimeoutResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserSessionTimeoutResult

GET /user/current-session/securityKey Up
Returns the Security Key for the current session that must be appended to every request to verify its source (getSecurityKey)

Return type
LoginResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LoginResult

GET /user/attributes/user/{name} Up
Returns the value currently stored for the requested attribute on the API user (getUserAttribute)

Path parameters
name (required)
Path Parameter —

Query parameters
userID (required)
Query Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

POST /user/current-session/intialize-root-user Up
Performs a login which accepts the Acceptable Usage Policy. The login step must be repeated because the session is not valid until the Acceptable
Usage Policy is accepted (initializeUser)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded

Form parameters
user (optional)
Form Parameter —
password (optional)

356/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form Parameter —
newUserID (optional)
Form Parameter —
newPassword (optional)
Form Parameter —

Return type
LoginResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LoginResult

POST /user/current-session/login Up
Authenticates the user and, if successful, returns the Security Key for the current session that must be appended to every request to verify its
source (login)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded

Form parameters
user (optional)
Form Parameter —
password (optional)
Form Parameter —

Return type
LoginResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
LoginResult

POST /user/current-session/logout Up
Ends and invalidates the current login session (logout)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/current-session/bookmark/{id} Up
Updates an User Bookmark record, creating it if no record is found with that DBID (modifyObject54)

357/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body UserBookmark (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /user/attributes/{name} Up
Sets the value currently stored for the requested attribute on the API user (setCurrentUserAttribute)

Path parameters
name (required)
Path Parameter —

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
value (optional)
Form Parameter —
value (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/current-session/feature-visibility Up
Sets the currently enabled features for the system. This is a global setting for all users (setFeatureVisibility)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml
358/615
1/21/22, 11:27 AM FortiNAC REST Schema
Request body
body FeatureVisibilitySet (required)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/attributes/user/{name} Up
Sets the value currently stored for the requested attribute on the target user (setUserAttribute)

Path parameters
name (required)
Path Parameter —

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
userID (optional)
Form Parameter —
value (optional)
Form Parameter —
userID (optional)
Form Parameter —
value (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/current-session/bookmark/sync Up
Synchronizes the bookmarks for the current user to match the set of supplied UUIDs (syncBookmarks)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body UserBookmarkSyncRequest (optional)
Body Parameter —

359/615
1/21/22, 11:27 AM FortiNAC REST Schema
Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

UserHostProfile

POST /policy/user-host-profile Up
Creates a new User/Host Profile record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject28)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body Profile (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/user-host-profile/delete Up
Deletes a list of User/Host Profile records supplied under the id parameter (deleteMultiple32)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

360/615
1/21/22, 11:27 AM FortiNAC REST Schema

DELETE /policy/user-host-profile/{id} Up
Deletes a single User/Host Profile record by ID (deleteSingle32)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /policy/user-host-profile/{id}/delete Up
Deletes a single User/Host Profile record by ID (deleteViaPost32)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /policy/user-host-profile Up
Returns a list of User/Host Profile records matching the supplied filter (getByFilter40)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
ProfileResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

361/615
1/21/22, 11:27 AM FortiNAC REST Schema
Responses
default
Default Response Value
ProfileResult

GET /policy/user-host-profile/{id} Up
Returns a list of User/Host Profile records matching the supplied filter (getByID39)

Path parameters
id (required)
Path Parameter — format: int64

Return type
ProfileResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ProfileResult

GET /policy/user-host-profile/{id}/usage Up
Returns a list of records that reference this User/Host Profile record (getObjectUsage24)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /policy/user-host-profile/supporting-info Up
Returns a series of related data records used to create User/Host Profiles (getSupportingAccessProfileInfo)

Return type
SupportingUserHostProfileInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
SupportingUserHostProfileInfoResult

POST /policy/user-host-profile/{id} Up
Updates an User/Host Profile record, creating it if no record is found with that DBID (modifyObject28)

362/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body Profile (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

UserRecord

POST /user Up
Adds a new User record to the database (addNewObject54)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body UserRecord (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/delete Up
Deletes the User record or records supplied, if they are not currently in use (deleteMultiple59)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64

363/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /user/{id} Up
Deletes the User record supplied, if it is not currently in use (deleteSingle58)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/{id}/delete Up
Deletes the User record supplied, if it is not currently in use (deleteViaPost58)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/disable Up
Disables the User that matches the supplied DBID (disableByName)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

364/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
userID (optional)
Form Parameter —
userID (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/{id}/disable Up
Disables the User that matches the supplied DBID (disableItem16)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/enable Up
Disables the User that matches the supplied DBID (enableByName)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
userID (optional)
Form Parameter —
userID (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

365/615
1/21/22, 11:27 AM FortiNAC REST Schema

POST /user/{id}/enable Up
Enables the User that matches the supplied DBID (enableItem16)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /user/{id}/get-agent Up
Returns the agent info for a User based on the platform (getAgentForUser)

Path parameters
id (required)
Path Parameter — format: int64

Query parameters
platform (required)
Query Parameter —

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

GET /user Up
Returns all User records which match the supplied filter (getByFilter70)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
UserRecordResult
Produces

366/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserRecordResult

GET /user/{id} Up
Returns the User record with the supplied DBID (getByID66)

Path parameters
id (required)
Path Parameter — format: int64

Return type
UserRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserRecordResult

GET /user/count/all Up
Returns the count of all User records in the database (getCountOfAll25)

Return type
UserRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserRecordResult

GET /user/count Up
Returns a count of User records matching the supplied filter (getCountOfFilter25)

Query parameters
filter (optional)
Query Parameter —

Return type
UserRecordResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
UserRecordResult

367/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /user/{id}/usage Up
Returns a list of records that reference this User record (getObjectUsage46)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /user/{id}/get-policy Up
Returns the policy info for a User based on the provided user id (getPolicyForUser)

Path parameters
id (required)
Path Parameter — format: int64

Return type
PolicyForUserResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
PolicyForUserResult

GET /user/allowed-hosts Up
Returns the number of allowed hosts set per user (getUserHostsProperties)

Return type
StringResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringResult

POST /user/{id} Up
Updates an existing User record in the database (modifyObject55)

Path parameters
id (required)
Path Parameter — format: int64

368/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body UserRecord (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/set-profile Up
Sets the specified Admin Profile for the supplied set of Admin Users (setAdminProfileForUser)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
profileID (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
profileID (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/set-password Up
Sets the password of a local user account (setPasswordForUser)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
userID (optional)
Form Parameter —

369/615
1/21/22, 11:27 AM FortiNAC REST Schema

password (optional)
Form Parameter —
userID (optional)
Form Parameter —
password (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/set-role Up
Sets the Role for a list of Users (setRoleForUsers)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
role (optional)
Form Parameter —
id (optional)
Form Parameter — format: int64
role (optional)
Form Parameter —
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /user/allowed-hosts Up
Sets the limit for number of hosts allowed per user (setUserHostsProperties)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
allowedHosts (optional)
Form Parameter —
allowedHosts (optional)
Form Parameter —

370/615
1/21/22, 11:27 AM FortiNAC REST Schema

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /user/has-hosts Up
Returns a boolean result if the user is the owner of one or more hosts (usersHaveHosts)

Query parameters
id (optional)
Query Parameter —

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

VendorOUI

POST /settings/integration/vendor-oui Up
Adds a new Vendor OUI record to the database (addNewObject44)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body VendorCode (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/vendor-oui/delete Up
Deletes the Vendor OUI record or records supplied, if they are not currently in use (deleteMultiple48)

371/615
1/21/22, 11:27 AM FortiNAC REST Schema
Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/vendor-oui/{id} Up
Deletes the Vendor OUI record supplied, if it is not currently in use (deleteSingle48)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/vendor-oui/{id}/delete Up
Deletes the Vendor OUI record supplied, if it is not currently in use (deleteViaPost48)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

372/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/integration/vendor-oui Up
Returns all Vendor OUI records which match the supplied filter (getByFilter58)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
VendorCodeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
VendorCodeResult

GET /settings/integration/vendor-oui/{id} Up
Returns the Vendor OUI record with the supplied DBID (getByID55)

Path parameters
id (required)
Path Parameter — format: int64

Return type
VendorCodeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
VendorCodeResult

GET /settings/integration/vendor-oui/count/all Up
Returns the count of all Vendor OUI records in the database (getCountOfAll19)

Return type
VendorCodeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
VendorCodeResult

373/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/integration/vendor-oui/count Up
Returns a count of Vendor OUI records matching the supplied filter (getCountOfFilter19)

Query parameters
filter (optional)
Query Parameter —

Return type
VendorCodeResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
VendorCodeResult

GET /settings/integration/vendor-oui/supporting-info Up
Returns the list of Roles and Registration Types used to edit Vendor OUIs (getSupportingOuiInfo)

Return type
VendorOUISupportingInfoResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
VendorOUISupportingInfoResult

POST /settings/integration/vendor-oui/{id} Up
Updates an existing Vendor OUI record in the database (modifyObject44)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body VendorCode (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

374/615
1/21/22, 11:27 AM FortiNAC REST Schema

VulnerabilityScanner

POST /settings/integration/vulnerability-scanner Up
Creates a new vulnerability scanner record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject45)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body ScannerDevice (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/vulnerability-scanner/delete Up
Deletes a list of vulnerability scanner records supplied under the id parameter (deleteMultiple49)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/integration/vulnerability-scanner/{id} Up
Deletes a single vulnerability scanner record by ID (deleteSingle49)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
375/615
1/21/22, 11:27 AM FortiNAC REST Schema

Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/vulnerability-scanner/{id}/delete Up
Deletes a single vulnerability scanner record by ID (deleteViaPost49)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/integration/vulnerability-scanner Up
Returns a list of vulnerability scanner records matching the supplied filter (getByFilter59)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
ScannerDeviceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScannerDeviceResult

GET /settings/integration/vulnerability-scanner/{id} Up
Returns a list of vulnerability scanner records matching the supplied filter (getByID56)

Path parameters
id (required)
376/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path Parameter — format: int64

Return type
ScannerDeviceResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
ScannerDeviceResult

GET /settings/integration/vulnerability-scanner/{id}/usage Up
Returns a list of records that reference this vulnerability scanner record (getObjectUsage40)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

GET /settings/integration/vulnerability-scanner/{id}/qualys-appliances Up
Returns the map of appliance names read from a Qualys vulnerability scanner for the provided id (getQualysApplianceNames)

Path parameters
id (required)
Path Parameter — format: int64

Query parameters
vendor (optional)
Query Parameter —
userID (optional)
Query Parameter —
requestStr (optional)
Query Parameter —
vulnPW (optional)
Query Parameter —

Return type
StringMapResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
StringMapResult

377/615
1/21/22, 11:27 AM FortiNAC REST Schema

GET /settings/integration/vulnerability-scanner/{id}/scans Up
Returns the scan names read from the connected vulnerability scanner based on the provided id (getVulnerabilityScanNames)

Path parameters
id (required)
Path Parameter — format: int64

Query parameters
vendor (optional)
Query Parameter —
userID (optional)
Query Parameter —
requestStr (optional)
Query Parameter —
vulnPW (optional)
Query Parameter —

Return type
VulnerabilityScanNamesResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
VulnerabilityScanNamesResult

POST /settings/integration/vulnerability-scanner/{id} Up
Updates an vulnerability scanner record, creating it if no record is found with that DBID (modifyObject45)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body ScannerDevice (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

POST /settings/integration/vulnerability-scanner/{id}/poll Up
Polls the connection status of a vulnerability scanner to confirm communication based on the provided id (pollVulnerabilityScanner)

378/615
1/21/22, 11:27 AM FortiNAC REST Schema
Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/integration/vulnerability-scanner/{id}/test Up
Tests the connection to a supplied Vulnerability Scanner using supplied credentials to confirm successful communication for the provided id
(testVulnerabilityScannerConnection)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
vendor (optional)
Form Parameter —
userID (optional)
Form Parameter —
requestStr (optional)
Form Parameter —
vulnPW (optional)
Form Parameter —
vendor (optional)
Form Parameter —
userID (optional)
Form Parameter —
requestStr (optional)
Form Parameter —
vulnPW (optional)
Form Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

WebServiceDefinition

POST /settings/security/web-service-definition Up
379/615
1/21/22, 11:27 AM FortiNAC REST Schema

Creates a new Web Service Definition record, updating instead if the supplied profile has a DBID of one that already exists (addNewObject46)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body WebServiceDefinition (optional)
Body Parameter —

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/security/web-service-definition/delete Up
Deletes a list of Web Service Definition records supplied under the id parameter (deleteMultiple50)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

Form parameters
id (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

DELETE /settings/security/web-service-definition/{id} Up
Deletes a single Web Service Definition record by ID (deleteSingle50)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
380/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/security/web-service-definition/{id}/delete Up
Deletes a single Web Service Definition record by ID (deleteViaPost50)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /settings/security/web-service-definition/deploy Up
Writes the Web Service Definitions into an Apache configuration (deployWebServices)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /settings/security/web-service-definition Up
Returns a list of Web Service Definition records matching the supplied filter (getByFilter60)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
WebServiceDefinitionResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

381/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
WebServiceDefinitionResult

GET /settings/security/web-service-definition/{id} Up
Returns a list of Web Service Definition records matching the supplied filter (getByID57)

Path parameters
id (required)
Path Parameter — format: int64

Return type
WebServiceDefinitionResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
WebServiceDefinitionResult

GET /settings/security/web-service-definition/{id}/usage Up
Returns a list of records that reference this Web Service Definition record (getObjectUsage41)

Path parameters
id (required)
Path Parameter — format: int64

Return type
RecordUsageResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
RecordUsageResult

POST /settings/security/web-service-definition/{id} Up
Updates an Web Service Definition record, creating it if no record is found with that DBID (modifyObject46)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json
application/xml

Request body
body WebServiceDefinition (optional)
Body Parameter —

Return type

382/615
1/21/22, 11:27 AM FortiNAC REST Schema
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
200
Default Response Value
BaseResult

WinbindConfiguration

POST /winbind/config Up
Create a Winbind configuration object (createServerConfig1)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body
body WinbindConfig (required)
Body Parameter —

Return type
WinbindConfigResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
WinbindConfigResult

DELETE /winbind/config/{id} Up
Deletes Winbind configuration object by ID (deleteConfig)

Path parameters
id (required)
Path Parameter — format: int64

Return type
BooleanResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BooleanResult

POST /winbind/config/delete Up
Delete multiple winbind configuration objects by ID (deleteServerConfigs1)

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded
multipart/form-data

383/615
1/21/22, 11:27 AM FortiNAC REST Schema
Form parameters
id (optional)
Form Parameter — format: int64
replaceWinbindId (optional)
Form Parameter — format: int64
id (optional)
Form Parameter — format: int64
replaceWinbindId (optional)
Form Parameter — format: int64

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /winbind/config/disable Up
Disables the Winbind service for the system (disableService1)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

POST /winbind/config/enable Up
Enables the Winbind service for the system (enableService1)

Return type
BaseResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
BaseResult

GET /winbind/config/all Up
Return all Winbind configuration objects (getAll)

Return type
WinbindConfigListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

384/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
WinbindConfigListResult

GET /winbind/config Up
Returns all Winbind configuration objects (getByFilter44)

Query parameters
filter (optional)
Query Parameter —
start (optional)
Query Parameter — format: int64
count (optional)
Query Parameter — format: int64
sortKey (optional)
Query Parameter —
sortDir (optional)
Query Parameter —

Return type
WinbindConfigListResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
WinbindConfigListResult

GET /winbind/config/global Up
Retrieves global Winbind service data (currently status & default local netbios name (getGlobalData)

Return type
WinbindGlobalResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
WinbindGlobalResult

GET /winbind/config/log Up
Retrieves the current Winbind service log (/var/log/samba/log.winbind) (getLog1)

Query parameters
lines (optional)
Query Parameter — format: int32

Return type
WinbindLogResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

385/615
1/21/22, 11:27 AM FortiNAC REST Schema
application/xml

Responses
default
Default Response Value
WinbindLogResult

GET /winbind/config/{id} Up
Returns Winbind configuration object by ID (getServerConfig1)

Path parameters
id (required)
Path Parameter — format: int64

Return type
WinbindConfigResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
WinbindConfigResult

GET /winbind/config/status Up
Retrieves the current status for the Winbind service (getServiceStatus1)

Return type
WinbindStatusResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json
application/xml

Responses
default
Default Response Value
WinbindStatusResult

POST /winbind/config/joinDomain/{id} Up
Joins the domain for the Winbind instance specified by id (joinWinbindDomain)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/x-www-form-urlencoded

Form parameters
username (optional)
Form Parameter —
password (optional)
Form Parameter —

Return type
BaseResult
Produces

386/615
1/21/22, 11:27 AM FortiNAC REST Schema
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
BaseResult

POST /winbind/config/{id} Up
Update an existing Winbind configuration object (modifyServerConfig1)

Path parameters
id (required)
Path Parameter — format: int64

Consumes
This API call consumes the following media types via the Content-Type request header:

application/json

Request body
body WinbindConfig (required)
Body Parameter —

Return type
WinbindConfigResult
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type
response header.

application/json

Responses
default
Default Response Value
WinbindConfigResult

Models
[ Jump to Methods ]

Table of Contents

1. AAAServerMapEntry
2. APMIPRange
3. APMIPRangeResult
4. AbstractPermissionsObjectObject
5. AcceptHostImportResult
6. AccessConfiguration
7. AccessConfigurationResult
8. AccessConfigurationSupportingInfoResult
9. AccessPointManagement
10. AccessPointManagementResult
11. AccessPolicy
12. AccessPolicyResult
13. AccessPolicySupportingInfoResult
14. ActionTask
15. AdapterIPAddress
16. AdapterRecordResult
17. AddSNMPDeviceRequest
18. AdminProfile
19. AdminProfileMapping
20. AdminProfileMappingResult
21. AdminProfileMappingSupportingInfoResult
22. AdminProfilePermissions
23. AdminProfileResult
24. AdminUserPermissions
25. AgentDescriptor
26. AgingSettings
27. AgingSettingsResult
28. AlarmAction
29. AlarmCount
387/615
1/21/22, 11:27 AM FortiNAC REST Schema
30. AlarmSupportingInfoResult
31. AlarmTriggerRule
32. ApplyLicenseResult
33. ArrayListString
34. AuditDatabaseObject
35. AuditLogPermissions
36. AuditLogResult
37. AuditRecordType
38. AuthServer
39. AuthServerResult
40. AuthenticationConfiguration
41. AuthenticationConfigurationResult
42. AuthenticationPolicy
43. AuthenticationPolicyResult
44. BackgroundTask
45. BackgroundTaskResult
46. BackupSettingsResult
47. BasePolicyPermissions
48. BaseResult
49. BatchConfigurationRequest
50. BatchPropertiesRequest
51. BodyPart
52. BodyPart_mediaType
53. BooleanMapResult
54. BooleanResult
55. CLICredentials
56. CertificateAliasResult
57. CertificateDeleteResult
58. CertificateMgmtPermissions
59. CertificateSummary
60. CertificateUploadResult
61. CheckResult
62. CipherResult
63. CipherSuite
64. ClientFilter
65. ClientFilterResult
66. ClientRecord
67. CommandLineTask
68. ConcurrentLicenseUsageResult
69. ConferenceAccount
70. ConfigProperties
71. ConfigStatusResult
72. ConfigWizardPermissions
73. ContainerChangeResult
74. ContainerMonitorResult
75. ContainerRoleLong
76. ContainerRoleMappingLong
77. ContainerRoleMappingString
78. ContainerSupplicantConfigurationString
79. ContentDisposition
80. Criterion
81. CustomScanSummary
82. CustomScanTypeRequest
83. CustomScanTypeSummary
84. CustomScansResult
85. DBFilterFieldObject
86. DashboardPermissions
87. DashboardSettings
88. DashboardTile
89. DatabaseArchives
90. DatabaseBackupResult
91. DatabaseBackupSettings
92. DatabaseTableSummaryResult
93. DebugTableDataResult
94. DeleteAAAServerMappingsRequest
95. Device
96. DeviceIdentity
97. DevicePermissions
98. DeviceProfilerProperties
99. DeviceProfilerPropertiesResult
100. DeviceProfilingRulePermissions
101. DeviceSummary
102. DeviceType
103. DeviceTypeDefinition
104. DeviceTypeResult
105. DeviceTypesResult

388/615
1/21/22, 11:27 AM FortiNAC REST Schema
106. DirectoryAgentConfiguration
107. DirectoryAgentConfigurationResult
108. DirectoryAgentGroupItem
109. DiscoveryData
110. DiscoveryRequest
111. DiscoveryStatus
112. DiscoveryStatusResult
113. DiskUsageInfo
114. DpcRule
115. DpcRuleResult
116. DpcRules
117. DynamicClient
118. DynamicClientEntry
119. DynamicClientEntryResult
120. DynamicClientFilterSpecification
121. DynamicClientSummary
122. DynamicClientSummaryResult
123. DynamicConnection
124. DynamicConnectionResult
125. EPCConfiguration
126. EPCConfigurationResult
127. EPCConfigurationSupportingInfoResult
128. EPCPolicy
129. EPCPolicyResult
130. EPCPolicySupportingInfoResult
131. EmailSettings
132. EmailSettingsResult
133. EventAction
134. EventActionActivity
135. EventActionResult
136. EventActionSupportingInfoResult
137. EventAlarmPermissions
138. EventCount
139. EventMapRule
140. EventMappingSupportingInfoResult
141. EventRule
142. EventRuleResult
143. EventThresholds
144. EventThresholdsResult
145. EventToAlarm
146. EventToAlarmResult
147. EventTrigger
148. EventTriggerActivity
149. EventTriggerResult
150. FSSOSettings
151. FSSOSettingsResult
152. FTPBackupRequest
153. FTPBackupResult
154. FailedValidationAction
155. FamilySummary
156. FeatureVisibilityResult
157. FeatureVisibilitySet
158. Fingerprint
159. FingerprintResult
160. FingerprintSource
161. FingerprintSourceResult
162. FingerprintTotals
163. FirewallTag
164. FirewallTagResult
165. FormDataBodyPart
166. FormDataContentDisposition
167. FortigateTelemetryResult
168. GeneralPermissions
169. GenerateCSRParameters
170. GenerateCSRResult
171. GetAttributesResult
172. GoogleClientIDResult
173. Group
174. GroupFilter
175. GroupMemberSummary
176. GroupMembersResult
177. GroupMembershipPermissions
178. GroupPermissions
179. GroupSummary
180. GroupsByTypeResult
181. GuestContractorPermissions

389/615
1/21/22, 11:27 AM FortiNAC REST Schema
182. GuestContractorTemplatePermissions
183. GuestRecord
184. GuestRecordResult
185. GuestTemplate
186. GuestTemplateResult
187. HTMLContentResult
188. HardwareInfoResult
189. HardwarePerformance
190. HardwarePerformanceResult
191. HardwareSummary
192. HealthHistoryResult
193. HostAlarmSummaryCount
194. HostCount
195. HostEventCount
196. HostEventSummaryCount
197. HostFilterSpecification
198. HostImportResult
199. HostPermissions
200. HostRecord
201. HostRecordForUserResult
202. HostRecordResult
203. HostRegistrationRequest
204. HostRegistrationRequestResult
205. HostSummaryDataResult
206. HostSummaryDataType
207. IAuditObject
208. IPRange
209. IPRangeListResult
210. IPersistentObject
211. ImageDescription
212. InitialSystemPropertiesRequest
213. IntegratedRADIUSPermissions
214. JSArrayData
215. JSONObject
216. KeyCountPair
217. L3DeviceScan
218. L3ScanResult
219. L3ScannerStatusResult
220. LDAPConfig
221. LDAPConfigRequest
222. LDAPConfigResult
223. LDAPConfig_tls
224. LicenseContract
225. LicenseInfoResult
226. LicenseInfoSummary
227. LoaderPerformance
228. LoaderSummary
229. LocalRadiusConfigurationResult
230. LocalRadiusEapTypesResult
231. LocalRadiusGlobalConfigurationResult
232. LocalRadiusServerConfigListResult
233. LocateHostsUsersPermissions
234. LogHost
235. LogHostObject
236. LogMgmtPermissions
237. LogReceiversResult
238. LogicalNetwork
239. LogicalNetworkConfiguration
240. LogicalNetworkConfigurationResult
241. LogicalNetworkResult
242. LoginResult
243. LogsPermissions
244. MacExclusion
245. MacExclusionPropertiesResult
246. ManageHostsPortsPermissions
247. ManagedElement
248. ManagedElementFilterSpecification
249. ManagedElementWatcherSpecification
250. ManagedGroupListResult
251. ManagedGroupResult
252. MdmDevice
253. MdmDeviceResult
254. MessageBodyWorkers
255. MessageTemplate
256. MessageTemplateResult
257. MethodData

390/615
1/21/22, 11:27 AM FortiNAC REST Schema
258. MethodType
259. MibObject
260. MibObjectArray
261. ModelConfig
262. MultiPart
263. MultifilterResult
264. NCMLicenseInfoResult
265. NCMPodData
266. NCMPodResult
267. NameIDObjectListResult
268. NameIDPair
269. NameValue
270. NavigationSettingsResult
271. NetworkAddress
272. NetworkAddressGroup
273. NetworkAddressGroupResult
274. NetworkAddressResult
275. NetworkDeviceChangeResult
276. NetworkDeviceMonitorResult
277. NetworkDeviceProperties
278. NetworkDevicePropertiesResult
279. NetworkDeviceResult
280. NetworkDeviceSummaryDetails
281. NetworkDeviceSummaryType
282. NetworkEntity
283. NetworkEntitySummary
284. NumberListResult
285. NumberResult
286. OID
287. OSScanSummary
288. ObjectListResultNetworkDeviceSummaryDetails
289. ObjectListResultNetworkDeviceSummaryType
290. ObjectListResultScanSummaryType
291. ObjectMapResultListNameValue
292. OutputLogResult
293. PAPacketPerformanceResult
294. PAPacketTransportConfig
295. PAPacketTransportConfigResult
296. PAPerformance
297. PairStringString
298. ParameterizedHeader
299. PassiveAgentPermissions
300. PasswordChange
301. PasswordChangeRequest
302. PatchManagementResult
303. PatchManagementServer
304. PerformanceInfoResult
305. PermissionViewMap
306. PersistentObjectUsageCategory
307. PingableRequest
308. PluginDebugResult
309. PluginStatus
310. PolicyForHostResult
311. PolicyForUserResult
312. PolicyHints
313. PolicyPermissions
314. PollingStatus
315. PortChange
316. PortChangeResult
317. PortHB
318. PortHBChangeResult
319. PortHBMonitorResult
320. PortHBResult
321. PortManagementSupportResult
322. PortPropertiesRequest
323. PortSummary
324. PortalConfiguration
325. PortalConfigurationPermissions
326. PortalPolicy
327. PortalPolicyResult
328. PortalPolicySupportingInfoResult
329. PortsForDevicesResult
330. PossibleEventType
331. PossibleEventTypeResult
332. ProductSummary
333. Profile

391/615
1/21/22, 11:27 AM FortiNAC REST Schema
334. ProfileResult
335. ProfiledDevicePermissions
336. PropertiesResult
337. QuarantineProperties
338. QuarantinePropertiesResult
339. RADIUSDefaultsResult
340. RADIUSMethodData
341. RadiusAttrGroupName
342. RadiusAttributeGroup
343. RadiusAttributeGroupEntry
344. RadiusAttributeGroupListResult
345. RadiusAttributeGroupNameListResult
346. RadiusAttributeGroupResult
347. RadiusAttributeGroupWrapper
348. RadiusAttributeGroupWrapperResult
349. RadiusClientPermissions
350. RadiusDictionary
351. RadiusDictionaryEntry
352. RadiusDictionaryEntryResult
353. RadiusDictionaryEntryWrapper
354. RadiusMappingsResult
355. RadiusServerConfig
356. RadiusServerGlobalConfig
357. RadiusServerLogResult
358. RadiusServerStatusResult
359. RadiusServerUpdateConfig
360. RadiusServersList
361. RadiusUserPermissions
362. RecordUsageResult
363. Relation
364. RelationTableDataResult
365. ReportPermissions
366. ReportingPermissions
367. Role
368. RoleMapping
369. RoleMappingResult
370. RolePermissions
371. RoleResult
372. SMS
373. SMSResult
374. SSHBackupRequest
375. SSHBackupResult
376. Scan
377. ScanSummary
378. ScanSummaryType
379. ScannedApplication
380. ScannedApplicationResult
381. ScannerDevice
382. ScannerDeviceResult
383. ScheduledObject
384. ScheduledObjectDesc
385. ScheduledObjectMultyDay
386. ScheduledObjectResult
387. SchedulerPermissions
388. ScriptProfile
389. ScriptProfileDetailsResult
390. ScriptProfileProductDetailsResult
391. ScriptProfileResult
392. SecurityAlarm
393. SecurityAlarmChangeResult
394. SecurityAlarmHostsResult
395. SecurityAlarmMonitorResult
396. SecurityAlarmResult
397. SecurityAlarmSummaryCount
398. SecurityEvent
399. SecurityEventChangeResult
400. SecurityEventMonitorResult
401. SecurityEventParser
402. SecurityEventParserFilter
403. SecurityEventParserPermissions
404. SecurityEventParserResult
405. SecurityEventPermissions
406. SecurityEventResult
407. SecurityEventSummary
408. SecurityEventSummaryCount
409. SecurityEventSummaryResult

392/615
1/21/22, 11:27 AM FortiNAC REST Schema
410. SecurityPolicyPermissions
411. SelfRegRequest
412. SelfRegRequestResult
413. SelfRegistrationRequestPermissions
414. SendMessagePermissions
415. SerialEnumOperator
416. ServerCertificatesResult
417. ServerCluster
418. ServerClusterInfoResult
419. ServerClusterResult
420. ServerInfo
421. ServerSummary
422. ServiceConnectorPermissions
423. ServiceConnectorSummary
424. ServiceConnectorsResult
425. ServiceDocument
426. SettingsPermissions
427. SharedClientFilterPermissions
428. SingleObjectResultDouble
429. StringListResult
430. StringMapResult
431. StringPairListResult
432. StringResult
433. SummaryCount
434. SupplicantConfiguration
435. SupplicantConfigurationResult
436. SupplicantConfigurationSupportingInfoResult
437. SupplicantPolicy
438. SupplicantPolicyResult
439. SupplicantPolicySupportingInfoResult
440. SupplicantSecuritySummary
441. SupportingRoleInfoResult
442. SupportingRoleMappingInfoResult
443. SupportingUserHostProfileInfoResult
444. SystemBackupResult
445. SystemBackupSettings
446. SystemMgmtPermissions
447. TLSServiceConfiguration
448. TLSServiceConfigurationResult
449. Task
450. TaskResult
451. TelemetryDevice
452. TestEmailSettings
453. TestMessageTemplateRequest
454. TestResult
455. TestResultResult
456. TestSecurityEventParserResult
457. TopSecurityAlarmsResult
458. TopSecurityEventHostsResult
459. TopSecurityEventsResult
460. TopologyContainerData
461. TopologyContainerRequest
462. TopologyContainerResult
463. UpdateSNMPDeviceRequest
464. UploadedImageResult
465. UserBookmark
466. UserBookmarkResult
467. UserBookmarkSyncRequest
468. UserCacheResult
469. UserContext
470. UserDashboard
471. UserDashboardResult
472. UserHostAdapterPermissions
473. UserPermissions
474. UserRecord
475. UserRecordFilterSpecification
476. UserRecordResult
477. UserRecord_locale
478. UserSessionTimeoutResult
479. UserSummaryDataResult
480. VendorCode
481. VendorCodeResult
482. VendorOUISupportingInfoResult
483. ViewList
484. ViewMap
485. VulnerabilityScanNamesResult

393/615
1/21/22, 11:27 AM FortiNAC REST Schema
486. WebServiceDefinition
487. WebServiceDefinitionResult
488. WeeklySchedule
489. WinbindConfig
490. WinbindConfigListResult
491. WinbindConfigResult
492. WinbindGlobalResult
493. WinbindLogResult
494. WinbindStatusResult
495. YamsAlarm
496. YamsAlarmResult
497. YamsEvent
498. YamsEventResult
499. body
500. body_1
501. body_10
502. body_100
503. body_101
504. body_102
505. body_103
506. body_104
507. body_105
508. body_106
509. body_107
510. body_108
511. body_109
512. body_11
513. body_110
514. body_111
515. body_112
516. body_113
517. body_114
518. body_115
519. body_116
520. body_117
521. body_118
522. body_119
523. body_12
524. body_120
525. body_121
526. body_122
527. body_123
528. body_124
529. body_125
530. body_126
531. body_127
532. body_128
533. body_129
534. body_13
535. body_130
536. body_131
537. body_132
538. body_133
539. body_134
540. body_135
541. body_136
542. body_137
543. body_138
544. body_139
545. body_14
546. body_140
547. body_141
548. body_142
549. body_143
550. body_144
551. body_145
552. body_146
553. body_147
554. body_148
555. body_149
556. body_15
557. body_150
558. body_151
559. body_152
560. body_153
561. body_154

394/615
1/21/22, 11:27 AM FortiNAC REST Schema
562. body_155
563. body_156
564. body_157
565. body_158
566. body_159
567. body_16
568. body_160
569. body_161
570. body_162
571. body_163
572. body_164
573. body_165
574. body_166
575. body_167
576. body_168
577. body_169
578. body_17
579. body_170
580. body_171
581. body_172
582. body_173
583. body_174
584. body_175
585. body_176
586. body_177
587. body_178
588. body_179
589. body_18
590. body_180
591. body_181
592. body_182
593. body_183
594. body_184
595. body_185
596. body_186
597. body_187
598. body_188
599. body_189
600. body_19
601. body_190
602. body_191
603. body_192
604. body_193
605. body_194
606. body_195
607. body_196
608. body_197
609. body_198
610. body_199
611. body_2
612. body_20
613. body_200
614. body_201
615. body_202
616. body_203
617. body_204
618. body_205
619. body_206
620. body_207
621. body_208
622. body_209
623. body_21
624. body_210
625. body_211
626. body_212
627. body_213
628. body_214
629. body_215
630. body_216
631. body_217
632. body_218
633. body_219
634. body_22
635. body_220
636. body_221
637. body_222

395/615
1/21/22, 11:27 AM FortiNAC REST Schema
638. body_223
639. body_224
640. body_225
641. body_226
642. body_227
643. body_228
644. body_229
645. body_23
646. body_230
647. body_231
648. body_232
649. body_233
650. body_234
651. body_235
652. body_236
653. body_237
654. body_238
655. body_239
656. body_24
657. body_240
658. body_241
659. body_242
660. body_243
661. body_244
662. body_245
663. body_246
664. body_247
665. body_248
666. body_249
667. body_25
668. body_250
669. body_251
670. body_252
671. body_253
672. body_254
673. body_255
674. body_256
675. body_257
676. body_258
677. body_259
678. body_26
679. body_260
680. body_261
681. body_262
682. body_263
683. body_264
684. body_265
685. body_266
686. body_267
687. body_268
688. body_269
689. body_27
690. body_270
691. body_271
692. body_272
693. body_273
694. body_274
695. body_275
696. body_276
697. body_277
698. body_278
699. body_279
700. body_28
701. body_280
702. body_281
703. body_282
704. body_283
705. body_284
706. body_285
707. body_286
708. body_287
709. body_288
710. body_289
711. body_29
712. body_290
713. body_291

396/615
1/21/22, 11:27 AM FortiNAC REST Schema
714. body_292
715. body_293
716. body_294
717. body_295
718. body_296
719. body_297
720. body_298
721. body_299
722. body_3
723. body_30
724. body_300
725. body_301
726. body_302
727. body_303
728. body_304
729. body_305
730. body_306
731. body_307
732. body_308
733. body_309
734. body_31
735. body_310
736. body_311
737. body_312
738. body_313
739. body_314
740. body_315
741. body_316
742. body_317
743. body_318
744. body_319
745. body_32
746. body_320
747. body_321
748. body_322
749. body_323
750. body_324
751. body_325
752. body_326
753. body_327
754. body_328
755. body_329
756. body_33
757. body_330
758. body_331
759. body_332
760. body_333
761. body_334
762. body_335
763. body_336
764. body_337
765. body_338
766. body_339
767. body_34
768. body_340
769. body_341
770. body_342
771. body_343
772. body_344
773. body_345
774. body_346
775. body_347
776. body_348
777. body_349
778. body_35
779. body_350
780. body_351
781. body_352
782. body_353
783. body_354
784. body_355
785. body_356
786. body_357
787. body_358
788. body_359
789. body_36

397/615
1/21/22, 11:27 AM FortiNAC REST Schema
790. body_360
791. body_361
792. body_362
793. body_363
794. body_364
795. body_365
796. body_366
797. body_367
798. body_368
799. body_369
800. body_37
801. body_370
802. body_371
803. body_372
804. body_373
805. body_374
806. body_375
807. body_376
808. body_377
809. body_378
810. body_379
811. body_38
812. body_380
813. body_381
814. body_382
815. body_383
816. body_384
817. body_385
818. body_39
819. body_4
820. body_40
821. body_41
822. body_42
823. body_43
824. body_44
825. body_45
826. body_46
827. body_47
828. body_48
829. body_49
830. body_5
831. body_50
832. body_51
833. body_52
834. body_53
835. body_54
836. body_55
837. body_56
838. body_57
839. body_58
840. body_59
841. body_6
842. body_60
843. body_61
844. body_62
845. body_63
846. body_64
847. body_65
848. body_66
849. body_67
850. body_68
851. body_69
852. body_7
853. body_70
854. body_71
855. body_72
856. body_73
857. body_74
858. body_75
859. body_76
860. body_77
861. body_78
862. body_79
863. body_8
864. body_80
865. body_81

398/615
1/21/22, 11:27 AM FortiNAC REST Schema
866. body_82
867. body_83
868. body_84
869. body_85
870. body_86
871. body_87
872. body_88
873. body_89
874. body_9
875. body_90
876. body_91
877. body_92
878. body_93
879. body_94
880. body_95
881. body_96
882. body_97
883. body_98
884. body_99

AAAServerMapEntry Up

server
AuthServer
priority (optional)
Integer format: int32
domain
String

APMIPRange Up

startIP (optional)
String
endIP (optional)
String
dbid (optional)
Long format: int64

APMIPRangeResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[APMIPRange]

AbstractPermissionsObjectObject Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs

399/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

AcceptHostImportResult Up

status (optional)
String
errorMessage (optional)
String
errorMessages (optional)
array[String]

AccessConfiguration Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name
String
note (optional)
String
taskID (optional)
Long format: int64
access (optional)
String
accessAction (optional)
Integer format: int32
alias (optional)
Boolean
logicalNetwork (optional)
LogicalNetwork
sendGroupsToFirewall (optional)
Boolean
firewallGroups (optional)
array[Long] format: int64
radiusAttributeGroupId (optional)
Long format: int64
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
task (optional)
Task
logicalNetworkName (optional)
String
logicalNetworkID (optional)
Long format: int64
accessActionStr (optional)
String
tagNames (optional)
array[String]
accessValue (optional)
String
yamsEventTag (optional)
String
auditObjectName (optional)

400/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
auditObjectType (optional)
AuditRecordType
id (optional)
Long format: int64
requestedTags (optional)
array[String]

AccessConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[AccessConfiguration]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

AccessConfigurationSupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
logicalNetworks (optional)
array[LogicalNetwork]
clis (optional)
array[CommandLineTask]

AccessPointManagement Up

updatePeriod (optional)
String
apmEnabled (optional)
String

AccessPointManagementResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[AccessPointManagement]

AccessPolicy Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time

401/615
1/21/22, 11:27 AM FortiNAC REST Schema

name (optional)
String
note (optional)
String
profile (optional)
Profile
configuration (optional)
AccessConfiguration
enabled (optional)
Boolean
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
weeklySchedule (optional)
WeeklySchedule
filterSet (optional)
array[String]
configurationName (optional)
String
addAuditSummary (optional)
String

AccessPolicyResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[AccessPolicy]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

AccessPolicySupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
accessProfiles (optional)
array[Profile]
accessConfigs (optional)
array[AccessConfiguration]

ActionTask Up

name (optional)
String
emailMessage (optional)

402/615
1/21/22, 11:27 AM FortiNAC REST Schema
String

AdapterIPAddress Up

ip (optional)
String
type (optional)
String
adapterID (optional)
Long format: int64

AdapterRecordResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DynamicClient]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

AddSNMPDeviceRequest Up

containerID (optional)
Long format: int64
ipAddress (optional)
String
snmpProtocol (optional)
String
snmpSecurityStrings (optional)
array[String]
snmpUsername (optional)
String
snmpAuthenticationProtocol (optional)
String
snmpAuthenticationPassword (optional)
String
snmpPrivacyProtocol (optional)
String
snmpPrivacyPassword (optional)
String
cliCredentials (optional)
CLICredentials

AdminProfile Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
global (optional)
Boolean
isKioskMode
Boolean
administrator (optional)
Boolean
dbid (optional)
Long format: int64
name

403/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
inactivityTime
Integer format: int32
schedule
String
kioskTemplateID
Long format: int64
kioskWelcomeMessage
String
note
String
landingPage
String
manageByGroups
Boolean
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
preventAging
Boolean
upgradePermissions
Boolean
lockoutThreshold
Integer format: int32
lockoutDuration
Integer format: int32
permissions
map[String, AbstractPermissionsObjectObject]
ncmLandingPage
String
scheduleStr (optional)
String

AdminProfileMapping Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
adminProfileDBID (optional)
Long format: int64
groupDBID (optional)
Long format: int64
group (optional)
Group
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType

404/615
1/21/22, 11:27 AM FortiNAC REST Schema

modifyAuditSummary (optional)
String
groupName (optional)
String
addAuditSummary (optional)
String

AdminProfileMappingResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[AdminProfileMapping]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

AdminProfileMappingSupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
profiles (optional)
array[NameIDPair]
groups (optional)
array[NameIDPair]

AdminProfilePermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

AdminProfileResult Up

status (optional)
String
errorMessage (optional)
String

405/615
1/21/22, 11:27 AM FortiNAC REST Schema

results (optional)
array[AdminProfile]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

AdminUserPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

AgentDescriptor Up

version (optional)
String
name (optional)
String
filename (optional)
String
outputFileName (optional)
String
appStoreURL (optional)
String
platform (optional)
String
Enum:
Windows
Mac-OS-X
Linux
LINUX_x86
LINUX_OTHER
Any
APPLE_IOS_IPHONE
APPLE_IOS_IPOD
APPLE_IOS_IPAD
APPLE_IOS
WEBOS
SYMBIAN
ANDROID
BLACKBERRY_OS
WINDOWS_CE
FREEBSD
OPENBSD
NETBSD
SOLARIS
KINDLE

406/615
1/21/22, 11:27 AM FortiNAC REST Schema
CHROME_OS
WINDOWS_PHONE
RIM_TABLET_OS
WINDOWS_RT
BLACKBERRY_10
configEncrypted (optional)
Boolean
offset (optional)
Long format: int64
minServerVersion (optional)
String
fileSize (optional)
Long format: int64
type (optional)
String
Enum:
DISSOLVABLE
PERSISTENT
PASSIVE
MOBILE
RTR
uuid (optional)
UUID format: uuid
vendors (optional)
array[String]

AgingSettings Up

registeredHostValidTime (optional)
Long format: int64
registeredHostInactiveTime (optional)
Long format: int64
unregHostValidTime (optional)
Long format: int64
unregHostInactiveTime (optional)
Long format: int64
userValidTime (optional)
Long format: int64
userInactiveTime (optional)
Long format: int64
deleteRegHostsWithUser (optional)
Boolean

AgingSettingsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
AgingSettings

AlarmAction Up

name (optional)
String
message (optional)
String
duration (optional)
Long format: int64
primaryTask (optional)
ActionTask
emailMessage (optional)
String

407/615
1/21/22, 11:27 AM FortiNAC REST Schema

secondaryTask (optional)
ActionTask
clearTask (optional)
ActionTask
valuesForDiff (optional)
map[String, String]

AlarmCount Up

index (optional)
Integer format: int32
total (optional)
Long format: int64
desc (optional)
String

AlarmSupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
alarmTypes (optional)
map[String, String]

AlarmTriggerRule Up

type (optional)
String
frequency (optional)
Long format: int64
seconds (optional)
Long format: int64
clearEventTag (optional)
String

ApplyLicenseResult Up

status (optional)
String
errorMessage (optional)
String
isLegacyKey (optional)
Boolean
isValidKey (optional)
Boolean
validLicenseCount (optional)
Boolean
isKeyApplicationServer (optional)
Boolean
isKeyManagerServer (optional)
Boolean

ArrayListString Up

AuditDatabaseObject Up

recordID (optional)
Long format: int64
date (optional)
Date format: date-time

408/615
1/21/22, 11:27 AM FortiNAC REST Schema

recordName (optional)
String
userID (optional)
String
summary (optional)
String
recordType (optional)
String
action (optional)
byte[] format: byte
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

AuditLogPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

AuditLogResult Up

status (optional)
String
errorMessage (optional)
String
nameCache (optional)
map[String, map[String, String]]
results (optional)
array[AuditDatabaseObject]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

AuditRecordType Up

auditTableName (optional)
String
mysqlTableName (optional)
String
idnameQuery (optional)

409/615
1/21/22, 11:27 AM FortiNAC REST Schema
String

AuthServer Up

id (optional)
Long format: int64
name (optional)
String
netId (optional)
String
authPort (optional)
Integer format: int32
acctPort (optional)
Integer format: int32
secret (optional)
String
checkUser (optional)
String
checkPassword (optional)
String
lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time

AuthServerResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[AuthServer]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

AuthenticationConfiguration Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name
String
note (optional)
String
authenticationMethod (optional)
String
authenticationTime (optional)
Long format: int64
authenticationTimeOffLine (optional)
Long format: int64
reauthentication (optional)
Boolean
reauthenticationTime (optional)
Long format: int64
errorMessage (optional)
String

410/615
1/21/22, 11:27 AM FortiNAC REST Schema

yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
id (optional)
Long format: int64

AuthenticationConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[AuthenticationConfiguration]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

AuthenticationPolicy Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name (optional)
String
note (optional)
String
profile (optional)
Profile
configuration (optional)
AuthenticationConfiguration
enabled (optional)
Boolean
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
weeklySchedule (optional)
WeeklySchedule
filterSet (optional)
array[String]

411/615
1/21/22, 11:27 AM FortiNAC REST Schema

configurationName (optional)
String
addAuditSummary (optional)
String

AuthenticationPolicyResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[AuthenticationPolicy]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

BackgroundTask Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
attributes (optional)
map[String, String]
childTasks (optional)
array[BackgroundTask]
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
lastModifiedDateMilliseconds (optional)
Long format: int64
id (optional)
Long format: int64
message (optional)
String
assigner (optional)
Long format: int64
assignee (optional)
Long format: int64
note (optional)
String
dateCreated (optional)
Date format: date-time
dateCompleted (optional)
Date format: date-time
dateDue (optional)
Date format: date-time
previousTask (optional)
Long format: int64
previousTaskComplete (optional)
Boolean
notifyView (optional)
String

412/615
1/21/22, 11:27 AM FortiNAC REST Schema

BackgroundTaskResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[BackgroundTask]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

BackupSettingsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
DatabaseArchives

BasePolicyPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

BaseResult Up

status (optional)
String
errorMessage (optional)
String

BatchConfigurationRequest Up

elementIDs (optional)
array[Long] format: int64
config (optional)
LogicalNetworkConfiguration

413/615
1/21/22, 11:27 AM FortiNAC REST Schema
BatchPropertiesRequest Up

elementIDs (optional)
array[Long] format: int64
properties (optional)
PropertiesResult

BodyPart Up

contentDisposition (optional)
ContentDisposition
entity (optional)
Object
headers (optional)
map[String, array[String]]
mediaType (optional)
BodyPart_mediaType
messageBodyWorkers (optional)
MessageBodyWorkers
parent (optional)
MultiPart
providers (optional)
Object
parameterizedHeaders (optional)
map[String, array[ParameterizedHeader]]

BodyPart_mediaType Up

type (optional)
String
subtype (optional)
String
parameters (optional)
map[String, String]
wildcardSubtype (optional)
Boolean
wildcardType (optional)
Boolean

BooleanMapResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
map[String, Boolean]

BooleanResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
Boolean

CLICredentials Up

version (optional)
Double format: double
userName (optional)
String
414/615
1/21/22, 11:27 AM FortiNAC REST Schema

password (optional)
String
enablePassword (optional)
String
port (optional)
String
sessionType (optional)
byte[] format: byte
sessionTypeStr (optional)
String

CertificateAliasResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
map[String, String]

CertificateDeleteResult Up

status (optional)
String
errorMessage (optional)
String
restartRequired (optional)
Boolean

CertificateMgmtPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

CertificateSummary Up

certificateChain is a list of CertificateSummary objects

name (optional)
String
pathLabel (optional)
String
requiresRestart (optional)

415/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
trustedCert (optional)
Boolean
pendingCertDetails (optional)
map[String, String]
pendingCertPrivateKey (optional)
String
privateKey (optional)
String
alias (optional)
String
issuedTo (optional)
String
issuedBy (optional)
String
expiration (optional)
Long format: int64
status (optional)
String
certificateDetails (optional)
map[String, String]
certificateChain (optional)
array[Object]

CertificateUploadResult Up

status (optional)
String
errorMessage (optional)
String
restartRequired (optional)
Boolean

CheckResult Up

status (optional)
String
errorMessage (optional)
String
showDialog (optional)
Boolean

CipherResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[CipherSuite]

CipherSuite Up

value (optional)
String
recommended (optional)
Boolean

ClientFilter Up

id (optional)
Long format: int64

416/615
1/21/22, 11:27 AM FortiNAC REST Schema

filterName (optional)
String
isShared (optional)
Boolean
filterType (optional)
String
orFilter (optional)
String
adapConnected (optional)
String
adapEnabled (optional)
String
adapValidMac (optional)
String
adapIP (optional)
String
adapLocation (optional)
String
adapConnectedContainer (optional)
String
adapDpcRuleName (optional)
String
adapVendorName (optional)
String
adapAccessVal (optional)
String
adapMediaType (optional)
String
adapAuthType (optional)
String
adapInnerEapType (optional)
String
adapOuterEapType (optional)
String
adapDescr (optional)
String
adapMac (optional)
String
hostID (optional)
String
hostConnected (optional)
String
hostEnabled (optional)
String
hostSecurity (optional)
String
hostVulnerabilityScanStatus (optional)
String
hostCreatedStart (optional)
Long format: int64
hostCreatedEnd (optional)
Long format: int64
hostCreatedLastX (optional)
Long format: int64
hostExpirationStart (optional)
Long format: int64
hostExpirationEnd (optional)
Long format: int64
hostInactivityStart (optional)
Long format: int64
hostInactivityEnd (optional)
Long format: int64

417/615
1/21/22, 11:27 AM FortiNAC REST Schema

hostInactivityLastX (optional)
Long format: int64
hostVulnerabilityScanStart (optional)
Long format: int64
hostVulnerabilityScanLastX (optional)
Long format: int64
hostExpirationLastX (optional)
Long format: int64
hostLastContactLastX (optional)
Long format: int64
hostCreatedPeriod (optional)
String
hostExpirationPeriod (optional)
String
hostInactivityPeriod (optional)
String
hostLastContactStart (optional)
String
hostLastContactEnd (optional)
String
hostLastContactPeriod (optional)
String
hostVulnerabilityScanEnd (optional)
String
hostVulnerabilityScanPeriod (optional)
String
hostAppName (optional)
String
hostAppCategory (optional)
String
hostHasPAgent (optional)
String
hostPACommunicating (optional)
String
hostAgentVersion (optional)
String
hostAgentPlatform (optional)
String
hostRole (optional)
String
hostSecurityAccessVal (optional)
String
hostHostName (optional)
String
hostOwner (optional)
String
hostCurrentUser (optional)
String
hostVPNClient (optional)
String
hostOS (optional)
String
hostAgentTag (optional)
String
hostAgentID (optional)
String
hostOpenPorts (optional)
String
hostNotes (optional)
String
hostType (optional)
String

418/615
1/21/22, 11:27 AM FortiNAC REST Schema

hostTypeIncIPPhone (optional)
String
hostHWType (optional)
String
hostSerial (optional)
String
hostDevType (optional)
String
hostCriticality (optional)
String
hostAuth (optional)
String
hostMdmManaged (optional)
String
hostMdmCompliance (optional)
String
hostMdmCompromised (optional)
String
hostMdmDataProtect (optional)
String
hostMdmPasscode (optional)
String
userEnabled (optional)
String
userType (optional)
String
userRole (optional)
String
userSecurityAccessVal (optional)
String
userFirstName (optional)
String
userLastName (optional)
String
userID (optional)
String
userTitle (optional)
String
userAuth (optional)
String
userNotes (optional)
String
userAddress (optional)
String
userZip (optional)
String
userCity (optional)
String
userPhone (optional)
String
userMailState (optional)
String
userEmail (optional)
String
userMobileNum (optional)
String
userMobileProvider (optional)
String
userCreatedEnd (optional)
Long format: int64
userCreatedLastX (optional)
Long format: int64

419/615
1/21/22, 11:27 AM FortiNAC REST Schema

userCreatedStart (optional)
Long format: int64
userExpirationLastX (optional)
Long format: int64
userInactivityEnd (optional)
Long format: int64
userInactivityLastX (optional)
Long format: int64
userInactivityStart (optional)
Long format: int64
userLastActivityEnd (optional)
Long format: int64
userLastActivityLastX (optional)
Long format: int64
userLastActivityStart (optional)
Long format: int64
userCreatedPeriod (optional)
String
userExpirationEnd (optional)
String
userExpirationPeriod (optional)
String
userExpirationStart (optional)
String
userInactivityPeriod (optional)
String
userLastActivityPeriod (optional)
String

ClientFilterResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[ClientFilter]

ClientRecord Up

serverIP (optional)
String
serverName (optional)
String
serverPort (optional)
String
host_status (optional)
Integer format: int32
host_id (optional)
Long format: int64
host_creationTime (optional)
Long format: int64
host_validTime (optional)
Long format: int64
host_offlineAgeTime (optional)
Long format: int64
host_validForTimeOffline (optional)
Long format: int64
host_lastSuccessful (optional)
Long format: int64
host_containerID (optional)
Long format: int64

420/615
1/21/22, 11:27 AM FortiNAC REST Schema

host_containerName (optional)
String
host_role (optional)
String
host_directoryPolicyValue (optional)
String
host_pcSerialNumber (optional)
String
host_hardwareType (optional)
String
host_notes (optional)
String
host_operatingSystem (optional)
String
host_applications (optional)
String
host_type (optional)
byte[] format: byte
host_owner (optional)
String
host_loggedOnUserId (optional)
String
host_hasPersistentAgent (optional)
Boolean
host_communicatingPersistentAgent (optional)
Boolean
host_isMessageReceiver (optional)
Boolean
host_agentVersion (optional)
String
host_agentPlatform (optional)
String
host_agentTag (optional)
String
host_agentID (optional)
String
host_deviceType (optional)
String
host_isMdmCompliance (optional)
Boolean
host_isMdmCompromised (optional)
Boolean
host_isMdmDataProtection (optional)
Boolean
host_isMdmPasscodePresent (optional)
Boolean
host_isManagedByMDM (optional)
Boolean
host_vulnerabilityScanStatus (optional)
Integer format: int32
host_vulnerabilityScanDate (optional)
Long format: int64
host_openPorts (optional)
String
host_criticality (optional)
String
host_lastModifiedBy (optional)
String
host_lastModifiedDate (optional)
Date format: date-time
host_hostName (optional)
String

421/615
1/21/22, 11:27 AM FortiNAC REST Schema

host_img (optional)
String
user_isDeleteHostsUponExpiration (optional)
Boolean
user_status (optional)
Integer format: int32
user_id (optional)
Long format: int64
user_firstName (optional)
String
user_lastName (optional)
String
user_userID (optional)
String
user_position (optional)
String
user_notes (optional)
String
user_email (optional)
String
user_address (optional)
String
user_city (optional)
String
user_zipCode (optional)
String
user_type (optional)
String
user_mailState (optional)
String
user_phone (optional)
String
user_dn (optional)
String
user_role (optional)
String
user_directoryPolicyValue (optional)
String
user_creationTime (optional)
Long format: int64
user_validForTimeMS (optional)
Long format: int64
user_lastActivityTime (optional)
Long format: int64
user_maxHosts (optional)
String
user_mobileProvider (optional)
String
user_mobileNumber (optional)
String
user_isNcmPropagateHosts (optional)
Boolean
user_validForInactivityDays (optional)
Long format: int64
user_validForInactivityAgeTime (optional)
Long format: int64
user_lastModifiedBy (optional)
String
user_lastModifiedDate (optional)
Date format: date-time
user_guestID (optional)
Long format: int64

422/615
1/21/22, 11:27 AM FortiNAC REST Schema

user_authenticateType (optional)
String
user_img (optional)
String
adapter_status (optional)
Integer format: int32
adapter_id (optional)
Long format: int64
adapter_ip (optional)
String
adapter_ips (optional)
array[AdapterIPAddress]
adapter_pcType (optional)
String
adapter_userID (optional)
String
adapter_accessValue (optional)
String
adapter_physicalAddress (optional)
String
adapter_location (optional)
String
adapter_mediumType (optional)
String
adapter_vendorName (optional)
String
adapter_container (optional)
String
adapter_dpcRuleName (optional)
String
adapter_authType (optional)
String
adapter_innerEapType (optional)
String
adapter_outerEapType (optional)
String
adapter_type (optional)
byte[] format: byte
adapter_deviceType (optional)
String
adapter_img (optional)
String

CommandLineTask Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
elementType (optional)
byte[] format: byte
nameTag (optional)
String
scheduledObjectType (optional)
byte[] format: byte
eventTag (optional)
String
taskType (optional)
byte[] format: byte
version (optional)

423/615
1/21/22, 11:27 AM FortiNAC REST Schema
Double format: double
lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
lastChangeSummary (optional)
String
message (optional)
String
description (optional)
String
removeMessage (optional)
String
name (optional)
String
modifyAuditSummary (optional)
String
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String

ConcurrentLicenseUsageResult Up

status (optional)
String
errorMessage (optional)
String
usedByHost (optional)
Long format: int64
licensesUsed (optional)
Long format: int64
usedByDevices (optional)
Long format: int64
perDevice (optional)
array[DeviceSummary]

ConferenceAccount Up

name (optional)
String
type (optional)
String
attendeeCount (optional)
Integer format: int32
startTime (optional)
Long format: int64
endTime (optional)
Long format: int64
templateID (optional)
Long format: int64
password (optional)
String

ConfigProperties Up

wiredDevice (optional)
Boolean
wirelessDevice (optional)
Boolean

424/615
1/21/22, 11:27 AM FortiNAC REST Schema

wirelessController (optional)
Boolean
usesIPPhones (optional)
Boolean
usesEnable (optional)
Boolean
usesSSH (optional)
Boolean
useWiredAttributeForWireless (optional)
Boolean
supportsRadius (optional)
Boolean
hybridDevice (optional)
Boolean
supportsMobilityVlan (optional)
Boolean
excludeVlan (optional)
Boolean
includeCaptivePortal (optional)
Boolean
manageWebAuth (optional)
Boolean
usesDisassociatePort (optional)
Boolean
usesGuestVlan (optional)
Boolean
usesSessionType (optional)
Boolean
usesRoles (optional)
Boolean
rfc5176Enabled (optional)
Boolean
supportsForwardingTable (optional)
Boolean
portChannelSupport (optional)
Boolean
supportsVlanName (optional)
Boolean
specialDevice (optional)
Boolean
noVoiceVLAN (optional)
Boolean
supportsFirewallTags (optional)
Boolean
usesVDOM (optional)
Boolean
devType (optional)
String
secureUnit1 (optional)
String
securePort1 (optional)
String
secureUnit2 (optional)
String
securePort2 (optional)
String
user_1 (optional)
String
telnetPW_1 (optional)
String
enablePW_1 (optional)
String

425/615
1/21/22, 11:27 AM FortiNAC REST Schema

sessionID (optional)
String
wapDomain (optional)
String
chassisIPAddr (optional)
String
slotLetter (optional)
String
portMode (optional)
String
EAPTerminate (optional)
String
snmpVersion (optional)
String
disassociatePort (optional)
String
usesCLIConfiguration (optional)
String
chassisConfiguration (optional)
String
devMode (optional)
String
opMode (optional)
String
transMethod (optional)
String
mobilityGroup (optional)
String
mobilityVlan (optional)
String
vlanNames (optional)
map[String, String]

ConfigStatusResult Up

status (optional)
String
errorMessage (optional)
String
isVM (optional)
Boolean
isInitialConfiguration (optional)
Boolean
uuid (optional)
String
mac (optional)
String
licenseKey (optional)
String

ConfigWizardPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean

426/615
1/21/22, 11:27 AM FortiNAC REST Schema

modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

ContainerChangeResult Up

status (optional)
String
errorMessage (optional)
String
removed (optional)
array[Long] format: int64
added (optional)
array[YamsEvent]
updated (optional)
array[YamsEvent]

ContainerMonitorResult Up

status (optional)
String
errorMessage (optional)
String
total (optional)
Long format: int64
monitorID (optional)
Long format: int64
results (optional)
array[YamsEvent]

ContainerRoleLong Up

dbid (optional)
Long format: int64
parent (optional)
Role
value (optional)
Long format: int64

ContainerRoleMappingLong Up

dbid (optional)
Long format: int64
parent (optional)
RoleMapping
value (optional)
Long format: int64

ContainerRoleMappingString Up

dbid (optional)
Long format: int64
parent (optional)

427/615
1/21/22, 11:27 AM FortiNAC REST Schema
RoleMapping
value (optional)
String

ContainerSupplicantConfigurationString Up

dbid (optional)
Long format: int64
parent (optional)
SupplicantConfiguration
value (optional)
String

ContentDisposition Up

type (optional)
String
parameters (optional)
map[String, String]
fileName (optional)
String
creationDate (optional)
Date format: date-time
modificationDate (optional)
Date format: date-time
readDate (optional)
Date format: date-time
size (optional)
Long format: int64

Criterion Up

CustomScanSummary Up

type (optional)
String
scans (optional)
array[String]

CustomScanTypeRequest Up

osName (optional)
String
csType (optional)
String
scanName (optional)
String
formData (optional)
String
isModify (optional)
Boolean
modify (optional)
Boolean
global (optional)
Boolean

CustomScanTypeSummary Up

osName (optional)
String
csType (optional)

428/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
scanName (optional)
String
global (optional)
Boolean

CustomScansResult Up

status (optional)
String
errorMessage (optional)
String
osList (optional)
array[String]
scans (optional)
map[String, array[CustomScanTypeSummary]]
scanTypeHash (optional)
map[String, array[String]]

DBFilterFieldObject Up

origPropName (optional)
String
matchNull (optional)
Boolean
matchNonNull (optional)
Boolean
actualValue (optional)
Object
notFilter (optional)
Boolean
values (optional)
array[Object]
stringValue (optional)
String
enabled (optional)
Boolean
propName (optional)
String
criterion (optional)
Criterion
allowNotFilter (optional)
Boolean
allowMultiTermFilter (optional)
Boolean
debugString (optional)
String

DashboardPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean

429/615
1/21/22, 11:27 AM FortiNAC REST Schema

remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

DashboardSettings Up

sharedName (optional)
String
note (optional)
String
ownerDBID
Long format: int64
sharedGroupIDs (optional)
array[Long] format: int64
tiles (optional)
array[DashboardTile]
dbid (optional)
Long format: int64

DashboardTile Up

componentUUID (optional)
String
refreshInterval (optional)
Integer format: int32
width (optional)
Integer format: int32
position (optional)
Integer format: int32
additionalSettings (optional)
map[String, String]
dbid (optional)
Long format: int64

DatabaseArchives Up

dbArchiveBackupDays (optional)
String
evtAlarmAgeTime (optional)
String
scanResultsAgeTime (optional)
String
connectionAgeTime (optional)
String

DatabaseBackupResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
DatabaseBackupSettings

DatabaseBackupSettings Up
430/615
1/21/22, 11:27 AM FortiNAC REST Schema

archiveName (optional)
String
backupDays (optional)
String

DatabaseTableSummaryResult Up

status (optional)
String
errorMessage (optional)
String
tableSummary (optional)
JSArrayData

DebugTableDataResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[JSONObject]

DeleteAAAServerMappingsRequest Up

serverMappings (optional)
array[AAAServerMapEntry]

Device Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
elementClass (optional)
byte[] format: byte
role (optional)
String
name (optional)
String
type (optional)
String
protocol (optional)
String
status (optional)
byte[] format: byte
parent (optional)
String
suffix (optional)
String
version (optional)
Double format: double
notes (optional)
String
attributes (optional)
array[MibObject]
description (optional)
Object
group (optional)
String

431/615
1/21/22, 11:27 AM FortiNAC REST Schema

pollingInterval (optional)
Integer format: int32
lastPoll (optional)
Date format: date-time
lastSuccessfulPoll (optional)
Date format: date-time
pollable (optional)
Boolean
security (optional)
array[String]
mibs (optional)
array[String]
deviceType (optional)
String
creationEvent (optional)
YamsEvent
destroyEvent (optional)
YamsEvent
establishedEvent (optional)
YamsEvent
lostEvent (optional)
YamsEvent
attribute (optional)
array[MibObject]
physicalAddress (optional)
String
requestString (optional)
String
identification (optional)
String
attributeNames (optional)
array[String]
sysOid (optional)
String
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String
changeMask (optional)
Long format: int64
mib (optional)
String
packedVersion (optional)
Double format: double
securityString (optional)
String
domainName (optional)
String
lastChangeMask (optional)
Long format: int64

DeviceIdentity Up

dbid (optional)
Long format: int64
source (optional)
String
physAddress (optional)
String
ipAddress (optional)

432/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
hostName (optional)
String
entityTag (optional)
String
os (optional)
String
createTime (optional)
Date format: date-time
lastHeardTime (optional)
Date format: date-time
registered (optional)
Boolean
vendorOUI (optional)
String
vendorName (optional)
String
dpcRuleName (optional)
String
dpcRuleId (optional)
Integer format: int32
entity (optional)
NetworkEntity

DevicePermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

DeviceProfilerProperties Up

createRogues (optional)
String
disablePing (optional)
String
enabled (optional)
String
collectUrl (optional)
String
queryUrl (optional)
String
collectEnabled (optional)

433/615
1/21/22, 11:27 AM FortiNAC REST Schema
String

DeviceProfilerPropertiesResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
DeviceProfilerProperties

DeviceProfilingRulePermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

DeviceSummary Up

devType (optional)
String
owner (optional)
String
mac (optional)
String
ip (optional)
String
name (optional)
String
views (optional)
String

DeviceType Up

dbid (optional)
Long format: int64
name (optional)
String
tag (optional)
String
defaultType (optional)
Boolean
guid (optional)

434/615
1/21/22, 11:27 AM FortiNAC REST Schema
Long format: int64
globalModifiedDate (optional)
Date format: date-time
smallIcon (optional)
String
largeIcon (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

DeviceTypeDefinition Up

id (optional)
Integer format: int32
name (optional)
String
tag (optional)
String
smIcon (optional)
String
lgIcon (optional)
String
isDefault (optional)
Boolean

DeviceTypeResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DeviceType]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

DeviceTypesResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DeviceTypeDefinition]

DirectoryAgentConfiguration Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)

435/615
1/21/22, 11:27 AM FortiNAC REST Schema
Date format: date-time
name (optional)
String
registerRogue (optional)
Boolean
registerByUser (optional)
Boolean
appliedGroupName (optional)
String
addGroupList (optional)
array[DirectoryAgentGroupItem]
policyName (optional)
String
scanGraceLength (optional)
Long format: int64
enabled (optional)
Boolean
debug (optional)
Boolean
addGroupListCopy (optional)
array[DirectoryAgentGroupItem]
addToGroupIDs (optional)
array[Long] format: int64
addToGroupNames (optional)
array[String]
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
addAuditSummary (optional)
String

DirectoryAgentConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DirectoryAgentConfiguration]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

DirectoryAgentGroupItem Up

directoryAgentGroupListItemID (optional)
Long format: int64
addGroupID (optional)
Long format: int64
addGroupName (optional)
String
config (optional)
DirectoryAgentConfiguration

436/615
1/21/22, 11:27 AM FortiNAC REST Schema
DiscoveryData Up

container (optional)
String
useCDP (optional)
Boolean
ipRanges (optional)
array[array[String]]
cdpSeeds (optional)
array[String]
snmpSecurityStrings (optional)
array[String]
snmpV3Credentials (optional)
array[UserContext]
cliCredentials (optional)
array[CLICredentials]

DiscoveryRequest Up

DiscoveryStatus Up

currentAddress (optional)
String
devicesFound (optional)
Integer format: int32
useCDP (optional)
Boolean
deviceTotal (optional)
Integer format: int32
devicesProcessed (optional)
Integer format: int32
snmpV1Errors (optional)
array[String]
snmpV3Errors (optional)
array[String]
cliErrors (optional)
array[String]
vendorOIDMismatch (optional)
array[String]
pingFailures (optional)
array[String]
ipList (optional)
array[Object]
seedList (optional)
array[String]
endTime (optional)
Date format: date-time
startingAddress (optional)
String
endingAddress (optional)
String

DiscoveryStatusResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
DiscoveryStatus

437/615
1/21/22, 11:27 AM FortiNAC REST Schema
DiskUsageInfo Up

name (optional)
String
free (optional)
String
total (optional)
String
usage (optional)
Integer format: int32

DpcRule Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
name (optional)
String
type (optional)
NetworkEntity
notify (optional)
Boolean
registerAutomatically (optional)
Boolean
registerClient (optional)
Boolean
registerToLoggedInUser (optional)
Boolean
role (optional)
String
addToGroup (optional)
Boolean
groupId (optional)
Long format: int64
addToDomain (optional)
Boolean
domainId (optional)
Long format: int64
state (optional)
byte[] format: byte
version (optional)
Double format: double
rank (optional)
Integer format: int32
enabled (optional)
Boolean
methods (optional)
array[MethodData]
description (optional)
String
sponsorNote (optional)
String
weeklySchedule (optional)
WeeklySchedule
reValidation (optional)
Boolean
reValidationInterval (optional)
Long format: int64
failedValidationAction (optional)
FailedValidationAction
lastModifiedBy (optional)
String
438/615
1/21/22, 11:27 AM FortiNAC REST Schema

lastModifiedDate (optional)
Date format: date-time
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
registerToUser (optional)
String
tags (optional)
array[String]
catchAll (optional)
Boolean
modifyAuditSummary (optional)
String
methodSummaryString (optional)
String
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String

DpcRuleResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DpcRule]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

DpcRules Up

rules (optional)
array[DpcRule]

DynamicClient Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
identification (optional)
String
state (optional)
byte[] format: byte
type (optional)
byte[] format: byte
vendorName (optional)
String
parent (optional)
String
lastSuccessfulPoll (optional)
Date format: date-time
status (optional)
Integer format: int32
version (optional)

439/615
1/21/22, 11:27 AM FortiNAC REST Schema
Double format: double
user (optional)
UserRecord
host (optional)
HostRecord
clientState (optional)
byte[] format: byte
creationTime (optional)
Date format: date-time
mediumType (optional)
String
location (optional)
String
container (optional)
String
dpcRuleId (optional)
Long format: int64
dpcRuleName (optional)
String
accessValue (optional)
String
authType (optional)
Integer format: int32
innerEapType (optional)
Integer format: int32
outerEapType (optional)
Integer format: int32
ips (optional)
array[AdapterIPAddress]
hostID (optional)
Long format: int64
attributes (optional)
array[NameValue]
name (optional)
String
hostName (optional)
String
device (optional)
Boolean
physicalAddress (optional)
String
ipaddress (optional)
String
userID (optional)
String
allIPsString (optional)
String
authTypeStr (optional)
String
innerEapTypeStr (optional)
String
outerEapTypeStr (optional)
String
creationEvent (optional)
YamsEvent
destroyEvent (optional)
YamsEvent
establishedEvent (optional)
YamsEvent
lostEvent (optional)
YamsEvent
pctype (optional)

440/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String
currentEnvironment (optional)
map[String, String]
operatingSystem (optional)
String
hardwareType (optional)
String
directoryPolicyValue (optional)
String
firstName (optional)
String
lastName (optional)
String
iconType (optional)
String

DynamicClientEntry Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
type (optional)
byte[] format: byte
clientID (optional)
String
physicalAddress (optional)
String
portID (optional)
String
connectTime (optional)
Long format: int64
currentTime (optional)
Date format: date-time
ident (optional)
String
location (optional)
String
averageLoadIn (optional)
Long format: int64
peakLoadIn (optional)
Long format: int64
bandwidthIn (optional)
Long format: int64
averageLoadOut (optional)
Long format: int64
peakLoadOut (optional)
Long format: int64
bandwidthOut (optional)
Long format: int64
version (optional)
Double format: double
ipaddress (optional)
String

441/615
1/21/22, 11:27 AM FortiNAC REST Schema

connectionTime (optional)
Date format: date-time
disconnectionTime (optional)
Date format: date-time
disconnectTimeAsLong (optional)
Long format: int64
currentTimeAsLong (optional)
Long format: int64

DynamicClientEntryResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DynamicClientEntry]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

DynamicClientFilterSpecification Up

maxRowLimit (optional)
Integer format: int32
methodNames (optional)
array[String]
groupIDsOperator (optional)
String
Enum:
AND
OR
groupNames (optional)
array[String]
groupNamesOperator (optional)
String
Enum:
AND
OR
sortColumn (optional)
String
id (optional)
Long format: int64
hostID (optional)
Long format: int64
type (optional)
byte[] format: byte
orFilter (optional)
Boolean
registeredClient (optional)
Boolean
parent (optional)
String
ids (optional)
array[Long] format: int64
userFilter (optional)
UserRecordFilterSpecification
hostFilter (optional)
HostFilterSpecification
attributeNames (optional)
array[String]
container (optional)

442/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
creationTime (optional)
Date format: date-time
authType (optional)
Integer format: int32
position (optional)
String
address (optional)
String
location (optional)
String
description (optional)
String
dpcRuleId (optional)
Long format: int64
userID (optional)
String
vendorName (optional)
String
hostName (optional)
String
physicalAddress (optional)
String
mediumType (optional)
String
operatingSystem (optional)
String
email (optional)
String
role (optional)
String
notes (optional)
String
firstName (optional)
String
lastName (optional)
String
ipaddress (optional)
String
identification (optional)
String
validForTime (optional)
Date format: date-time
validForTimeOffline (optional)
Date format: date-time
filterEmpty (optional)
Boolean
partialUserID (optional)
String
agentVersion (optional)
String
applications (optional)
String
attributeSearchValues (optional)
array[String]
actualFilterCountString (optional)
String
multipleTypes (optional)
array[Object]
hostRole (optional)
String
hardwareType (optional)

443/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
directoryPolicyValue (optional)
String
zip (optional)
String
innerEapType (optional)
Integer format: int32
outerEapType (optional)
Integer format: int32
accessValue (optional)
String
dpcRuleName (optional)
String
phone (optional)
String
city (optional)
String
mailState (optional)
String
clientIDs (optional)
array[Object]
partialFirstName (optional)
String
partialLastName (optional)
String
methodSearchValues (optional)
array[Object]
sortEnabled (optional)
Boolean
sortAscending (optional)
Boolean
sortDescending (optional)
Boolean
groupIDsToFilter (optional)
array[Long] format: int64
queryFilterWhereClause (optional)
String

DynamicClientSummary Up

clientName (optional)
String
time (optional)
Long format: int64
bandwidth (optional)
Long format: int64

DynamicClientSummaryResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DynamicClientSummary]

DynamicConnection Up

dbid (optional)
Long format: int64
firewall (optional)
String

444/615
1/21/22, 11:27 AM FortiNAC REST Schema

source (optional)
String
protocol (optional)
String
device (optional)
String
country (optional)
String
countryID (optional)
String
hostname (optional)
String
srcAddr (optional)
String
srcMac (optional)
String
srcPort (optional)
String
destAddr (optional)
String
destMac (optional)
String
destPort (optional)
String
sentBytes (optional)
Long format: int64
rcvdBytes (optional)
Long format: int64
sentPackets (optional)
Long format: int64
rcvdPackets (optional)
Long format: int64
addedDate (optional)
Date format: date-time
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

DynamicConnectionResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DynamicConnection]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

EPCConfiguration Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name
String

445/615
1/21/22, 11:27 AM FortiNAC REST Schema

note (optional)
String
agents (optional)
map[String, String]
actions (optional)
map[String, Long] format: int64
profileID (optional)
Long format: int64
appCollectionEnabled (optional)
Boolean
multihomeDetectionEnabled (optional)
Boolean
legacyActionsEnabled (optional)
Boolean
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
profile (optional)
ScriptProfile
agentSettings (optional)
map[String, UUID] format: uuid
allowedESSIDGroup (optional)
Group
allowedBSSIDGroup (optional)
Group
eventActions (optional)
map[String, EventAction]
eventActionIDs (optional)
map[String, Long] format: int64
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
id (optional)
Long format: int64

EPCConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[EPCConfiguration]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

EPCConfigurationSupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
policies (optional)
array[NameIDPair]

446/615
1/21/22, 11:27 AM FortiNAC REST Schema

commonAgent (optional)
array[AgentDescriptor]
otherAgent (optional)
array[AgentDescriptor]

EPCPolicy Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name (optional)
String
note (optional)
String
profile (optional)
Profile
configuration (optional)
EPCConfiguration
enabled (optional)
Boolean
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
weeklySchedule (optional)
WeeklySchedule
filterSet (optional)
array[String]
configurationName (optional)
String
addAuditSummary (optional)
String

EPCPolicyResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[EPCPolicy]
filtered (optional)
Long format: int64

447/615
1/21/22, 11:27 AM FortiNAC REST Schema

total (optional)
Long format: int64

EPCPolicySupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
epcConfigs (optional)
array[EPCConfiguration]
accessProfiles (optional)
array[Profile]

EmailSettings Up

smtpTimeout (optional)
Long format: int64
smtpConnectionTimeout (optional)
Long format: int64
emailPassword (optional)
String
emailAuthType (optional)
String
emailPort (optional)
String
emailUsername (optional)
String
emailServer (optional)
String
emailAuth (optional)
String
emailSender (optional)
String
alwaysSendAsSender (optional)
Boolean

EmailSettingsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
EmailSettings

EventAction Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time

448/615
1/21/22, 11:27 AM FortiNAC REST Schema

onFailure (optional)
String
secondaryActionTimer (optional)
Integer format: int32
activities (optional)
array[EventActionActivity]
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType

EventActionActivity Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
type (optional)
String
attributes (optional)
map[String, String]
auditString (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
typeDescription (optional)
String

EventActionResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[EventAction]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

EventActionSupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
scans (optional)
array[String]
roles (optional)
array[NameIDPair]
cliScripts (optional)
array[String]

449/615
1/21/22, 11:27 AM FortiNAC REST Schema
EventAlarmPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

EventCount Up

index (optional)
Integer format: int32
total (optional)
Long format: int64
desc (optional)
String

EventMapRule Up

type (optional)
byte[] format: byte
name (optional)
String
satisfiedByTime (optional)
Boolean
version (optional)
Double format: double

EventMappingSupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
scans (optional)
array[String]
roles (optional)
array[NameIDPair]
eventTypes (optional)
array[PossibleEventType]
clis (optional)
array[String]
groups (optional)
array[NameIDPair]

450/615
1/21/22, 11:27 AM FortiNAC REST Schema
EventRule Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
enabled (optional)
Boolean
name (optional)
String
description (optional)
String
trigger (optional)
EventTrigger
hostProfile (optional)
Profile
conditionState (optional)
String
triggerEmailGroup (optional)
Long format: int64
actionEmailGroup (optional)
Long format: int64
actionState (optional)
String
action (optional)
EventAction
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
addAuditSummary (optional)
String

EventRuleResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[EventRule]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

EventThresholds Up

451/615
1/21/22, 11:27 AM FortiNAC REST Schema

masterProcessThreadCountWarning (optional)
String
nessusProcessMemoryFreeCritical (optional)
String
nessusProcessThreadCountCritical (optional)
String
nessusProcessThreadCountWarning (optional)
String
masterProcessMemoryFreeWarning (optional)
String
masterProcessMemoryFreeCritical (optional)
String
nessusProcessMemoryFreeWarning (optional)
String
masterProcessThreadCountCritical (optional)
String
concurrentLicenseLimitCritical (optional)
String
concurrentLicenseLimitWarning (optional)
String
networkTopologySizeCritical (optional)
String
memoryFreeWarning (optional)
String
diskFreeCritical (optional)
String
memoryFreeCritical (optional)
String
diskFreeWarning (optional)
String
networkTopologySizeWarning (optional)
String

EventThresholdsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
EventThresholds

EventToAlarm Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
alarmName (optional)
String
eventName (optional)
String
clearEventName (optional)
String
severity (optional)
Integer format: int32
elementType (optional)
byte[] format: byte
elementID (optional)
Long format: int64

452/615
1/21/22, 11:27 AM FortiNAC REST Schema

notifyGroupID (optional)
Long format: int64
sendEmail (optional)
Boolean
sendSMS (optional)
Boolean
alarmAction (optional)
AlarmAction
paused (optional)
Boolean
version (optional)
Double format: double
log (optional)
Boolean
scriptName (optional)
String
lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
rule (optional)
EventMapRule
modifyAuditSummary (optional)
String
notifyGroup (optional)
Group
elementTypeAuditType (optional)
AuditRecordType
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String

EventToAlarmResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[EventToAlarm]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

EventTrigger Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
timeLimit (optional)
Integer format: int32

453/615
1/21/22, 11:27 AM FortiNAC REST Schema

numberOfMatches (optional)
Integer format: int32
activities (optional)
array[EventTriggerActivity]
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType

EventTriggerActivity Up

dbid (optional)
Long format: int64
triggerID (optional)
Long format: int64
type (optional)
String
subtype (optional)
String
description (optional)
String
threatID (optional)
String
vendor (optional)
String
occurrences (optional)
Integer format: int32
minSeverity (optional)
Integer format: int32
maxSeverity (optional)
Integer format: int32
useDestination (optional)
Boolean
attributes (optional)
map[String, String]
auditString (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

EventTriggerResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[EventTrigger]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

FSSOSettings Up

enabled (optional)

454/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
port (optional)
String
password (optional)
String

FSSOSettingsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
FSSOSettings

FTPBackupRequest Up

status (optional)
String
errorMessage (optional)
String
host (optional)
String
user (optional)
String
path (optional)
String
password (optional)
String

FTPBackupResult Up

status (optional)
String
errorMessage (optional)
String
host (optional)
String
user (optional)
String
path (optional)
String

FailedValidationAction Up

disable (optional)
Boolean
version (optional)
Double format: double

FamilySummary Up

name (optional)
String
preferredProduct (optional)
String
getlOp (optional)
String
selProducts (optional)
array[ProductSummary]

FeatureVisibilityResult Up

455/615
1/21/22, 11:27 AM FortiNAC REST Schema

status (optional)
String
errorMessage (optional)
String
result (optional)
FeatureVisibilitySet

FeatureVisibilitySet Up

unifiedSettings (optional)
Boolean
legacyViews (optional)
Boolean

Fingerprint Up

dbid (optional)
Long format: int64
source (optional)
String
physAddress (optional)
String
ipAddress (optional)
String
hostName (optional)
String
entityTag (optional)
String
os (optional)
String
createTime (optional)
Date format: date-time
lastHeardTime (optional)
Date format: date-time
attributes (optional)
map[String, String]
entity (optional)
NetworkEntity

FingerprintResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[DeviceIdentity]
filtered (optional)
Long format: int64
total (optional)
Long format: int64
totals (optional)
FingerprintTotals

FingerprintSource Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32

456/615
1/21/22, 11:27 AM FortiNAC REST Schema

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name (optional)
String
enabled (optional)
Boolean
enableRegistered (optional)
Boolean
canDelete (optional)
Boolean
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
addAuditSummary (optional)
String

FingerprintSourceResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[FingerprintSource]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

FingerprintTotals Up

entityTag (optional)
array[KeyCountPair]
os (optional)
array[KeyCountPair]
source (optional)
array[KeyCountPair]
vendorName (optional)
array[KeyCountPair]
vendorOUI (optional)
array[KeyCountPair]
rogues (optional)
SummaryCount
registered (optional)
SummaryCount

FirewallTag Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)

457/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
lastModifiedDate (optional)
Date format: date-time
lastModifiedDateMilliseconds (optional)
Long format: int64
id (optional)
Long format: int64
name (optional)
String
categories (optional)
array[String]

FirewallTagResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[FirewallTag]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

FormDataBodyPart Up

contentDisposition (optional)
ContentDisposition
entity (optional)
Object
headers (optional)
map[String, array[String]]
mediaType (optional)
BodyPart_mediaType
messageBodyWorkers (optional)
MessageBodyWorkers
parent (optional)
MultiPart
providers (optional)
Object
name (optional)
String
value (optional)
String
simple (optional)
Boolean
formDataContentDisposition (optional)
FormDataContentDisposition
parameterizedHeaders (optional)
map[String, array[ParameterizedHeader]]

FormDataContentDisposition Up

type (optional)
String
parameters (optional)
map[String, String]
fileName (optional)
String
creationDate (optional)
Date format: date-time

458/615
1/21/22, 11:27 AM FortiNAC REST Schema

modificationDate (optional)
Date format: date-time
readDate (optional)
Date format: date-time
size (optional)
Long format: int64
name (optional)
String

FortigateTelemetryResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[TelemetryDevice]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

GeneralPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

GenerateCSRParameters Up

keyLength (optional)
Integer format: int32
countryName (optional)
String
state (optional)
String
city (optional)
String
orgName (optional)
String
ou (optional)
String
cn (optional)

459/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
sans (optional)
array[String]
selfSigned (optional)
Boolean
certType (optional)
String
newTargetAlias (optional)
String

GenerateCSRResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
String
restartRequired (optional)
Boolean

GetAttributesResult Up

status (optional)
String
errorMessage (optional)
String
name (optional)
String
id (optional)
Long format: int64
results (optional)
array[NameValue]

GoogleClientIDResult Up

status (optional)
String
errorMessage (optional)
String
clientID (optional)
String
apiKey (optional)
String
projectNumber (optional)
String

Group Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
landscape (optional)
Long format: int64
dbid (optional)
Long format: int64
elementClass (optional)
Integer format: int32
name (optional)
String
userGroup (optional)

460/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
description (optional)
String
accessPolicy (optional)
Integer format: int32
daysValid (optional)
Integer format: int32
daysInactive (optional)
Integer format: int32
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
nameLabel (optional)
String

GroupFilter Up

firstRecord (optional)
Long format: int64
count (optional)
Boolean
cacheable (optional)
Boolean
distinct (optional)
Boolean
queryFilters (optional)
array[array[DBFilterFieldObject]]
name (optional)
String
resultLimit (optional)
Long format: int64
dbid (optional)
Long format: int64
nameLabel (optional)
String
elementClass (optional)
Integer format: int32
guid (optional)
Long format: int64
userGroup (optional)
Boolean
ordering (optional)
map[String, byte[]] format: byte
countFilter (optional)
Boolean

GroupMemberSummary Up

id (optional)
Long format: int64
name (optional)
String
img (optional)
String

GroupMembersResult Up

status (optional)
String
errorMessage (optional)
String

461/615
1/21/22, 11:27 AM FortiNAC REST Schema

result (optional)
GroupSummary

GroupMembershipPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

GroupPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

GroupSummary Up

subgroups (optional)
array[GroupSummary]
members (optional)
array[GroupMemberSummary]
name (optional)
String
imgHash (optional)

462/615
1/21/22, 11:27 AM FortiNAC REST Schema
map[String, String]

GroupsByTypeResult Up

status (optional)
String
errorMessage (optional)
String
userGroups (optional)
array[Group]
ipPhoneGroups (optional)
array[Group]
adminGroups (optional)
array[Group]
clientGroups (optional)
array[Group]
portGroups (optional)
array[Group]
deviceGroups (optional)
array[Group]

GuestContractorPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

GuestContractorTemplatePermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean

463/615
1/21/22, 11:27 AM FortiNAC REST Schema

customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

GuestRecord Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
clientID (optional)
Long format: int64
role (optional)
String
policy (optional)
String
firstName (optional)
String
lastName (optional)
String
sponsor (optional)
String
visitorType (optional)
Integer format: int32
assetTag (optional)
String
email (optional)
String
state (optional)
byte[] format: byte
userID (optional)
String
password (optional)
String
version (optional)
Double format: double
creationTime (optional)
Date format: date-time
validForTime (optional)
Date format: date-time
address (optional)
String
city (optional)
String
mailState (optional)
String
zipCode (optional)
String
phone (optional)
String
country (optional)
String
reason (optional)
String
personVisiting (optional)
String
canSendEmail (optional)

464/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
canSendSMS (optional)
Boolean
aupURL (optional)
String
aupIP (optional)
String
successURL (optional)
String
successIP (optional)
String
reauthenticationPeriod (optional)
Integer format: int32
accountEnabled (optional)
Boolean
dataFields (optional)
String
authType (optional)
Integer format: int32
authServer (optional)
Long format: int64
regType (optional)
Integer format: int32
weeklySchedule (optional)
WeeklySchedule
terminateAtEndOfDay (optional)
Boolean
printedNote (optional)
String
numConferenceAttendees (optional)
Integer format: int32
mobileProvider (optional)
String
mobileNumber (optional)
String
conferenceName (optional)
String
accountDuration (optional)
Integer format: int32
ncmPropagateHosts (optional)
Boolean
passwordExclusions (optional)
String
sendPasswordSeparately (optional)
Boolean
minPwLength (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
name (optional)
String
startTimeOfDay (optional)
Integer format: int32
endTimeOfDay (optional)
Integer format: int32
daysOfWeek (optional)
Integer format: int32
alwaysOn (optional)
Boolean
userStartTimeStr (optional)

465/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
userEndTimeStr (optional)
String
startTimeOfDayAM (optional)
Boolean
endTimeOfDayAM (optional)
Boolean
startTimeOfDayHours (optional)
Integer format: int32
endTimeOfDayHours (optional)
Integer format: int32
startTimeOfDayMinutes (optional)
Integer format: int32
endTimeOfDayMinutes (optional)
Integer format: int32
timeOfDayString (optional)
String
loginAvailabilityString (optional)
String
daysOfWeekString (optional)
String
guestValid (optional)
Boolean
userStartTime (optional)
Date format: date-time
userEndTime (optional)
Date format: date-time
conference (optional)
Boolean
individualUserName (optional)
Boolean
sharedUserName (optional)
Boolean
clientIDs (optional)
array[Long] format: int64
creationTimeMillis (optional)
Long format: int64
validForTimeMillis (optional)
Long format: int64

GuestRecordResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[GuestRecord]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

GuestTemplate Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
name (optional)
String
visitorType (optional)

466/615
1/21/22, 11:27 AM FortiNAC REST Schema
Integer format: int32
canSendEmail (optional)
Boolean
canSendSMS (optional)
Boolean
role (optional)
String
policy (optional)
String
userNameFormat (optional)
Integer format: int32
passwordLength (optional)
Integer format: int32
reauthenticationPeriod (optional)
Integer format: int32
aupURL (optional)
String
aupIP (optional)
String
successURL (optional)
String
successIP (optional)
String
passwordExclusions (optional)
String
dataFields (optional)
String
state (optional)
byte[] format: byte
version (optional)
Double format: double
authType (optional)
Integer format: int32
authServer (optional)
Long format: int64
regType (optional)
Integer format: int32
weeklySchedule (optional)
WeeklySchedule
terminateAtEndOfDay (optional)
Boolean
printedNote (optional)
String
maxConferenceAttendees (optional)
Integer format: int32
accountDuration (optional)
Integer format: int32
accountDurationFromLogin (optional)
Boolean
ncmPropagateHosts (optional)
Boolean
lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
sendPasswordSeparately (optional)
Boolean

467/615
1/21/22, 11:27 AM FortiNAC REST Schema
GuestTemplateResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[GuestTemplate]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

HTMLContentResult Up

status (optional)
String
errorMessage (optional)
String
html (optional)
String
script (optional)
String

HardwareInfoResult Up

status (optional)
String
errorMessage (optional)
String
controlServer (optional)
HardwareSummary
applicationServer (optional)
HardwareSummary
diskFreeWarning (optional)
String
diskFreeCritical (optional)
String
memoryFreeWarning (optional)
String
memoryFreeCritical (optional)
String
networkTopologySizeWarning (optional)
String
networkTopologySizeCritical (optional)
String
masterDBID (optional)
Long format: int64
loaders (optional)
array[LoaderSummary]
masterUpTime (optional)
String
masterStartTime (optional)
String
radius (optional)
Boolean

HardwarePerformance Up

memTotal (optional)
String
memFree (optional)
String
468/615
1/21/22, 11:27 AM FortiNAC REST Schema

swapTotal (optional)
String
swapFree (optional)
String
cpuUsage (optional)
String
sizingTotal (optional)
String
sizingFree (optional)
String
fanSpeeds (optional)
array[array[String]]
temperatures (optional)
array[array[String]]
partitions (optional)
array[String]

HardwarePerformanceResult Up

status (optional)
String
errorMessage (optional)
String
controlServer (optional)
HardwarePerformance
applicationServer (optional)
HardwarePerformance

HardwareSummary Up

diskUsage (optional)
array[DiskUsageInfo]
memTotal (optional)
String
memFree (optional)
String
memUsage (optional)
Integer format: int32
swapTotal (optional)
String
swapFree (optional)
String
swapUsage (optional)
Integer format: int32
memSwapTotal (optional)
String
memSwapFree (optional)
String
memSwapUsage (optional)
Integer format: int32
cpuUsage (optional)
String
sizingTotal (optional)
String
sizingFree (optional)
String

HealthHistoryResult Up

status (optional)
String
errorMessage (optional)

469/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
results (optional)
array[ScanSummary]

HostAlarmSummaryCount Up

status (optional)
String
errorMessage (optional)
String
hostCounts (optional)
array[HostCount]

HostCount Up

id (optional)
Long format: int64
host (optional)
String
user (optional)
String
os (optional)
String

HostEventCount Up

index (optional)
Integer format: int32
total (optional)
Long format: int64
mac (optional)
String
hostID (optional)
Long format: int64
hostName (optional)
String
userName (optional)
String
os (optional)
String

HostEventSummaryCount Up

status (optional)
String
errorMessage (optional)
String
hostCounts (optional)
array[HostEventCount]

HostFilterSpecification Up

maxRowLimit (optional)
Integer format: int32
methodNames (optional)
array[String]
groupIDsOperator (optional)
String
Enum:
AND
OR
groupNames (optional)
array[String]

470/615
1/21/22, 11:27 AM FortiNAC REST Schema

groupNamesOperator (optional)
String
Enum:
AND
OR
sortColumn (optional)
String
id (optional)
Long format: int64
orFilter (optional)
Boolean
typeQueryIncludeIPPhones (optional)
Boolean
ids (optional)
array[Long] format: int64
creationTimeStr (optional)
String
reValidation (optional)
Boolean
creationTime (optional)
Date format: date-time
type (optional)
Integer format: int32
serialNumber (optional)
String
hostName (optional)
String
owner (optional)
String
operatingSystem (optional)
String
role (optional)
String
notes (optional)
String
validForTime (optional)
Date format: date-time
validForTimeOffline (optional)
Date format: date-time
loggedOnUser (optional)
String
patchManagementVendor (optional)
String
patchManagementID (optional)
String
filterEmpty (optional)
Boolean
agentVersion (optional)
String
applications (optional)
String
hostIDs (optional)
array[Long] format: int64
typesSet (optional)
Boolean
types (optional)
Boolean
topoContainerID (optional)
Long format: int64
scannedAppThreatScoreMin (optional)
Integer format: int32
scannedAppThreatScoreMax (optional)
Integer format: int32
471/615
1/21/22, 11:27 AM FortiNAC REST Schema

scannedAppID (optional)
Long format: int64
scannedAppName (optional)
String
scannedAppVendor (optional)
String
scannedAppVersion (optional)
String
scannedAppOS (optional)
String
scannedAppOSVersion (optional)
String
scannedAppSource (optional)
String
scannedAppPackageName (optional)
String
agentPlatform (optional)
String
agentID (optional)
String
agentSN (optional)
String
agentTag (optional)
String
imageType (optional)
String
openPorts (optional)
String
criticality (optional)
String
creationTimeStart (optional)
Long format: int64
creationTimeEnd (optional)
Long format: int64
creationTimeLastX (optional)
Long format: int64
validForTimeStart (optional)
Long format: int64
validForTimeEnd (optional)
Long format: int64
validForTimeLastX (optional)
Long format: int64
offLineTimeMS (optional)
Long format: int64
validForTimeOffLineLastX (optional)
Long format: int64
validForTimeOffLineStart (optional)
Long format: int64
validForTimeOffLineEnd (optional)
Long format: int64
lastPollTimeLastX (optional)
Long format: int64
lastPollTimeStart (optional)
Long format: int64
lastPollTimeEnd (optional)
Long format: int64
filterByManagedByMDM (optional)
Boolean
filterByMdmCompromised (optional)
Boolean
filterByMdmCompliance (optional)
Boolean

472/615
1/21/22, 11:27 AM FortiNAC REST Schema

filterByMdmDataProtection (optional)
Boolean
filterByMdmPasscodePresent (optional)
Boolean
vulnerabilityScanStatus (optional)
Integer format: int32
filterByVulnerabilityScanStatus (optional)
Boolean
vulnerabilityScanLastXDate (optional)
Long format: int64
filterByVulnerabilityScanDate (optional)
Boolean
vulnerabilityScanDateStart (optional)
Long format: int64
vulnerabilityScanDateEnd (optional)
Long format: int64
vulnerabilityScanDateLastX (optional)
Long format: int64
textString (optional)
String
hostApplicationTextString (optional)
String
lastPollTime (optional)
Date format: date-time
hardwareType (optional)
String
directoryPolicyValue (optional)
String
accessValue (optional)
String
methodSearchValues (optional)
array[Object]
sortEnabled (optional)
Boolean
sortAscending (optional)
Boolean
sortDescending (optional)
Boolean
groupIDsToFilter (optional)
array[Long] format: int64
queryFilterWhereClause (optional)
String

HostImportResult Up

status (optional)
String
errorMessage (optional)
String
headers (optional)
array[String]
results (optional)
array[array[String]]

HostPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String

473/615
1/21/22, 11:27 AM FortiNAC REST Schema

tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

HostRecord Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
notes (optional)
String
version (optional)
Double format: double
creationTime (optional)
Date format: date-time
validForTime (optional)
Date format: date-time
lastSuccessfulPoll (optional)
Long format: int64
applications (optional)
String
hostName (optional)
String
owner (optional)
String
policy (optional)
String
hardwareType (optional)
String
status (optional)
Integer format: int32
patchManagementVendor (optional)
String
patchManagementID (optional)
String
attributes (optional)
array[NameValue]
adapters (optional)
array[String]
role (optional)
String
type (optional)
byte[] format: byte
directoryPolicyValue (optional)
String
agentVersion (optional)

474/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
agentID (optional)
String
agentSN (optional)
String
agentTag (optional)
String
agentPlatform (optional)
String
iconType (optional)
String
reValidation (optional)
Boolean
criticality (optional)
String
reValidationInterval (optional)
Long format: int64
lastReValidation (optional)
Long format: int64
openPorts (optional)
String
reValidationAction (optional)
FailedValidationAction
domainId (optional)
Long format: int64
loggedOnUserId (optional)
String
policyHints (optional)
PolicyHints
managedByMDM (optional)
Boolean
mdmCompromised (optional)
Boolean
mdmCompliance (optional)
Boolean
mdmDataProtection (optional)
Boolean
mdmPasscodePresent (optional)
Boolean
ip (optional)
String
name (optional)
String
connected (optional)
Boolean
operatingSystem (optional)
String
inTopology (optional)
Boolean
adaptersAsString (optional)
String
validForTimeOffline (optional)
Long format: int64
atRisk (optional)
Boolean
notCommunicatingPersistentAgent (optional)
Boolean
notAuthenticated (optional)
Boolean
userLoggedOn (optional)
Boolean
vpnclient (optional)

475/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
adapterObjects (optional)
array[DynamicClient]
primaryMac (optional)
String
vulnerabilityScanStatus (optional)
Integer format: int32
vulnerabilityScanDate (optional)
Long format: int64
creationEvent (optional)
YamsEvent
destroyEvent (optional)
YamsEvent
establishedEvent (optional)
YamsEvent
lostEvent (optional)
YamsEvent
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String
connectedAdapter (optional)
DynamicClient
pendingAtRisk (optional)
Boolean
disabled (optional)
Boolean
adapterIpAsString (optional)
String
adapterLocation (optional)
String
adapterContainerAsString (optional)
String
agentPlatformEnum (optional)
String
Enum:
Windows
Mac-OS-X
Linux
LINUX_x86
LINUX_OTHER
Any
APPLE_IOS_IPHONE
APPLE_IOS_IPOD
APPLE_IOS_IPAD
APPLE_IOS
WEBOS
SYMBIAN
ANDROID
BLACKBERRY_OS
WINDOWS_CE
FREEBSD
OPENBSD
NETBSD
SOLARIS
KINDLE
CHROME_OS
WINDOWS_PHONE
RIM_TABLET_OS
WINDOWS_RT
BLACKBERRY_10
validTime (optional)
Long format: int64
expired (optional)
Boolean
pcserialNumber (optional)

476/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
directoryDisabled (optional)
Boolean
scanOnConnect (optional)
Boolean
scanned (optional)
Boolean
persistentAgent (optional)
Boolean
dialUpClient (optional)
Boolean
messageReceiver (optional)
Boolean
currentEnvironment (optional)
map[String, String]
offlineAgeTime (optional)
Long format: int64
typeLabel (optional)
String

HostRecordForUserResult Up

status (optional)
String
errorMessage (optional)
String
ownedHosts (optional)
array[HostRecord]
loggedOnHosts (optional)
array[HostRecord]

HostRecordResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[HostRecord]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

HostRegistrationRequest Up

dbid (optional)
Long format: int64
approver (optional)
String
ip (optional)
String
mac (optional)
String
location (optional)
String
state (optional)
String
Enum:
ACCEPTED
CANCELED
DENIED
ERROR
EXPIRED
477/615
1/21/22, 11:27 AM FortiNAC REST Schema
PENDING
COMPLETED
createDate (optional)
Date format: date-time
expireDate (optional)
Date format: date-time
responseDate (optional)
Date format: date-time
userID (optional)
String
requestKey (optional)
String
requestSource (optional)
String
Enum:
PORTAL_STANDARD_USER
PORTAL_GUEST
PORTAL_CUSTOM
requestSourceName (optional)
String
approverGroup (optional)
Long format: int64

HostRegistrationRequestResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[HostRegistrationRequest]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

HostSummaryDataResult Up

status (optional)
String
errorMessage (optional)
String
allRegistered (optional)
HostSummaryDataType
safeAndAuthenticated (optional)
HostSummaryDataType
atRisk (optional)
HostSummaryDataType
pendingAtRisk (optional)
HostSummaryDataType
notAuthenticated (optional)
HostSummaryDataType
atRiskAndNotAuthenticated (optional)
HostSummaryDataType
pendingAtRiskAndNotAuthenticated (optional)
HostSummaryDataType
unregistered (optional)
HostSummaryDataType
ipPhone (optional)
HostSummaryDataType
allHosts (optional)
HostSummaryDataType

478/615
1/21/22, 11:27 AM FortiNAC REST Schema
HostSummaryDataType Up

totalFilterName (optional)
String
totalCount (optional)
Long format: int64
onlineEnabledFilterName (optional)
String
onlineEnabledCount (optional)
Long format: int64
offlineEnabledFilterName (optional)
String
offlineEnabledCount (optional)
Long format: int64
onlineDisabledFilterName (optional)
String
onlineDisabledCount (optional)
Long format: int64
offlineDisabledFilterName (optional)
String
offlineDisabledCount (optional)
Long format: int64

IAuditObject Up

user (optional)
String
action (optional)
byte[] format: byte
timestamp (optional)
Date format: date-time
liveObj (optional)
IPersistentObject
auditDBID (optional)
Long format: int64
liveDBID (optional)
Long format: int64
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

IPRange Up

startString (optional)
String
endString (optional)
String

IPRangeListResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[IPRange]

IPersistentObject Up

yamsEventTag (optional)
String

479/615
1/21/22, 11:27 AM FortiNAC REST Schema

auditObj (optional)
IAuditObject

ImageDescription Up

name (optional)
String
filename (optional)
String
getxOffset (optional)
Integer format: int32
getyOffset (optional)
Integer format: int32

InitialSystemPropertiesRequest Up

adminUIUserID (optional)
String
adminUIPassword (optional)
String
adminCLIPassword (optional)
String
rootCLIPassword (optional)
String
nmapScanning (optional)
Boolean

IntegratedRADIUSPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

JSArrayData Up

size (optional)
Integer format: int32
jsonString (optional)
String
dataString (optional)
String

JSONObject Up
480/615
1/21/22, 11:27 AM FortiNAC REST Schema

KeyCountPair Up

name (optional)
String
count (optional)
Long format: int64

L3DeviceScan Up

status (optional)
String
Enum:
INIT
RUNNING
L2_POLL
L3_POLL
ANALYZING
CANCELED
FAILED
COMPLETED
SKIPPED
message (optional)
String
elementId (optional)
Long format: int64
mac (optional)
String
ip (optional)
String
weightedScore (optional)
Long format: int64

L3ScanResult Up

status (optional)
String
Enum:
INIT
RUNNING
L2_POLL
L3_POLL
ANALYZING
CANCELED
FAILED
COMPLETED
SKIPPED
message (optional)
String
startTimeStamp (optional)
Long format: int64
stopTimeStamp (optional)
Long format: int64
scans (optional)
array[L3DeviceScan]
totalCount (optional)
Integer format: int32
completedCount (optional)
Integer format: int32

L3ScannerStatusResult Up

status (optional)
String
errorMessage (optional)
String

481/615
1/21/22, 11:27 AM FortiNAC REST Schema

result (optional)
L3ScanResult

LDAPConfig Up

id (optional)
Long format: int64
name (optional)
String
ip (optional)
String
connectByName (optional)
Boolean
protocol (optional)
String
pollable (optional)
Boolean
pollInterval (optional)
Long format: int64
deviceGroup (optional)
String
type (optional)
String
description (optional)
String
state (optional)
byte[] format: byte
status (optional)
byte[] format: byte
landscape (optional)
Long format: int64
mac (optional)
String
ldapSyncState (optional)
Boolean
ldapAddDirectoryUsers (optional)
Boolean
ldapDomainName (optional)
String
ldapRedundantHost (optional)
String
ldapLoginDN (optional)
String
ldapPort (optional)
Integer format: int32
ldapVersion (optional)
String
ldapTimeLimit (optional)
String
ldapRemoveClients (optional)
String
ldapPassword (optional)
String
ldapClientClassObject (optional)
String
ldapGroupClassObject (optional)
String
ldapSSLConnectionType (optional)
String
ldapCharacterSet (optional)
String
ldapClientSearchBranch (optional)

482/615
1/21/22, 11:27 AM FortiNAC REST Schema
array[String]
ldapGroupSearchBranch (optional)
array[String]
clientName (optional)
String
clientPassword (optional)
String
clientFirstName (optional)
String
clientLastName (optional)
String
clientID (optional)
String
clientAddress (optional)
String
clientCity (optional)
String
clientState (optional)
String
clientZipCode (optional)
String
clientTelephoneNumber (optional)
String
clientMobileNumber (optional)
String
clientMobileProvider (optional)
String
clienteMail (optional)
String
clientVlanId (optional)
String
clientUnitName (optional)
String
clientScanPolicy (optional)
String
clientNumRecords (optional)
String
clientDeleteTime (optional)
String
clientDeleteUnits (optional)
String
ldapClientDisableAttr (optional)
String
ldapClientDisableValue (optional)
String
referrals (optional)
String
groupName (optional)
String
groupMembers (optional)
String
clientDN (optional)
String
rootDN (optional)
String
ldapGroupAllows (optional)
array[String]
me (optional)
ManagedElement
pingable (optional)
ManagedElement
debug (optional)

483/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
tls (optional)
LDAPConfig_tls
ctxEnv (optional)
map[String, Object]
clientMSDSPrincipalName (optional)
String
attributeDisabled (optional)
Boolean
ldapdefaults (optional)
Integer format: int32
clientSAMAccountName (optional)
String
samaccountName (optional)
String

LDAPConfigRequest Up

id (optional)
Long format: int64
name (optional)
String
note (optional)
String
defaultAPLocation (optional)
Boolean

LDAPConfigResult Up

status (optional)
String
errorMessage (optional)
String
totalCount (optional)
Long format: int64
results (optional)
array[LDAPConfig]

LDAPConfig_tls Up

encodedValue (optional)
array[byte[]] format: byte
enabledCipherSuites (optional)
array[String]
id (optional)
String
hostnameVerifier (optional)
Object

LicenseContract Up

code (optional)
String
description (optional)
String
expration (optional)
date format: date
supportLevel (optional)
String
supportDescription (optional)
String

484/615
1/21/22, 11:27 AM FortiNAC REST Schema
LicenseInfoResult Up

status (optional)
String
errorMessage (optional)
String
inUseCount (optional)
Long format: int64
totalCount (optional)
Long format: int64
availCount (optional)
Long format: int64
usedPercent (optional)
Integer format: int32
rtrInUseCount (optional)
Integer format: int32
rtrTotalCount (optional)
Integer format: int32
rtrAvailCount (optional)
Integer format: int32
rtrUsedPercent (optional)
Integer format: int32
concurrentLimitWarning (optional)
String
concurrentLimitCritical (optional)
String
masterDBID (optional)
Long format: int64
contracts (optional)
array[LicenseContract]

LicenseInfoSummary Up

name (optional)
String
usagePercent (optional)
Integer format: int32
usage (optional)
Integer format: int32
host (optional)
String

LoaderPerformance Up

name (optional)
String
numberOfThreads (optional)
String
memoryTotal (optional)
String
memoryFree (optional)
String
memoryUsed (optional)
String

LoaderSummary Up

name (optional)
String
threadWarning (optional)
String
threadCritical (optional)
String
485/615
1/21/22, 11:27 AM FortiNAC REST Schema

memoryWarning (optional)
String
memoryCritical (optional)
String
dbid (optional)
Long format: int64
threadCount (optional)
String
totalMem (optional)
String
freeMem (optional)
String
memUsage (optional)
Long format: int64

LocalRadiusConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
RadiusServerConfig

LocalRadiusEapTypesResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[String]

LocalRadiusGlobalConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
RadiusServerGlobalConfig

LocalRadiusServerConfigListResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[RadiusServerConfig]

LocateHostsUsersPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view

486/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

LogHost Up

version (optional)
Double format: double
ip (optional)
String
type (optional)
byte[] format: byte
port (optional)
Integer format: int32
facility (optional)
Integer format: int32
severity (optional)
Integer format: int32
status (optional)
String
security (optional)
String

LogHostObject Up

logHost (optional)
LogHost
dbid (optional)
Integer format: int32

LogMgmtPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64

487/615
1/21/22, 11:27 AM FortiNAC REST Schema

allowedViews
map[String, Boolean]

LogReceiversResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[LogHostObject]

LogicalNetwork Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
id (optional)
Long format: int64
name (optional)
String
description (optional)
String
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType

LogicalNetworkConfiguration Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name
String
note (optional)
String
taskID (optional)
Long format: int64
access (optional)
String
accessAction (optional)
Integer format: int32
alias (optional)
Boolean
logicalNetwork (optional)

488/615
1/21/22, 11:27 AM FortiNAC REST Schema
LogicalNetwork
sendGroupsToFirewall (optional)
Boolean
firewallGroups (optional)
array[Long] format: int64
radiusAttributeGroupId (optional)
Long format: int64
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
elementId
Long format: int64
logicalNetworkID (optional)
Long format: int64
elementID (optional)
Long format: int64
networkID (optional)
Long format: int64
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
task (optional)
Task
logicalNetworkName (optional)
String
accessActionStr (optional)
String
tagNames (optional)
array[String]
accessValue (optional)
String
yamsEventTag (optional)
String
id (optional)
Long format: int64
requestedTags (optional)
array[String]

LogicalNetworkConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[LogicalNetworkConfiguration]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

LogicalNetworkResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[LogicalNetwork]
filtered (optional)

489/615
1/21/22, 11:27 AM FortiNAC REST Schema
Long format: int64
total (optional)
Long format: int64

LoginResult Up

status (optional)
String
errorMessage (optional)
String
sessionKey (optional)
String
userRecord (optional)
UserRecord
requiresSecondaryAuthentication (optional)
Boolean
acceptedAUP (optional)
Boolean
landingPage (optional)
String
licenseExpired (optional)
Boolean
systemRunning (optional)
Boolean
needsNewPassword (optional)
Boolean
licensed (optional)
Boolean
adminProfile (optional)
AdminProfile

LogsPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

MacExclusion Up

startMac (optional)
String
endMac (optional)
String

490/615
1/21/22, 11:27 AM FortiNAC REST Schema

dbid (optional)
Long format: int64
name (optional)
String

MacExclusionPropertiesResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[MacExclusion]

ManageHostsPortsPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

ManagedElement Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
elementClass (optional)
byte[] format: byte
role (optional)
String
name (optional)
String
type (optional)
String
protocol (optional)
String
status (optional)
byte[] format: byte
parent (optional)
String
suffix (optional)

491/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
version (optional)
Double format: double
notes (optional)
String
attributes (optional)
array[MibObject]
description (optional)
Object
group (optional)
String
pollingInterval (optional)
Integer format: int32
lastPoll (optional)
Date format: date-time
lastSuccessfulPoll (optional)
Date format: date-time
pollable (optional)
Boolean
security (optional)
array[String]
mibs (optional)
array[String]
attribute (optional)
array[MibObject]
physicalAddress (optional)
String
requestString (optional)
String
identification (optional)
String
attributeNames (optional)
array[String]
sysOid (optional)
String
creationEvent (optional)
YamsEvent
destroyEvent (optional)
YamsEvent
establishedEvent (optional)
YamsEvent
lostEvent (optional)
YamsEvent
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String
changeMask (optional)
Long format: int64
mib (optional)
String
packedVersion (optional)
Double format: double
securityString (optional)
String
domainName (optional)
String
lastChangeMask (optional)
Long format: int64

492/615
1/21/22, 11:27 AM FortiNAC REST Schema
ManagedElementFilterSpecification Up

maxRowLimit (optional)
Integer format: int32
methodNames (optional)
array[String]
groupIDsOperator (optional)
String
Enum:
AND
OR
groupNames (optional)
array[String]
groupNamesOperator (optional)
String
Enum:
AND
OR
sortColumn (optional)
String
id (optional)
Long format: int64
identification (optional)
String
ids (optional)
array[Long] format: int64
attributeNames (optional)
array[String]
type (optional)
String
suffix (optional)
String
name (optional)
String
parent (optional)
String
protocol (optional)
String
description (optional)
String
status (optional)
byte[] format: byte
physicalAddress (optional)
String
requestString (optional)
String
elementClass (optional)
byte[] format: byte
role (optional)
String
notes (optional)
String
typeList (optional)
array[String]
sysOid (optional)
String
attributeSearchValues (optional)
array[String]
hardwareType (optional)
String
elementClasses (optional)
Boolean
elementIDs (optional)
array[Long] format: int64

493/615
1/21/22, 11:27 AM FortiNAC REST Schema

domainName (optional)
String
methodSearchValues (optional)
array[Object]
sortEnabled (optional)
Boolean
sortAscending (optional)
Boolean
sortDescending (optional)
Boolean
groupIDsToFilter (optional)
array[Long] format: int64
queryFilterWhereClause (optional)
String

ManagedElementWatcherSpecification Up

maxRowLimit (optional)
Integer format: int32
methodNames (optional)
array[String]
groupIDsOperator (optional)
String
Enum:
AND
OR
groupNames (optional)
array[String]
groupNamesOperator (optional)
String
Enum:
AND
OR
sortColumn (optional)
String
id (optional)
Long format: int64
identification (optional)
String
ids (optional)
array[Long] format: int64
attributeNames (optional)
array[String]
changeMask (optional)
Long format: int64
state (optional)
byte[] format: byte
operation (optional)
String
Enum:
DB_ADD
DB_REMOVE
DB_REPLACE
DB_ALL
type (optional)
String
suffix (optional)
String
name (optional)
String
parent (optional)
String
protocol (optional)
String

494/615
1/21/22, 11:27 AM FortiNAC REST Schema

description (optional)
String
status (optional)
byte[] format: byte
physicalAddress (optional)
String
requestString (optional)
String
elementClass (optional)
byte[] format: byte
role (optional)
String
notes (optional)
String
typeList (optional)
array[String]
sysOid (optional)
String
attributeSearchValues (optional)
array[String]
hardwareType (optional)
String
elementClasses (optional)
Boolean
elementIDs (optional)
array[Long] format: int64
domainName (optional)
String
methodSearchValues (optional)
array[Object]
sortEnabled (optional)
Boolean
sortAscending (optional)
Boolean
sortDescending (optional)
Boolean
groupIDsToFilter (optional)
array[Long] format: int64
queryFilterWhereClause (optional)
String

ManagedGroupListResult Up

status (optional)
String
errorMessage (optional)
String
groupList (optional)
array[Group]

ManagedGroupResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[Group]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

495/615
1/21/22, 11:27 AM FortiNAC REST Schema

MdmDevice Up

dbid (optional)
Long format: int64
name (optional)
String
version (optional)
String
request (optional)
String
identifier (optional)
String
userID (optional)
String
password (optional)
String
pluginName (optional)
String
deleteOnRemove (optional)
Boolean
onDemandRegistration (optional)
Boolean
reValidation (optional)
Boolean
updateApplications (optional)
Boolean
poll (optional)
Boolean
pollInterval (optional)
Long format: int64
lastPoll (optional)
Date format: date-time
lastSuccessfulPoll (optional)
Date format: date-time
createDate (optional)
Date format: date-time
maaS360PlatformID (optional)
String
maaS360AppID (optional)
String
maaS360AppVersion (optional)
String
maaS360AppAccessKey (optional)
String

MdmDeviceResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[MdmDevice]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

MessageBodyWorkers Up

496/615
1/21/22, 11:27 AM FortiNAC REST Schema
MessageTemplate Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
type (optional)
String
Enum:
SELF_REGISTRATION_REQUEST
HOST_REGISTRATION_REQUEST
GUEST_ACCOUNT_DETAILS
GUEST_ACCOUNT_PASSWORD
subject (optional)
String
message (optional)
String

MessageTemplateResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[MessageTemplate]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

MethodData Up

enabled (optional)
Boolean
methodType (optional)
MethodType
version (optional)
Double format: double
encrypted (optional)
Boolean
priority (optional)
Integer format: int32

MethodType Up

id (optional)
Long format: int64
name (optional)
String
shortName (optional)
String

MibObject Up

version (optional)
Double format: double
attributeName (optional)
String

497/615
1/21/22, 11:27 AM FortiNAC REST Schema

attribute (optional)
String
table (optional)
Boolean
discoverObject (optional)
Boolean
mandatory (optional)
Boolean
value (optional)
String
group (optional)
String
type (optional)
byte[] format: byte
access (optional)
byte[] format: byte
error (optional)
byte[] format: byte
objectValue (optional)
Object
attributeSuffix (optional)
String

MibObjectArray Up

ModelConfig Up

accessValue (optional)
String
actionState (optional)
Integer format: int32
cliConfig (optional)
Long format: int64
radiusAttributeGroupId (optional)
Long format: int64
radiusResponseValues (optional)
String
logicalNetwork (optional)
String

MultiPart Up

contentDisposition (optional)
ContentDisposition
entity (optional)
Object
headers (optional)
map[String, array[String]]
mediaType (optional)
BodyPart_mediaType
messageBodyWorkers (optional)
MessageBodyWorkers
parent (optional)
MultiPart
providers (optional)
Object
bodyParts (optional)
array[BodyPart]
parameterizedHeaders (optional)
map[String, array[ParameterizedHeader]]

498/615
1/21/22, 11:27 AM FortiNAC REST Schema
MultifilterResult Up

status (optional)
String
errorMessage (optional)
String
total (optional)
Long format: int64
filtered (optional)
Long format: int64
results (optional)
array[ClientRecord]

NCMLicenseInfoResult Up

status (optional)
String
errorMessage (optional)
String
availableCount (optional)
Long format: int64
inUseCount (optional)
Long format: int64
totalCount (optional)
Long format: int64
results (optional)
array[LicenseInfoSummary]

NCMPodData Up

element (optional)
ManagedElement
domains (optional)
map[String, String]
port (optional)
String
ip (optional)
String
name (optional)
String

NCMPodResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[NCMPodData]

NameIDObjectListResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[NameIDPair]

NameIDPair Up

name (optional)
String
499/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
Long format: int64

NameValue Up

version (optional)
Double format: double
name (optional)
String
value (optional)
Object

NavigationSettingsResult Up

status (optional)
String
errorMessage (optional)
String
bookmarks (optional)
array[UserBookmark]
dashboards (optional)
array[UserDashboard]
featureVisibility (optional)
FeatureVisibilitySet

NetworkAddress Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
type (optional)
String
startAddress (optional)
String
endAddress (optional)
String
addressLookup (optional)
String
sdnServiceConnectorID (optional)
Long format: int64
clearpassSPT (optional)
String

NetworkAddressGroup Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
note (optional)
String
addresses (optional)
array[NetworkAddress]

500/615
1/21/22, 11:27 AM FortiNAC REST Schema

NetworkAddressGroupResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[NetworkAddressGroup]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

NetworkAddressResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[NetworkAddress]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

NetworkDeviceChangeResult Up

status (optional)
String
errorMessage (optional)
String
removed (optional)
array[Long] format: int64
added (optional)
array[ManagedElement]
updated (optional)
array[ManagedElement]

NetworkDeviceMonitorResult Up

status (optional)
String
errorMessage (optional)
String
total (optional)
Long format: int64
monitorID (optional)
Long format: int64
results (optional)
array[ManagedElement]

NetworkDeviceProperties Up

agentDelayStr (optional)
String
minTrapPeriodStr (optional)
String
maxTrapPeriodsStr (optional)
String
coldWarmTrapDelayStr (optional)
String
501/615
1/21/22, 11:27 AM FortiNAC REST Schema

regDelayStr (optional)
String
uplinkCountStr (optional)
String
telnetTimeoutStr (optional)
String
vlanResetDelayStr (optional)
String
vlanSwitchingDelayStr (optional)
String
macSpoofDelayStr (optional)
String
multiAccessStr (optional)
String
multiAccessThreshold (optional)
String
ciscoDiscoveryStr (optional)
String
lldpDiscoveryStr (optional)
String
cdpMaxHopsStr (optional)
String
ignoreMacNotifyOnPhoneStr (optional)
String
meAccessPolicy (optional)
String
vlanSwitchingDelay (optional)
String
telnetTimeout (optional)
String
agentDelay (optional)
String
minTrapPeriod (optional)
String
getmaxTrapPeriods (optional)
String
coldWarmTrapDelay (optional)
String
regDelay (optional)
String
uplinkCount (optional)
String
vlanResetDelay (optional)
String
macSpoofDelay (optional)
String
multiAccess (optional)
String
ciscoDiscovery (optional)
String
lldpDiscovery (optional)
String
ciscoDiscoveryMaxHops (optional)
String
ignoreMacNotifyOnPhone (optional)
String

NetworkDevicePropertiesResult Up

status (optional)
String
errorMessage (optional)

502/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
results (optional)
array[NetworkDeviceProperties]

NetworkDeviceResult Up

status (optional)
String
errorMessage (optional)
String
totalCount (optional)
Long format: int64
results (optional)
array[Device]

NetworkDeviceSummaryDetails Up

deviceID (optional)
Long format: int64
objectID (optional)
Long format: int64
deviceName (optional)
String
description (optional)
String
type (optional)
String

NetworkDeviceSummaryType Up

name (optional)
String
tag (optional)
String
onlineIcon (optional)
String
offlineIcon (optional)
String
onlineCount (optional)
Long format: int64
offlineCount (optional)
Long format: int64

NetworkEntity Up

name (optional)
String
tag (optional)
String
id (optional)
Integer format: int32
imageFile (optional)
String

NetworkEntitySummary Up

name (optional)
String
id (optional)
Long format: int64
tag (optional)
String

503/615
1/21/22, 11:27 AM FortiNAC REST Schema

iconPath (optional)
String

NumberListResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[Long] format: int64

NumberResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
Long format: int64

OID Up

value (optional)
array[Integer] format: int32
valid (optional)
Boolean
syntax (optional)
Integer format: int32
berlength (optional)
Integer format: int32
dynamic (optional)
Boolean
exception (optional)
Boolean
syntaxString (optional)
String
berpayloadLength (optional)
Integer format: int32

OSScanSummary Up

name (optional)
String
families (optional)
array[FamilySummary]
monitors (optional)
map[String, Long] format: int64
scans (optional)
array[CustomScanSummary]

ObjectListResultNetworkDeviceSummaryDetails Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[NetworkDeviceSummaryDetails]

ObjectListResultNetworkDeviceSummaryType Up

504/615
1/21/22, 11:27 AM FortiNAC REST Schema

status (optional)
String
errorMessage (optional)
String
results (optional)
array[NetworkDeviceSummaryType]

ObjectListResultScanSummaryType Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[ScanSummaryType]

ObjectMapResultListNameValue Up

status (optional)
String
errorMessage (optional)
String
result (optional)
map[String, array[NameValue]]

OutputLogResult Up

status (optional)
String
errorMessage (optional)
String
linesReturned (optional)
Integer format: int32
logLength (optional)
Long format: int64
logOutput (optional)
String

PAPacketPerformanceResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[PAPerformance]

PAPacketTransportConfig Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
transportType (optional)
String
tlsConfigID (optional)
Long format: int64
tlsConfigName (optional)
String
id (optional)
Long format: int64
name (optional)

505/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
port (optional)
Integer format: int32
enabled (optional)
Boolean
maxPacketQueueSize (optional)
Integer format: int32
bindToAddress (optional)
String
writeIdleTimeout (optional)
Integer format: int32
readIdleTimeout (optional)
Integer format: int32
useNativeTransport (optional)
Boolean
maxConcurrentConnections (optional)
Integer format: int32
globalModifiedDate (optional)
Date format: date-time
gUID (optional)
Long format: int64

PAPacketTransportConfigResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[PAPacketTransportConfig]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

PAPerformance Up

name (optional)
String
sent (optional)
Long format: int64
recieved (optional)
Long format: int64
totalSent (optional)
Long format: int64
totalReceived (optional)
Long format: int64

PairStringString Up

first (optional)
String
second (optional)
String

ParameterizedHeader Up

value (optional)
String
parameters (optional)
map[String, String]

506/615
1/21/22, 11:27 AM FortiNAC REST Schema
PassiveAgentPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

PasswordChange Up

oldPassword (optional)
String
newPassword (optional)
String

PasswordChangeRequest Up

csAdminCLIPassword (optional)
PasswordChange
asAdminCLIPassword (optional)
PasswordChange
csRootCLIPassword (optional)
PasswordChange
asRootCLIPassword (optional)
PasswordChange

PatchManagementResult Up

status (optional)
String
errorMessage (optional)
String
totalCount (optional)
Long format: int64
results (optional)
array[PatchManagementServer]

PatchManagementServer Up

id (optional)
Long format: int64
name (optional)
String
type (optional)
String

507/615
1/21/22, 11:27 AM FortiNAC REST Schema

ip (optional)
String
status (optional)
String
pollingInterval (optional)
Integer format: int32

PerformanceInfoResult Up

status (optional)
String
errorMessage (optional)
String
swapUsed (optional)
Integer format: int32
memoryFree (optional)
String
diskUsage (optional)
array[DiskUsageInfo]
memorySwapUsed (optional)
Integer format: int32
loaders (optional)
array[LoaderPerformance]
upTime (optional)
String
swapFree (optional)
String
memorySwapTotal (optional)
String
memoryTotal (optional)
String
swapTotal (optional)
String
startTime (optional)
String
memorySwapFree (optional)
String
memoryUsed (optional)
Integer format: int32
cpuUsage (optional)
String

PermissionViewMap Up

status (optional)
String
errorMessage (optional)
String
viewMap (optional)
map[String, array[ViewMap]]
ncmViewMap (optional)
map[String, array[ViewMap]]

PersistentObjectUsageCategory Up

name (optional)
String
children (optional)
array[String]

PingableRequest Up

508/615
1/21/22, 11:27 AM FortiNAC REST Schema

containerID (optional)
Long format: int64
name (optional)
String
ipAddress (optional)
String
macAddress (optional)
String
description (optional)
String
note (optional)
String
deviceType (optional)
String
role (optional)
String
incomingEventCategory (optional)
String
incomingEventParser (optional)
String
statusPolling (optional)
Boolean
statusPollInterval (optional)
Integer format: int32
ssoAgentType (optional)
String
ibossPort (optional)
Integer format: int32
ibossKey (optional)
String
ibossDomain (optional)
String
ssoCustomScript (optional)
String
paloAltoPort (optional)
Integer format: int32
paloAltoDomain (optional)
String
paloAltoIntegratedAgent (optional)
Boolean
paloAltoAPIKey (optional)
String
radiusAccountingPort (optional)
Integer format: int32
radiusSecret (optional)
String
ssoGroupID (optional)
Long format: int64
machineName (optional)
String
department (optional)
String
machineOwner (optional)
String
administrativeContact (optional)
String
geographicalLocation (optional)
String
businessPurpose (optional)
String
bootpAddress (optional)
String

509/615
1/21/22, 11:27 AM FortiNAC REST Schema

printQueue (optional)
String

PluginDebugResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[PluginStatus]

PluginStatus Up

name (optional)
String
loader (optional)
String
debugEnabled (optional)
Boolean

PolicyForHostResult Up

status (optional)
String
errorMessage (optional)
String
accessPolicy (optional)
AccessPolicy
accessPolicyDebug (optional)
String
supplicantPolicy (optional)
SupplicantPolicy
supplicantPolicyDebug (optional)
String
epcPolicy (optional)
EPCPolicy
epcPolicyDebug (optional)
String
portalPolicy (optional)
PortalPolicy
portalPolicyDebug (optional)
String
authenticationPolicy (optional)
AuthenticationPolicy
authenticationPolicyDebug (optional)
String

PolicyForUserResult Up

status (optional)
String
errorMessage (optional)
String
accessPolicy (optional)
AccessPolicy
accessPolicyDebug (optional)
String
supplicantPolicy (optional)
SupplicantPolicy
supplicantPolicyDebug (optional)
String

510/615
1/21/22, 11:27 AM FortiNAC REST Schema

epcPolicy (optional)
EPCPolicy
epcPolicyDebug (optional)
String
portalPolicy (optional)
PortalPolicy
portalPolicyDebug (optional)
String
authenticationPolicy (optional)
AuthenticationPolicy
authenticationPolicyDebug (optional)
String

PolicyHints Up

devId (optional)
Long format: int64
clientId (optional)
Long format: int64
portId (optional)
Long format: int64
edgeId (optional)
Long format: int64
userId (optional)
Long format: int64
userIdent (optional)
String
dummyUser (optional)
UserRecord
dummyClient (optional)
DynamicClient
dummyDate (optional)
Date format: date-time
dummyApplications (optional)
array[ScannedApplication]
useKnownAdapters (optional)
Boolean
groupId (optional)
Long format: int64
groupIds (optional)
array[Long] format: int64
ssidid (optional)
Long format: int64
radiusfingerprint (optional)
Fingerprint

PolicyPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean

511/615
1/21/22, 11:27 AM FortiNAC REST Schema

customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

PollingStatus Up

status (optional)
String
errorMessage (optional)
String
enabled (optional)
Boolean
frequency (optional)
Long format: int64
createRogues (optional)
Boolean

PortChange Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
time (optional)
Date format: date-time
portID (optional)
Long format: int64
state (optional)
byte[] format: byte
status (optional)
byte[] format: byte
vlan (optional)
String
cli (optional)
String
roleName (optional)
String
version (optional)
Double format: double
cliname (optional)
String
portId (optional)
Long format: int64

PortChangeResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[PortChange]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

512/615
1/21/22, 11:27 AM FortiNAC REST Schema
PortHB Up

dbid (optional)
Long format: int64
legacyDBID (optional)
Long format: int64
portType (optional)
Integer format: int32
name (optional)
String
portID (optional)
String
displayName (optional)
String
deviceName (optional)
String
deviceID (optional)
Long format: int64
status (optional)
Integer format: int32
domainID (optional)
Long format: int64
ip (optional)
String
physAddr (optional)
String
label (optional)
String
connectionState (optional)
Integer format: int32
defaultVlan (optional)
String
currentVlan (optional)
String
currentCli (optional)
String
notes (optional)
String
attributes (optional)
map[String, String]
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
ifname (optional)
String
ifindex (optional)
String
ifspeed (optional)
String
ifdescr (optional)
String
ifadminStatus (optional)
Integer format: int32
ifoperStatus (optional)
Integer format: int32
uplinkDisabled (optional)
Boolean
displayable (optional)
Boolean

513/615
1/21/22, 11:27 AM FortiNAC REST Schema

yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

PortHBChangeResult Up

status (optional)
String
errorMessage (optional)
String
removed (optional)
array[Long] format: int64
added (optional)
array[PortHB]
updated (optional)
array[PortHB]

PortHBMonitorResult Up

status (optional)
String
errorMessage (optional)
String
total (optional)
Long format: int64
monitorID (optional)
Long format: int64
results (optional)
array[PortHB]

PortHBResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[PortHB]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

PortManagementSupportResult Up

status (optional)
String
errorMessage (optional)
String
portManagementSupported (optional)
Integer format: int32
portManagementUnsupported (optional)
Integer format: int32

PortPropertiesRequest Up

ids (optional)
array[Long] format: int64
name (optional)
String
adminStatus (optional)

514/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
defaultVlan (optional)
String
currentVlan (optional)
String
newUplink (optional)
Integer format: int32
clearUplink (optional)
Boolean
note (optional)
String

PortSummary Up

id (optional)
Long format: int64
name (optional)
String
img (optional)
String

PortalConfiguration Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name
String
note (optional)
String
portalElement (optional)
ManagedElement
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
portalID (optional)
Long format: int64
id (optional)
Long format: int64

PortalConfigurationPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean

515/615
1/21/22, 11:27 AM FortiNAC REST Schema

remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

PortalPolicy Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name (optional)
String
note (optional)
String
profile (optional)
Profile
configuration (optional)
PortalConfiguration
enabled (optional)
Boolean
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
weeklySchedule (optional)
WeeklySchedule
filterSet (optional)
array[String]
configurationName (optional)
String
addAuditSummary (optional)
String

PortalPolicyResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[PortalPolicy]

516/615
1/21/22, 11:27 AM FortiNAC REST Schema

filtered (optional)
Long format: int64
total (optional)
Long format: int64

PortalPolicySupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
portalConfigs (optional)
array[NameIDPair]
userHostProfiles (optional)
array[NameIDPair]

PortsForDevicesResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
map[String, array[PortSummary]]

PossibleEventType Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
eventTag (optional)
String
elementType (optional)
byte[] format: byte
alarmTag (optional)
String
version (optional)
Double format: double
log (optional)
Boolean
systemOnly (optional)
Boolean
ncm (optional)
Boolean
groupID (optional)
Long format: int64
lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
modifyAuditSummary (optional)
String
eventGeneration (optional)
Boolean
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)

517/615
1/21/22, 11:27 AM FortiNAC REST Schema
String

PossibleEventTypeResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[PossibleEventType]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

ProductSummary Up

name (optional)
String
hasHtmlString (optional)
Boolean

Profile Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
note (optional)
String
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
catchAll (optional)
Boolean
weeklySchedule (optional)
WeeklySchedule
groupIDs (optional)
array[Long] format: int64
locationIDs (optional)
array[Long] format: int64
filterSet (optional)
array[String]
radiusFilterSet (optional)
array[RADIUSMethodData]

ProfileResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[Profile]
filtered (optional)
Long format: int64
total (optional)

518/615
1/21/22, 11:27 AM FortiNAC REST Schema
Long format: int64

ProfiledDevicePermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

PropertiesResult Up

status (optional)
String
errorMessage (optional)
String
vlanNames (optional)
map[String, Integer] format: int32
vlanIDs (optional)
array[Integer] format: int32
radiusNames (optional)
array[String]
defaultPrimaryRadiusName (optional)
String
defaultSecondaryRadiusName (optional)
String
configs (optional)
ConfigProperties
credentials (optional)
CLICredentials
cliTimeout (optional)
String
cliConnectTimeout (optional)
String
routerCredentials (optional)
CLICredentials
vlanFormat (optional)
String
isClientBasedCLI (optional)
Boolean
dot1xAutoRegister (optional)
Boolean
defaultConfig (optional)
ModelConfig
defaultWirelessConfig (optional)

519/615
1/21/22, 11:27 AM FortiNAC REST Schema
ModelConfig
registrationConfig (optional)
ModelConfig
registrationWirelessConfig (optional)
ModelConfig
remediationConfig (optional)
ModelConfig
remediationWirelessConfig (optional)
ModelConfig
authenticationConfig (optional)
ModelConfig
authenticationWirelessConfig (optional)
ModelConfig
deadEndConfig (optional)
ModelConfig
deadEndWirelessConfig (optional)
ModelConfig
guestConfig (optional)
ModelConfig
voiceVlanID (optional)
String
chassisIP (optional)
String
chassisSlot (optional)
String
sessionID (optional)
String
radiusEnabled (optional)
Boolean
radiusMode (optional)
String
radiusSecret (optional)
String
primaryRadiusName (optional)
String
secondaryRadiusName (optional)
String
radiusServerConfigId (optional)
Integer format: int32
radiusServerConfigs (optional)
array[map[String, String]]
vdom (optional)
String
portChannelSupport (optional)
Boolean
usePortChannels (optional)
Boolean
useSecurePorts (optional)
Boolean
disassociatePort (optional)
String
manageWebAuthMode (optional)
Boolean
wapDomain (optional)
String
radiusAttributeGroupId (optional)
Long format: int64
radiusResponseValues (optional)
String
secureUnit1 (optional)
String
securePort1 (optional)

520/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
secureUnit2 (optional)
String
securePort2 (optional)
String
applyDefaultToPorts (optional)
Boolean

QuarantineProperties Up

quarantineVlanSwitching (optional)
String

QuarantinePropertiesResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
QuarantineProperties

RADIUSDefaultsResult Up

status (optional)
String
errorMessage (optional)
String
secondaryServerID (optional)
Long format: int64
primaryServerID (optional)
Long format: int64
primaryServerName (optional)
String
secondaryServerName (optional)
String

RADIUSMethodData Up

enabled (optional)
Boolean
methodType (optional)
MethodType
version (optional)
Double format: double
encrypted (optional)
Boolean
priority (optional)
Integer format: int32
attributeFilters (optional)
map[String, String]

RadiusAttrGroupName Up

name (optional)
String
id (optional)
Long format: int64

RadiusAttributeGroup Up

dbid (optional)

521/615
1/21/22, 11:27 AM FortiNAC REST Schema
Long format: int64
name (optional)
String
radiusAttributes (optional)
array[RadiusDictionaryEntry]
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

RadiusAttributeGroupEntry Up

dbid (optional)
Long format: int64
name (optional)
String
attributes (optional)
array[RadiusDictionaryEntryWrapper]
usage (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

RadiusAttributeGroupListResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[RadiusAttributeGroupEntry]

RadiusAttributeGroupNameListResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[RadiusAttrGroupName]

RadiusAttributeGroupResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
RadiusAttributeGroup

RadiusAttributeGroupWrapper Up

dbid (optional)
Long format: int64
name (optional)
String
attributes (optional)
array[RadiusDictionaryEntryWrapper]
yamsEventTag (optional)
String

522/615
1/21/22, 11:27 AM FortiNAC REST Schema

auditObj (optional)
IAuditObject

RadiusAttributeGroupWrapperResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
RadiusAttributeGroupWrapper

RadiusClientPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

RadiusDictionary Up

status (optional)
String
errorMessage (optional)
String
offset (optional)
Long format: int64
limit (optional)
Long format: int64
total (optional)
Long format: int64
nextOffset (optional)
Long format: int64
list (optional)
array[RadiusDictionaryEntry]
results (optional)
array[RadiusDictionaryEntry]

RadiusDictionaryEntry Up

dbid (optional)
Long format: int64
type (optional)
String

523/615
1/21/22, 11:27 AM FortiNAC REST Schema

attribute (optional)
String
value (optional)
String
format (optional)
String
vendor (optional)
String
vendorId (optional)
Integer format: int32
hasTag (optional)
Boolean
encryptMethod (optional)
Integer format: int32
custom (optional)
Boolean
definedValues (optional)
map[String, String]

RadiusDictionaryEntryResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
RadiusDictionaryEntry

RadiusDictionaryEntryWrapper Up

dbid (optional)
Long format: int64
type (optional)
String
attribute (optional)
String
value (optional)
String
format (optional)
String
vendor (optional)
String
vendorId (optional)
Integer format: int32
hasTag (optional)
Boolean
encryptMethod (optional)
Integer format: int32
custom (optional)
Boolean
definedValues (optional)
map[String, String]
responseValues (optional)
array[String]

RadiusMappingsResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)

524/615
1/21/22, 11:27 AM FortiNAC REST Schema
array[AAAServerMapEntry]

RadiusServerConfig Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
tlsServiceConfiguration (optional)
TLSServiceConfiguration
winbindConfigurations (optional)
array[WinbindConfig]
tlsEapTlsFragmentSize (optional)
Integer format: int32
tlsCommonFragmentSize (optional)
Integer format: int32
fastPacKey (optional)
String
eapFastServerUnauthenticatedProvisioning (optional)
Boolean
eapFastServerAuthenticatedProvisioning (optional)
Boolean
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
tlsConfigID (optional)
Long format: int64
transientTlsConfigID (optional)
Long format: int64
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
allowAnyWinbindConfig (optional)
Boolean
ocspEnabled (optional)
Boolean
tlsConfigName (optional)
String
enabledEapTypes (optional)
array[String]
Enum:
tlsCertificateAlias (optional)
String
winbindConfigStr (optional)
String

RadiusServerGlobalConfig Up

authPort (optional)
Integer format: int32
proxyAuthPort (optional)
Integer format: int32
serviceEnabled (optional)
Boolean

525/615
1/21/22, 11:27 AM FortiNAC REST Schema

serviceRunning (optional)
Boolean
serviceLogLevel (optional)
Integer format: int32
serviceDebugHostFilter (optional)
String
serverDebugEnabled (optional)
Boolean
serverDebugHostFilter (optional)
String
serverPolicyDebugEnabled (optional)
Boolean

RadiusServerLogResult Up

status (optional)
String
errorMessage (optional)
String
log (optional)
String
systemdJournal (optional)
String
serverLog (optional)
String

RadiusServerStatusResult Up

status (optional)
String
errorMessage (optional)
String
processEnabled (optional)
Boolean
processRunning (optional)
Boolean
serviceStatus (optional)
String

RadiusServerUpdateConfig Up

dbid (optional)
Long format: int64
name (optional)
String
authPort (optional)
Integer format: int32
tlsConfigID (optional)
Long format: int64
allowAnyWinbindConfig (optional)
Boolean
winbindConfigurations (optional)
array[WinbindConfig]
enabledEapTypes (optional)
array[String]
ocspEnabled (optional)
Boolean
tlsEapTlsFragmentSize (optional)
Integer format: int32
tlsCommonFragmentSize (optional)
Integer format: int32
fastPacKey (optional)

526/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
eapFastServerUnauthenticatedProvisioning (optional)
Boolean
eapFastServerAuthenticatedProvisioning (optional)
Boolean

RadiusServersList Up

status (optional)
String
errorMessage (optional)
String
defaultPrimaryRadiusName (optional)
String
defaultSecondaryRadiusName (optional)
String
results (optional)
array[String]

RadiusUserPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

RecordUsageResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[PersistentObjectUsageCategory]

Relation Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
type (optional)

527/615
1/21/22, 11:27 AM FortiNAC REST Schema
byte[] format: byte
leftType (optional)
byte[] format: byte
rightType (optional)
byte[] format: byte
version (optional)
Double format: double
leftID (optional)
Long format: int64
rightID (optional)
Long format: int64

RelationTableDataResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[Relation]

ReportPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

ReportingPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean

528/615
1/21/22, 11:27 AM FortiNAC REST Schema

customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

Role Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name (optional)
String
groups (optional)
array[ContainerRoleLong]
note (optional)
String
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
groupIDs (optional)
array[Long] format: int64
groupNames (optional)
array[String]
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
addAuditSummary (optional)
String

RoleMapping Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
lastModifiedBy (optional)
String
lastChangeSummary (optional)
String

529/615
1/21/22, 11:27 AM FortiNAC REST Schema

lastModifiedDate (optional)
Date format: date-time
roleID (optional)
Long format: int64
note (optional)
String
logicalNetwork (optional)
LogicalNetwork
filters (optional)
array[ContainerRoleMappingString]
groups (optional)
array[ContainerRoleMappingLong]
groupIDs (optional)
array[Long] format: int64
roleName (optional)
String
cli (optional)
Long format: int64
groupNames (optional)
array[String]
cliobject (optional)
Task
roleWildcard (optional)
Boolean
roleWildcarded (optional)
Boolean
roles (optional)
array[Role]
accessValue (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
filterSet (optional)
array[String]
role (optional)
Role
addAuditSummary (optional)
String
logicalNetworkID (optional)
Long format: int64

RoleMappingResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[RoleMapping]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

530/615
1/21/22, 11:27 AM FortiNAC REST Schema
RolePermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

RoleResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[Role]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SMS Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
providerName (optional)
String
emailToSMS (optional)
String
country (optional)
String
state (optional)
byte[] format: byte
enabled (optional)
Boolean
version (optional)
Double format: double
maxMessageLength (optional)
Integer format: int32

SMSResult Up

status (optional)
String
531/615
1/21/22, 11:27 AM FortiNAC REST Schema

errorMessage (optional)
String
results (optional)
array[SMS]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SSHBackupRequest Up

status (optional)
String
errorMessage (optional)
String
host (optional)
String
path (optional)
String

SSHBackupResult Up

status (optional)
String
errorMessage (optional)
String
host (optional)
String
path (optional)
String

Scan Up

dbid (optional)
Long format: int64
scanId (optional)
String
uuid (optional)
String
scannerDevice (optional)
ScannerDevice
name (optional)
String
status (optional)
String
launchable (optional)
Boolean
lastModified (optional)
Date format: date-time
critical (optional)
Integer format: int32
high (optional)
Integer format: int32
medium (optional)
Integer format: int32
low (optional)
Integer format: int32
info (optional)
Integer format: int32
profile (optional)
String
startTime (optional)

532/615
1/21/22, 11:27 AM FortiNAC REST Schema
Date format: date-time
type (optional)
String
auditString (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

ScanSummary Up

result (optional)
String
date (optional)
Long format: int64
profile (optional)
String

ScanSummaryType Up

date (optional)
Date format: date-time
passed (optional)
Long format: int64
failed (optional)
Long format: int64
scriptFailed (optional)
Long format: int64
warning (optional)
Long format: int64

ScannedApplication Up

dbid (optional)
Long format: int64
name (optional)
String
packageName (optional)
String
appVersion (optional)
String
vendor (optional)
String
os (optional)
String
md5 (optional)
String
sha1 (optional)
String
sha256 (optional)
String
threatScore (optional)
Integer format: int32
threatOverride (optional)
Integer format: int32
submitDate (optional)
Date format: date-time
source (optional)
String
verificationEngine (optional)
Long format: int64

533/615
1/21/22, 11:27 AM FortiNAC REST Schema

osversion (optional)
String
checksum (optional)
String
checksumMethod (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

ScannedApplicationResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[ScannedApplication]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

ScannerDevice Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
vendor (optional)
String
name (optional)
String
request (optional)
String
password (optional)
array[byte[]] format: byte
identifier (optional)
String
pluginName (optional)
String
poll (optional)
Boolean
scans (optional)
array[Scan]
pollInterval (optional)
Long format: int64
lastPoll (optional)
Date format: date-time
lastSuccessfulPoll (optional)
Date format: date-time
createDate (optional)
Date format: date-time
applianceName (optional)
String
secretKey (optional)
String
accessKey (optional)
String

534/615
1/21/22, 11:27 AM FortiNAC REST Schema

authenticationType (optional)
String
userID (optional)
String
dbid (optional)
Long format: int64
passwordEncrypt (optional)
String
passwordDecrypt (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType

ScannerDeviceResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[ScannerDevice]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

ScheduledObject Up

hidden (optional)
Boolean
type (optional)
byte[] format: byte
name (optional)
String
description (optional)
ScheduledObjectDesc
eventTag (optional)
String
taskTag (optional)
String
previousScheduledTime (optional)
Date format: date-time
scheduledTime (optional)
Date format: date-time
pause (optional)
Boolean
internalObject (optional)
Object
multyDay (optional)
ScheduledObjectMultyDay
scheduledTaskEvent (optional)
YamsEvent
period (optional)
Long format: int64
state (optional)
byte[] format: byte

535/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
Long format: int64
landscape (optional)
Long format: int64
version (optional)
Double format: double

ScheduledObjectDesc Up

description (optional)
String
targets (optional)
String
cmdValue (optional)
String
cmdLabel (optional)
String
actionValue (optional)
String
actionLabel (optional)
String
version (optional)
Double format: double

ScheduledObjectMultyDay Up

days (optional)
map[String, Object]
version (optional)
Double format: double

ScheduledObjectResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[ScheduledObject]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SchedulerPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean

536/615
1/21/22, 11:27 AM FortiNAC REST Schema

allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

ScriptProfile Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
lastChangeSummary (optional)
String
name (optional)
String
guid (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time
scriptType (optional)
byte[] format: byte
entityType (optional)
byte[] format: byte
groupID (optional)
Long format: int64
linkUp (optional)
Boolean
patchURL (optional)
String
id (optional)
Long format: int64
state (optional)
byte[] format: byte
portGroupName (optional)
String
deviceGroupName (optional)
String
patchInformation (optional)
String
defaultPolicy (optional)
Boolean
registrationPolicy (optional)
Boolean
remediationPolicy (optional)
Boolean
agentPolicy (optional)
Boolean
vpnPolicy (optional)
Boolean
renewIP (optional)
Boolean
scanRogue (optional)
Boolean
registerFailedRogue (optional)
Boolean
groupName (optional)
String
bypassedOperatingSystems (optional)
array[Object]
persistenAgentRequired (optional)

537/615
1/21/22, 11:27 AM FortiNAC REST Schema
array[Object]
scanOnConnect (optional)
Boolean
label (optional)
String
auditOnly (optional)
Boolean
elapsedNumberOfDays (optional)
Long format: int64
jailbreakThreshold (optional)
Long format: int64
rootThreshold (optional)
Long format: int64
modifyAuditSummary (optional)
String
timeToWait (optional)
Integer format: int32
securityElement (optional)
Long format: int64
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String
allAgentUUIDs (optional)
array[UUID] format: uuid
epcmodifyAuditSummary (optional)
Boolean
otherModifyAuditSummary (optional)
Boolean
directoryAttrVal (optional)
String
policyHash (optional)
Integer format: int32

ScriptProfileDetailsResult Up

status (optional)
String
errorMessage (optional)
String
osDetails (optional)
map[String, OSScanSummary]

ScriptProfileProductDetailsResult Up

status (optional)
String
errorMessage (optional)
String
html (optional)
String
script (optional)
String
scans (optional)
array[String]

ScriptProfileResult Up

status (optional)
String

538/615
1/21/22, 11:27 AM FortiNAC REST Schema

errorMessage (optional)
String
results (optional)
array[ScriptProfile]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SecurityAlarm Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
hostID (optional)
Long format: int64
hostMac (optional)
String
eventDate (optional)
Date format: date-time
ruleText (optional)
String
actionText (optional)
String
eventAction (optional)
EventAction
actionTakenDate (optional)
Date format: date-time
actionTakenBy (optional)
String
actionUndoneDate (optional)
Date format: date-time
actionUndoneBy (optional)
String
actionEmailGroup (optional)
Long format: int64
onFailure (optional)
String
secondaryActionTimer (optional)
Integer format: int32
events (optional)
array[SecurityEvent]
activities (optional)
array[EventActionActivity]
continueOnFailure (optional)
Boolean
stopOnFailure (optional)
Boolean
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

SecurityAlarmChangeResult Up

status (optional)
String
errorMessage (optional)
String
removed (optional)
array[Long] format: int64

539/615
1/21/22, 11:27 AM FortiNAC REST Schema

added (optional)
array[SecurityAlarm]
updated (optional)
array[SecurityAlarm]

SecurityAlarmHostsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
HostAlarmSummaryCount

SecurityAlarmMonitorResult Up

status (optional)
String
errorMessage (optional)
String
total (optional)
Long format: int64
monitorID (optional)
Long format: int64
results (optional)
array[SecurityAlarm]

SecurityAlarmResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[SecurityAlarm]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SecurityAlarmSummaryCount Up

status (optional)
String
errorMessage (optional)
String
alarmCounts (optional)
array[AlarmCount]

SecurityEvent Up

dbid (optional)
Long format: int64
eventDate (optional)
Date format: date-time
deviceID (optional)
Long format: int64
sourceIP (optional)
String
sourceMac (optional)
String
destinationIP (optional)

540/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
destinationMac (optional)
String
alertType (optional)
String
subtype (optional)
String
severity (optional)
Integer format: int32
threatID (optional)
String
eventDescription (optional)
String
sourceLocation (optional)
String
destinationLocation (optional)
String
vendor (optional)
String
attributes (optional)
map[String, String]
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

SecurityEventChangeResult Up

status (optional)
String
errorMessage (optional)
String
removed (optional)
array[Long] format: int64
added (optional)
array[SecurityEvent]
updated (optional)
array[SecurityEvent]

SecurityEventMonitorResult Up

status (optional)
String
errorMessage (optional)
String
total (optional)
Long format: int64
monitorID (optional)
Long format: int64
results (optional)
array[SecurityEvent]

SecurityEventParser Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64

541/615
1/21/22, 11:27 AM FortiNAC REST Schema

isRTR (optional)
Boolean
isEnabled (optional)
Boolean
name (optional)
String
vendor (optional)
String
format (optional)
Integer format: int32
delimiter (optional)
String
tagDelimiter (optional)
String
sourceIPColumn (optional)
String
sourceIPMatcher (optional)
String
sourceIPValue (optional)
String
destinationIPColumn (optional)
String
destinationIPMatcher (optional)
String
destinationIPValue (optional)
String
typeColumn (optional)
String
typeMatcher (optional)
String
typeValue (optional)
String
subtypeColumn (optional)
String
subtypeMatcher (optional)
String
subtypeValue (optional)
String
threatIDColumn (optional)
String
threatIDMatcher (optional)
String
threatIDValue (optional)
String
descriptionColumn (optional)
String
descriptionMatcher (optional)
String
descriptionValue (optional)
String
severityColumn (optional)
String
severityMatcher (optional)
String
severityValue (optional)
String
severityMap (optional)
map[String, Integer] format: int32
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

542/615
1/21/22, 11:27 AM FortiNAC REST Schema

auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType

SecurityEventParserFilter Up

firstRecord (optional)
Long format: int64
count (optional)
Boolean
cacheable (optional)
Boolean
distinct (optional)
Boolean
queryFilters (optional)
array[array[DBFilterFieldObject]]
vendor (optional)
String
format (optional)
Integer format: int32
name (optional)
String
delimiter (optional)
String
isEnabled (optional)
Boolean
sourceIPColumn (optional)
String
sourceIPMatcher (optional)
String
sourceIPValue (optional)
String
destinationIPColumn (optional)
String
destinationIPMatcher (optional)
String
destinationIPValue (optional)
String
typeColumn (optional)
String
typeMatcher (optional)
String
typeValue (optional)
String
subtypeColumn (optional)
String
subtypeMatcher (optional)
String
subtypeValue (optional)
String
threatIDColumn (optional)
String
threatIDMatcher (optional)
String
threatIDValue (optional)
String
descriptionColumn (optional)
String
descriptionMatcher (optional)
String
descriptionValue (optional)

543/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
severityMatcher (optional)
String
severityValue (optional)
String
isRTR (optional)
Boolean
severityColumn (optional)
String
resultLimit (optional)
Long format: int64
dbid (optional)
Long format: int64
ordering (optional)
map[String, byte[]] format: byte
countFilter (optional)
Boolean

SecurityEventParserPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

SecurityEventParserResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[SecurityEventParser]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SecurityEventPermissions Up

permissions
Integer format: int32
attributes
map[String, String]

544/615
1/21/22, 11:27 AM FortiNAC REST Schema

displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

SecurityEventResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[SecurityEvent]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SecurityEventSummary Up

status (optional)
String
errorMessage (optional)
String
startDate (optional)
Date format: date-time
endDate (optional)
Date format: date-time
totalEventsRecorded (optional)
Long format: int64
totalAlarms (optional)
Long format: int64
hostsGeneratingAlarms (optional)
Long format: int64
totalEventsReceived (optional)
Long format: int64
totalEventsDiscarded (optional)
Long format: int64
totalHostsIsolated (optional)
Long format: int64
totalHostsRemediated (optional)
Long format: int64
totalKnownHosts (optional)
Long format: int64
totalUnknownHosts (optional)
Long format: int64
eventsUsedInAlarms (optional)
Long format: int64

545/615
1/21/22, 11:27 AM FortiNAC REST Schema

alarmsWithActionNotTaken (optional)
Long format: int64
alarmsWithActionTaken (optional)
Long format: int64
alarmsWithActionTakenAndUndone (optional)
Long format: int64
success (optional)
Boolean
error (optional)
String

SecurityEventSummaryCount Up

status (optional)
String
errorMessage (optional)
String
eventCounts (optional)
array[EventCount]

SecurityEventSummaryResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
SecurityEventSummary

SecurityPolicyPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

SelfRegRequest Up

dbid (optional)
Long format: int64
sponsor (optional)
String
ip (optional)
String

546/615
1/21/22, 11:27 AM FortiNAC REST Schema

mac (optional)
String
location (optional)
String
state (optional)
String
guestData (optional)
String
createDate (optional)
Date format: date-time
expireDate (optional)
Date format: date-time
responseDate (optional)
Date format: date-time
message (optional)
String
userID (optional)
String
guestDBID (optional)
Long format: int64
requestKey (optional)
String
portalName (optional)
String
pending (optional)
Boolean
stateType (optional)
String
Enum:
ACCEPTED
CANCELED
DENIED
ERROR
EXPIRED
PENDING
formattedSponsorString (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
expired (optional)
Boolean

SelfRegRequestResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[SelfRegRequest]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SelfRegistrationRequestPermissions Up

permissions
Integer format: int32
attributes
map[String, String]

547/615
1/21/22, 11:27 AM FortiNAC REST Schema

displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

SendMessagePermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

SerialEnumOperator Up

ServerCertificatesResult Up

status (optional)
String
errorMessage (optional)
String
possibleCerts (optional)
array[CertificateSummary]
certs (optional)
array[CertificateSummary]

ServerCluster Up

primaryServer (optional)
ServerInfo

548/615
1/21/22, 11:27 AM FortiNAC REST Schema

secondaryServer (optional)
ServerInfo
appServers (optional)
array[ServerInfo]

ServerClusterInfoResult Up

status (optional)
String
errorMessage (optional)
String
clusters (optional)
array[ServerCluster]

ServerClusterResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[ServerSummary]

ServerInfo Up

id (optional)
Long format: int64
name (optional)
String
ip (optional)
String
lastSyncAttempt (optional)
Long format: int64
lastSyncSuccess (optional)
Long format: int64
status (optional)
String
product (optional)
String

ServerSummary Up

name (optional)
String
product (optional)
String
label (optional)
String
type (optional)
String
version (optional)
String
firmware (optional)
String
appliance (optional)
String
primary (optional)
Boolean
l3HA (optional)
Boolean
slaveInControl (optional)
Boolean

549/615
1/21/22, 11:27 AM FortiNAC REST Schema

status (optional)
String
serialNumber (optional)
String
certificates (optional)
Boolean

ServiceConnectorPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

ServiceConnectorSummary Up

id (optional)
Long format: int64
name (optional)
String
type (optional)
String
Enum:
GOOGLE_AUTH
LDAP
RADIUS
FTP_BACKUP_SERVER
SSH_BACKUP_SERVER
EMAIL_SERVER
SMS_SERVICES
AIR_WATCH_MDM
FORTINET_EMS_MDM
GOOGLE_GSUITE_MDM
JAMF_MDM
MAAS360_MDM
MICROSOFT_INTUNE_MDM
MOBILE_IRON_MDM
NOZOMI_MDM
XEN_MOBILE_MDM
BIG_FIX
PATCH_LINK
CUSTOM_SCRIPT_SSO
PALO_ALTO_SSO
RADIUS_SSO
IBOSS_SSO
FORTINET_FSSO
SECURITY_EVENT_PARSER
SYSLOG_PARSER
SYSLOG_RECEIVER
SNMP_SERVER
FORTIGATE_TELEMETRY
550/615
1/21/22, 11:27 AM FortiNAC REST Schema
NTP
DNS_FORWARD
SYSTEM_UPDATE_SERVER
TENABLE_SCANNER
QUALYS_SCANNER
count (optional)
Integer format: int32
details (optional)
map[String, Object]
status (optional)
String

ServiceConnectorsResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[ServiceConnectorSummary]

ServiceDocument Up

status (optional)
String
errorMessage (optional)
String
productName (optional)
String
productCopyright (optional)
String
productVersion (optional)
String
productBuildLabel (optional)
String
apiVersion (optional)
String
hostName (optional)
String
isNCM (optional)
Boolean
isNCMPod (optional)
Boolean

SettingsPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs

551/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

SharedClientFilterPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

SingleObjectResultDouble Up

status (optional)
String
errorMessage (optional)
String
result (optional)
Double format: double

StringListResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[String]

StringMapResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
map[String, String]

StringPairListResult Up

status (optional)
String

552/615
1/21/22, 11:27 AM FortiNAC REST Schema

errorMessage (optional)
String
results (optional)
array[PairStringString]

StringResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
String

SummaryCount Up

filtered (optional)
Long format: int64
total (optional)
Long format: int64

SupplicantConfiguration Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name
String
note (optional)
String
ssid (optional)
String
bssid (optional)
String
hidden (optional)
Boolean
security (optional)
String
cipher (optional)
String
password (optional)
String
certificate (optional)
String
badSSIDNames (optional)
array[ContainerSupplicantConfigurationString]
validateServerCertWindows (optional)
Boolean
eapconfig (optional)
String
Enum:
TLS
LEAP
EAP_FAST
TTLS
PEAP
EAP_SIM
configCipher (optional)
String
Enum:
AES

553/615
1/21/22, 11:27 AM FortiNAC REST Schema
NONE
TKIP
cafingerprint (optional)
String
securityType (optional)
String
Enum:
OPEN
WEP
WEP_ENTERPRISE
WPA
WPA_ENTERPRISE
WPA2
WPA2_ENTERPRISE
WPS
eaptype (optional)
String
badSSIDNameSet (optional)
array[String]
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
id (optional)
Long format: int64

SupplicantConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[SupplicantConfiguration]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SupplicantConfigurationSupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
cipher (optional)
array[String]
security (optional)
array[SupplicantSecuritySummary]
eapType (optional)
map[String, String]

SupplicantPolicy Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32

554/615
1/21/22, 11:27 AM FortiNAC REST Schema

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
name (optional)
String
note (optional)
String
profile (optional)
Profile
configuration (optional)
SupplicantConfiguration
enabled (optional)
Boolean
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
modifyAuditSummary (optional)
String
weeklySchedule (optional)
WeeklySchedule
filterSet (optional)
array[String]
configurationName (optional)
String
addAuditSummary (optional)
String

SupplicantPolicyResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[SupplicantPolicy]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

SupplicantPolicySupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
accessProfiles (optional)
array[Profile]
supplicantConfigs (optional)
array[SupplicantConfiguration]

SupplicantSecuritySummary Up

displayString (optional)

555/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
eapString (optional)
String
passwordRequired (optional)
Boolean
eapRequired (optional)
Boolean

SupportingRoleInfoResult Up

status (optional)
String
errorMessage (optional)
String
groups (optional)
array[NameIDPair]

SupportingRoleMappingInfoResult Up

status (optional)
String
errorMessage (optional)
String
roles (optional)
array[Role]
groups (optional)
array[NameIDPair]
logicalNetworks (optional)
array[NameIDPair]
clis (optional)
array[NameIDPair]

SupportingUserHostProfileInfoResult Up

status (optional)
String
errorMessage (optional)
String
devPortGroups (optional)
array[NameIDPair]
devTypes (optional)
array[NetworkEntitySummary]
agentPlatforms (optional)
array[PairStringString]
hostUserGroups (optional)
array[NameIDPair]

SystemBackupResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
SystemBackupSettings

SystemBackupSettings Up

systemBackupDays (optional)
String

SystemMgmtPermissions Up

556/615
1/21/22, 11:27 AM FortiNAC REST Schema

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

TLSServiceConfiguration Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
clientAuthMode (optional)
String
name (optional)
String
ciphers (optional)
String
tlsProtocols (optional)
String
certAlias (optional)
String
clientAuthAliases (optional)
String
autoUpdateCiphersAndProtocols (optional)
Boolean
globalModifiedDate (optional)
Date format: date-time
gUID (optional)
Long format: int64
id (optional)
Long format: int64

TLSServiceConfigurationResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[TLSServiceConfiguration]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

557/615
1/21/22, 11:27 AM FortiNAC REST Schema

Task Up

taskType (optional)
byte[] format: byte
elementType (optional)
byte[] format: byte
eventTag (optional)
String
nameTag (optional)
String
scheduledObjectType (optional)
byte[] format: byte
state (optional)
byte[] format: byte
id (optional)
Long format: int64
landscape (optional)
Long format: int64
version (optional)
Double format: double

TaskResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[Task]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

TelemetryDevice Up

lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
id (optional)
Long format: int64
ip (optional)
String
port (optional)
Integer format: int32
status (optional)
String

TestEmailSettings Up

smtpTimeout (optional)
Long format: int64
smtpConnectionTimeout (optional)
Long format: int64
emailPassword (optional)
String
emailAuthType (optional)
String
emailPort (optional)
String

558/615
1/21/22, 11:27 AM FortiNAC REST Schema

emailUsername (optional)
String
emailServer (optional)
String
emailAuth (optional)
String
emailSender (optional)
String
alwaysSendAsSender (optional)
Boolean
email (optional)
String
recipient (optional)
String

TestMessageTemplateRequest Up

template (optional)
MessageTemplate
context (optional)
map[String, Object]

TestResult Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
userID (optional)
String
hostName (optional)
String
policy (optional)
String
location (optional)
String
status (optional)
Integer format: int32
type (optional)
Integer format: int32
version (optional)
Double format: double
testTime (optional)
Double format: double
state (optional)
byte[] format: byte
macs (optional)
array[Object]
tests (optional)
array[Object]
operatingSystem (optional)
String
epcconfigName (optional)
String
applications (optional)
String

TestResultResult Up

status (optional)
String
errorMessage (optional)

559/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
results (optional)
array[TestResult]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

TestSecurityEventParserResult Up

status (optional)
String
errorMessage (optional)
String
debug (optional)
String
event (optional)
SecurityEvent

TopSecurityAlarmsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
SecurityAlarmSummaryCount

TopSecurityEventHostsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
HostEventSummaryCount

TopSecurityEventsResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
SecurityEventSummaryCount

TopologyContainerData Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
note (optional)
String
guid (optional)
Long format: int64

560/615
1/21/22, 11:27 AM FortiNAC REST Schema

globalModifiedDate (optional)
Date format: date-time
currentIP (optional)
String
discoveryStatus (optional)
DiscoveryStatus
totalDevices (optional)
Integer format: int32
snmpDevices (optional)
Integer format: int32
defaultAPLocation (optional)
Boolean
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType

TopologyContainerRequest Up

id (optional)
Long format: int64
name (optional)
String
note (optional)
String
defaultAPLocation (optional)
Boolean

TopologyContainerResult Up

status (optional)
String
errorMessage (optional)
String
totalCount (optional)
Long format: int64
results (optional)
array[TopologyContainerData]

UpdateSNMPDeviceRequest Up

containerID (optional)
Long format: int64
ipAddress (optional)
String
snmpProtocol (optional)
String
snmpSecurityStrings (optional)
array[String]
snmpUsername (optional)
String
snmpAuthenticationProtocol (optional)
String
snmpAuthenticationPassword (optional)
String
snmpPrivacyProtocol (optional)
String
snmpPrivacyPassword (optional)

561/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
cliCredentials (optional)
CLICredentials
vlanSwitchingEnabled (optional)
Boolean
paOptimzationEnabled (optional)
Boolean
macFilteringEnabled (optional)
Boolean
role (optional)
String
description (optional)
String
note (optional)
String
manageAsGenericSNMP (optional)
Boolean
readL2L3UsingSNMP (optional)
Boolean
deviceTypeOverride (optional)
String
incomingEventCategory (optional)
String
incomingEventParser (optional)
String
statusPolling (optional)
Boolean
statusPollInterval (optional)
Integer format: int32
ssoAgentType (optional)
String
ibossPort (optional)
Integer format: int32
ibossKey (optional)
String
ibossDomain (optional)
String
ssoCustomScript (optional)
String
paloAltoPort (optional)
Integer format: int32
paloAltoDomain (optional)
String
paloAltoIntegratedAgent (optional)
Boolean
paloAltoAPIKey (optional)
String
radiusAccountingPort (optional)
Integer format: int32
radiusSecret (optional)
String
ssoGroupID (optional)
Long format: int64
systemName (optional)
String
contactName (optional)
String
deviceLocation (optional)
String
contactPollingEnabled (optional)
Boolean
contactPollingInterval (optional)

562/615
1/21/22, 11:27 AM FortiNAC REST Schema
Integer format: int32
l2PollingEnabled (optional)
Boolean
l2PollingInterval (optional)
Long format: int64
l3PollingEnabled (optional)
Boolean
l3PollingInterval (optional)
Long format: int64
l3PollingPriority (optional)
Integer format: int32
cdpPollingEnabled (optional)
Boolean
cdpPollingInterval (optional)
Long format: int64

UploadedImageResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[ImageDescription]

UserBookmark Up

dbid (optional)
Long format: int64
userDBID
Long format: int64
pageUUID
String

UserBookmarkResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[UserBookmark]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

UserBookmarkSyncRequest Up

uuids (optional)
array[String]

UserCacheResult Up

status (optional)
String
errorMessage (optional)
String
value (optional)
String

UserContext Up

563/615
1/21/22, 11:27 AM FortiNAC REST Schema

version (optional)
Double format: double
userName (optional)
String
userPassword (optional)
String
userPrivacyPassword (optional)
String
authenticationProtocol (optional)
Integer format: int32
privacyProtocol (optional)
Integer format: int32
snmpVersion (optional)
Integer format: int32
community (optional)
String
authenticationProtocolAsString (optional)
String
authenticationProtocolAsOID (optional)
OID
privacyProtocolAsString (optional)
String
privacyProtocolAsOID (optional)
OID

UserDashboard Up

dbid (optional)
Long format: int64
rank (optional)
Long format: int64
version (optional)
Integer format: int32
canDelete (optional)
Boolean
label
String
userDBID
Long format: int64
dashboard (optional)
DashboardSettings
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

UserDashboardResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[UserDashboard]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

UserHostAdapterPermissions Up

permissions

564/615
1/21/22, 11:27 AM FortiNAC REST Schema
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

UserPermissions Up

permissions
Integer format: int32
attributes
map[String, String]
displayName_API (optional)
String
tagName
String
view
Boolean
modify
Boolean
remove
Boolean
customized (optional)
Boolean
allIDs
Boolean
selectedIDs
array[Long] format: int64
allowedViews
map[String, Boolean]

UserRecord Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
role (optional)
String
directoryPolicyValue (optional)
String
firstName (optional)
String
lastName (optional)
String
dn (optional)

565/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
position (optional)
String
email (optional)
String
state (optional)
byte[] format: byte
userID (optional)
String
password (optional)
String
status (optional)
Integer format: int32
notes (optional)
String
language (optional)
String
country (optional)
String
version (optional)
Double format: double
packedVersion (optional)
Double format: double
creationTime (optional)
Date format: date-time
validForTime (optional)
Date format: date-time
validForInactivityDays (optional)
Long format: int64
validForInactivityAgeTime (optional)
Long format: int64
lastActivityTime (optional)
Long format: int64
address (optional)
String
city (optional)
String
mailState (optional)
String
zipCode (optional)
String
phone (optional)
String
organization (optional)
String
organizationalUnit (optional)
String
type (optional)
byte[] format: byte
attributes (optional)
array[NameValue]
adminProfileId (optional)
Long format: int64
guestId (optional)
Long format: int64
mobileNumber (optional)
String
mobileProvider (optional)
String
ncmPropagateHosts (optional)
Boolean
lastModifiedBy (optional)

566/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
lastModifiedDate (optional)
Date format: date-time
apiAccessToken (optional)
String
trustedHosts (optional)
String
locale (optional)
UserRecord_locale
name (optional)
String
guestContractor (optional)
Boolean
validTime (optional)
Long format: int64
adminUser (optional)
Boolean
creationEvent (optional)
YamsEvent
destroyEvent (optional)
YamsEvent
establishedEvent (optional)
YamsEvent
lostEvent (optional)
YamsEvent
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String
disabled (optional)
Boolean
directoryDisabled (optional)
Boolean
apiAdmin (optional)
Boolean
superUser (optional)
Boolean
validForTimeMS (optional)
Long format: int64
userAdministrator (optional)
Boolean
userOperator (optional)
Boolean
userHelpDesk (optional)
Boolean
userAdministrative (optional)
Boolean
currentEnvironment (optional)
map[String, String]
deleteHostsUponExpiration (optional)
Boolean
iconType (optional)
String

UserRecordFilterSpecification Up

maxRowLimit (optional)
Integer format: int32
methodNames (optional)
array[String]

567/615
1/21/22, 11:27 AM FortiNAC REST Schema

groupIDsOperator (optional)
String
Enum:
AND
OR
groupNames (optional)
array[String]
groupNamesOperator (optional)
String
Enum:
AND
OR
sortColumn (optional)
String
id (optional)
Long format: int64
orFilter (optional)
Boolean
ids (optional)
array[Long] format: int64
attributeNames (optional)
array[String]
type (optional)
Integer format: int32
position (optional)
String
address (optional)
String
userID (optional)
String
email (optional)
String
role (optional)
String
notes (optional)
String
firstName (optional)
String
lastName (optional)
String
validForTime (optional)
Date format: date-time
filterEmpty (optional)
Boolean
types (optional)
array[BigDecimal]
creationTimeStart (optional)
Long format: int64
creationTimeEnd (optional)
Long format: int64
creationTimeLastX (optional)
Long format: int64
validForTimeStart (optional)
Long format: int64
validForTimeEnd (optional)
Long format: int64
validForTimeLastX (optional)
Long format: int64
textString (optional)
String
attributeSearchValues (optional)
array[String]
directoryPolicyValue (optional)

568/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
zip (optional)
String
phone (optional)
String
city (optional)
String
mailState (optional)
String
mobileNumber (optional)
String
mobileProvider (optional)
String
guestId (optional)
Long format: int64
adminProfileId (optional)
Long format: int64
validForInactivityTimeStart (optional)
Long format: int64
validForInactivityTimeEnd (optional)
Long format: int64
validForInactivityTimeLastX (optional)
Long format: int64
validForInactivityTime (optional)
Date format: date-time
lastActivityTimeStart (optional)
Long format: int64
lastActivityTimeEnd (optional)
Long format: int64
lastActivityTimeLastX (optional)
Long format: int64
userIDs (optional)
array[Object]
methodSearchValues (optional)
array[Object]
sortEnabled (optional)
Boolean
sortAscending (optional)
Boolean
sortDescending (optional)
Boolean
groupIDsToFilter (optional)
array[Long] format: int64
queryFilterWhereClause (optional)
String

UserRecordResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[UserRecord]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

UserRecord_locale Up

language (optional)

569/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
script (optional)
String
country (optional)
String
variant (optional)
String
extensionKeys (optional)
array[String]
unicodeLocaleAttributes (optional)
array[String]
unicodeLocaleKeys (optional)
array[String]
iso3Language (optional)
String
iso3Country (optional)
String
displayLanguage (optional)
String
displayScript (optional)
String
displayCountry (optional)
String
displayVariant (optional)
String
displayName (optional)
String

UserSessionTimeoutResult Up

status (optional)
String
errorMessage (optional)
String
timeout (optional)
Long format: int64

UserSummaryDataResult Up

status (optional)
String
errorMessage (optional)
String
totalUsers (optional)
Long format: int64
enabledUsers (optional)
Long format: int64
disabledUsers (optional)
Long format: int64
totalGuests (optional)
Long format: int64
enabledGuests (optional)
Long format: int64
disabledGuests (optional)
Long format: int64

VendorCode Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64

570/615
1/21/22, 11:27 AM FortiNAC REST Schema

vendorCode (optional)
String
vendorName (optional)
String
vendorAlias (optional)
String
description (optional)
String
role (optional)
String
registrationType (optional)
String
userRegistrationType (optional)
String
state (optional)
byte[] format: byte
version (optional)
Double format: double
lastModifiedBy (optional)
String
lastModifiedDate (optional)
Date format: date-time
modifyAuditSummary (optional)
String
auditObjectName (optional)
String
auditObjectType (optional)
AuditRecordType
addAuditSummary (optional)
String

VendorCodeResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[VendorCode]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

VendorOUISupportingInfoResult Up

status (optional)
String
errorMessage (optional)
String
regTypes (optional)
array[PairStringString]
roles (optional)
array[NameIDPair]

ViewList Up

ViewMap Up

VulnerabilityScanNamesResult Up
571/615
1/21/22, 11:27 AM FortiNAC REST Schema

status (optional)
String
errorMessage (optional)
String
result (optional)
map[String, String]
deletedScans (optional)
array[String]
scans (optional)
map[String, String]

WebServiceDefinition Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
globallyModifiedDateMilliseconds (optional)
Long format: int64
lastModifiedDateMilliseconds (optional)
Long format: int64
id (optional)
Long format: int64
serviceType (optional)
String
serviceMatcher (optional)
String
serviceAction (optional)
String
serviceTarget (optional)
String
gUID (optional)
Long format: int64
globalModifiedDate (optional)
Date format: date-time

WebServiceDefinitionResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[WebServiceDefinition]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

WeeklySchedule Up

version (optional)
Double format: double
startTimeOfDay (optional)
Integer format: int32
endTimeOfDay (optional)
Integer format: int32
daysOfWeek (optional)
Integer format: int32
alwaysOn (optional)

572/615
1/21/22, 11:27 AM FortiNAC REST Schema
Boolean
startTimeOfDayAM (optional)
Boolean
endTimeOfDayAM (optional)
Boolean
startTimeOfDayHours (optional)
Integer format: int32
endTimeOfDayHours (optional)
Integer format: int32
startTimeOfDayMinutes (optional)
Integer format: int32
endTimeOfDayMinutes (optional)
Integer format: int32
validTime (optional)
Boolean

WinbindConfig Up

lastModifiedBy (optional)
String
lastChangeSummary (optional)
String
lastModifiedDate (optional)
Date format: date-time
dbid (optional)
Long format: int64
name (optional)
String
workgroup (optional)
String
localNetbios (optional)
String
localNetbiosSecondary (optional)
String
security (optional)
String
realm (optional)
String
logLevel (optional)
Integer format: int32
passwordServer (optional)
String
virtual (optional)
Boolean
joined (optional)
Boolean
valid (optional)
Boolean
logLevelStr (optional)
String
yamsEventTag (optional)
String
auditObj (optional)
IAuditObject

WinbindConfigListResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)

573/615
1/21/22, 11:27 AM FortiNAC REST Schema
array[WinbindConfig]

WinbindConfigResult Up

status (optional)
String
errorMessage (optional)
String
result (optional)
WinbindConfig
serviceEnabled (optional)
Boolean

WinbindGlobalResult Up

status (optional)
String
errorMessage (optional)
String
name (optional)
String
processEnabled (optional)
Boolean
processRunning (optional)
Boolean
isJoined (optional)
Boolean
joinStatus (optional)
String
serviceStatus (optional)
String
localNetbiosName (optional)
String
secondaryLocalNetbiosName (optional)
String

WinbindLogResult Up

status (optional)
String
errorMessage (optional)
String
log (optional)
String
systemdJournal (optional)
String

WinbindStatusResult Up

status (optional)
String
errorMessage (optional)
String
name (optional)
String
processEnabled (optional)
Boolean
processRunning (optional)
Boolean
isJoined (optional)
Boolean
joinStatus (optional)

574/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
serviceStatus (optional)
String

YamsAlarm Up

landscape (optional)
Long format: int64
id (optional)
Long format: int64
state (optional)
byte[] format: byte
name (optional)
String
elementType (optional)
byte[] format: byte
elementID (optional)
Long format: int64
elementName (optional)
String
severity (optional)
Integer format: int32
timeOfAlarm (optional)
Date format: date-time
timeAcknowledged (optional)
Date format: date-time
eventIDs (optional)
array[Long] format: int64
version (optional)
Double format: double
log (optional)
Boolean
time (optional)
Long format: int64
empty (optional)
Boolean
nameLabel (optional)
String
numEventID (optional)
Integer format: int32
probableCause (optional)
String
triggerRuleType (optional)
AlarmTriggerRule

YamsAlarmResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[YamsAlarm]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

YamsEvent Up

landscape (optional)
Long format: int64

575/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
Long format: int64
state (optional)
byte[] format: byte
name (optional)
String
elementType (optional)
byte[] format: byte
elementID (optional)
Long format: int64
elementName (optional)
String
message (optional)
String
timeOfEvent (optional)
Date format: date-time
version (optional)
Double format: double
log (optional)
Boolean
time (optional)
Long format: int64
empty (optional)
Boolean
eventFormatString (optional)
String

YamsEventResult Up

status (optional)
String
errorMessage (optional)
String
results (optional)
array[YamsEvent]
filtered (optional)
Long format: int64
total (optional)
Long format: int64

body Up

containerName (optional)
String

body_1 Up

containerName (optional)
String

body_10 Up

id (optional)
array[Long] format: int64

body_100 Up

logLevel (optional)
String
id (optional)
array[Long] format: int64

576/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_101 Up

groupID (optional)
Long format: int64
id (optional)
array[Long] format: int64

body_102 Up

groupID (optional)
Long format: int64
id (optional)
array[Long] format: int64

body_103 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_104 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_105 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_106 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_107 Up

id (optional)
array[Long] format: int64

body_108 Up

id (optional)
array[Long] format: int64

body_109 Up

id (optional)
array[Long] format: int64

body_11 Up

id (optional)
array[Long] format: int64

577/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_110 Up

id (optional)
array[Long] format: int64

body_111 Up

id (optional)
array[Long] format: int64

body_112 Up

id (optional)
array[Long] format: int64

body_113 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_114 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_115 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_116 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_117 Up

id (optional)
array[Long] format: int64

body_118 Up

id (optional)
array[Long] format: int64

body_119 Up

id (optional)
array[Long] format: int64

body_12 Up

id (optional)
array[Long] format: int64

578/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_120 Up

id (optional)
array[Long] format: int64

body_121 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_122 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_123 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_124 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_125 Up

id (optional)
array[Long] format: int64

body_126 Up

id (optional)
array[Long] format: int64

body_127 Up

id (optional)
array[Long] format: int64

body_128 Up

id (optional)
array[Long] format: int64

body_129 Up

os (optional)
String
scanType (optional)
String
scanName (optional)
String

579/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_13 Up

id (optional)
array[Long] format: int64

body_130 Up

os (optional)
String
scanType (optional)
String
scanName (optional)
String

body_131 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_132 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_133 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_134 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_135 Up

id (optional)
array[Long] format: int64

body_136 Up

id (optional)
array[Long] format: int64

body_137 Up

policyName (optional)
String
newPolicyName (optional)
String

body_138 Up

policyName (optional)
String
580/615
1/21/22, 11:27 AM FortiNAC REST Schema

newPolicyName (optional)
String

body_139 Up

id (optional)
array[Long] format: int64

body_14 Up

id (optional)
array[Long] format: int64

body_140 Up

id (optional)
array[Long] format: int64

body_141 Up

id (optional)
array[Long] format: int64

body_142 Up

id (optional)
array[Long] format: int64

body_143 Up

id (optional)
array[Long] format: int64

body_144 Up

id (optional)
array[Long] format: int64

body_145 Up

id (optional)
array[Long] format: int64

body_146 Up

id (optional)
array[Long] format: int64

body_147 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_148 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

581/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_149 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_15 Up

id (optional)
array[Long] format: int64

body_150 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_151 Up

id (optional)
array[Long] format: int64

body_152 Up

id (optional)
array[Long] format: int64

body_153 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_154 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_155 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_156 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_157 Up

id (optional)
array[Long] format: int64

582/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_158 Up

id (optional)
array[Long] format: int64

body_159 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_16 Up

mac (optional)
array[String]

body_160 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_161 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_162 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_163 Up

id (optional)
array[Long] format: int64

body_164 Up

id (optional)
array[Long] format: int64

body_165 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_166 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

583/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_167 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_168 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_169 Up

id (optional)
array[Long] format: int64

body_17 Up

mac (optional)
array[String]

body_170 Up

id (optional)
array[Long] format: int64

body_171 Up

id (optional)
array[Long] format: int64

body_172 Up

id (optional)
array[Long] format: int64

body_173 Up

id (optional)
array[Long] format: int64

body_174 Up

id (optional)
array[Long] format: int64

body_175 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_176 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

584/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_177 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_178 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_179 Up

id (optional)
array[Long] format: int64

body_18 Up

ip-address (optional)
String

body_180 Up

id (optional)
array[Long] format: int64

body_181 Up

id (optional)
array[Long] format: int64

body_182 Up

id (optional)
array[Long] format: int64

body_183 Up

id (optional)
array[Long] format: int64

body_184 Up

id (optional)
array[Long] format: int64

body_185 Up

id (optional)
array[Long] format: int64

body_186 Up

id (optional)
array[Long] format: int64

body_187 Up

id (optional)
array[Long] format: int64
585/615
1/21/22, 11:27 AM FortiNAC REST Schema

body_188 Up

id (optional)
array[Long] format: int64

body_189 Up

id (optional)
array[Long] format: int64

body_19 Up

ip-address (optional)
String

body_190 Up

id (optional)
array[Long] format: int64

body_191 Up

id (optional)
array[Long] format: int64

body_192 Up

id (optional)
array[Long] format: int64

body_193 Up

id (optional)
array[Long] format: int64
replaceWinbindId (optional)
Long format: int64

body_194 Up

id (optional)
array[Long] format: int64
replaceWinbindId (optional)
Long format: int64

body_195 Up

username (optional)
String
password (optional)
String

body_196 Up

startIP (optional)
String
endIP (optional)
String

body_197 Up

startIP (optional)

586/615
1/21/22, 11:27 AM FortiNAC REST Schema
String
endIP (optional)
String

body_198 Up

username (optional)
String
domain (optional)
String

body_199 Up

username (optional)
String
domain (optional)
String

body_2 Up

body_20 Up

id (optional)
array[Long] format: int64

body_200 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_201 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_202 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_203 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_204 Up

id (optional)
array[Long] format: int64

body_205 Up

id (optional)

587/615
1/21/22, 11:27 AM FortiNAC REST Schema
array[Long] format: int64

body_206 Up

id (optional)
array[Long] format: int64

body_207 Up

id (optional)
array[Long] format: int64

body_208 Up

id (optional)
array[Long] format: int64

body_209 Up

id (optional)
array[Long] format: int64

body_21 Up

id (optional)
array[Long] format: int64

body_210 Up

createRogues (optional)
String
disablePing (optional)
String
collectEnabled (optional)
String
collectUrl (optional)
String
queryUrl (optional)
String

body_211 Up

createRogues (optional)
String
disablePing (optional)
String
collectEnabled (optional)
String
collectUrl (optional)
String
queryUrl (optional)
String

body_212 Up

name (optional)
String
imageName (optional)
String

body_213 Up

588/615
1/21/22, 11:27 AM FortiNAC REST Schema

name (optional)
String
imageName (optional)
String

body_214 Up

id (optional)
array[Long] format: int64

body_215 Up

id (optional)
array[Long] format: int64

body_216 Up

dbid (optional)
Long format: int64

body_217 Up

dbid (optional)
Long format: int64

body_218 Up

id (optional)
array[Long] format: int64

body_219 Up

id (optional)
array[Long] format: int64

body_22 Up

id (optional)
array[Long] format: int64

body_220 Up

id (optional)
array[Long] format: int64

body_221 Up

id (optional)
array[Long] format: int64

body_222 Up

id (optional)
array[Long] format: int64

body_223 Up

id (optional)
array[Long] format: int64

body_224 Up

589/615
1/21/22, 11:27 AM FortiNAC REST Schema

clientID (optional)
String
senderID (optional)
String
apiKey (optional)
String

body_225 Up

clientID (optional)
String
senderID (optional)
String
apiKey (optional)
String

body_226 Up

domainName (optional)
String

body_227 Up

domainName (optional)
String

body_228 Up

domainName (optional)
array[String]

body_229 Up

domainName (optional)
array[String]

body_23 Up

id (optional)
array[Long] format: int64

body_230 Up

domainName (optional)
String

body_231 Up

domainName (optional)
String

body_232 Up

id (optional)
array[Long] format: int64

body_233 Up

id (optional)
array[Long] format: int64

body_234 Up
590/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
array[Long] format: int64

body_235 Up

id (optional)
array[Long] format: int64

body_236 Up

dbid (optional)
Long format: int64

body_237 Up

dbid (optional)
Long format: int64

body_238 Up

mdmVendor (optional)
String
applicationID (optional)
String
identifier (optional)
String
appAccessKey (optional)
String
platformID (optional)
String
authCode (optional)
String

body_239 Up

mdmVendor (optional)
String
applicationID (optional)
String
identifier (optional)
String
appAccessKey (optional)
String
platformID (optional)
String
authCode (optional)
String

body_24 Up

id (optional)
array[Long] format: int64

body_240 Up

ids (optional)
array[Long] format: int64

body_241 Up

ids (optional)
array[Long] format: int64

591/615
1/21/22, 11:27 AM FortiNAC REST Schema

body_242 Up

id (optional)
array[Long] format: int64

body_243 Up

id (optional)
array[Long] format: int64

body_244 Up

bigFixPort (optional)
Integer format: int32
bigFixUser (optional)
String
bigFixName (optional)
String
bigFixPassword (optional)
String
pollingInterval (optional)
String

body_245 Up

bigFixPort (optional)
Integer format: int32
bigFixUser (optional)
String
bigFixName (optional)
String
bigFixPassword (optional)
String
pollingInterval (optional)
String

body_246 Up

radiusServer (optional)
String
domainName (optional)
String

body_247 Up

radiusServer (optional)
String
domainName (optional)
String

body_248 Up

primaryRadiusServer (optional)
String
secondaryRadiusServer (optional)
String

body_249 Up

primaryRadiusServer (optional)
String

592/615
1/21/22, 11:27 AM FortiNAC REST Schema

secondaryRadiusServer (optional)
String

body_25 Up

id (optional)
array[Long] format: int64

body_250 Up

domainName (optional)
String

body_251 Up

domainName (optional)
String

body_252 Up

domain (optional)
array[String]

body_253 Up

domain (optional)
array[String]

body_254 Up

id (optional)
array[Long] format: int64

body_255 Up

id (optional)
array[Long] format: int64

body_256 Up

maxLength (optional)
Long format: int64

body_257 Up

maxLength (optional)
Long format: int64

body_258 Up

id (optional)
array[Long] format: int64

body_259 Up

id (optional)
array[Long] format: int64

body_26 Up

ruleName (optional)
String

593/615
1/21/22, 11:27 AM FortiNAC REST Schema

macAddress (optional)
String

body_260 Up

message (optional)
String
format (optional)
Integer format: int32
delimiter (optional)
String
tagDelimiter (optional)
String

body_261 Up

message (optional)
String
format (optional)
Integer format: int32
delimiter (optional)
String
tagDelimiter (optional)
String

body_262 Up

id (optional)
array[Long] format: int64

body_263 Up

id (optional)
array[Long] format: int64

body_264 Up

id (optional)
Long format: int64

body_265 Up

id (optional)
Long format: int64

body_266 Up

id (optional)
Long format: int64

body_267 Up

id (optional)
Long format: int64

body_268 Up

id (optional)
array[Long] format: int64

body_269 Up

594/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
array[Long] format: int64

body_27 Up

ruleName (optional)
String
macAddress (optional)
String

body_270 Up

id (optional)
array[Long] format: int64

body_271 Up

id (optional)
array[Long] format: int64

body_272 Up

vendor (optional)
String
userID (optional)
String
requestStr (optional)
String
vulnPW (optional)
String

body_273 Up

vendor (optional)
String
userID (optional)
String
requestStr (optional)
String
vulnPW (optional)
String

body_274 Up

id (optional)
array[Long] format: int64

body_275 Up

id (optional)
array[Long] format: int64

body_276 Up

fingerprint (optional)
array[String]

body_277 Up

fingerprint (optional)
array[String]

595/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_278 Up

targetType (optional)
String
privateKeyType (optional)
String
certs (optional)
array[FormDataBodyPart]
privateKey (optional)
FormDataBodyPart

body_279 Up

sourceCert (optional)
String
targetCert (optional)
String

body_28 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_280 Up

sourceCert (optional)
String
targetCert (optional)
String

body_281 Up

target (optional)
String

body_282 Up

target (optional)
String

body_283 Up

id (optional)
array[Long] format: int64

body_284 Up

id (optional)
array[Long] format: int64

body_285 Up

id (optional)
array[Long] format: int64

body_286 Up

id (optional)
array[Long] format: int64

596/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_287 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_288 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_289 Up

id (optional)
array[Long] format: int64

body_29 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_290 Up

id (optional)
array[Long] format: int64

body_291 Up

elemID (optional)
array[Long] format: int64
groupID (optional)
array[Long] format: int64

body_292 Up

elemID (optional)
array[Long] format: int64
groupID (optional)
array[Long] format: int64

body_293 Up

deviceList (optional)
array[Long] format: int64

body_294 Up

deviceList (optional)
array[Long] format: int64

body_295 Up

type (optional)
byte[] format: byte
elemID (optional)
array[Long] format: int64
groupID (optional)
array[Long] format: int64
597/615
1/21/22, 11:27 AM FortiNAC REST Schema

body_296 Up

type (optional)
byte[] format: byte
elemID (optional)
array[Long] format: int64
groupID (optional)
array[Long] format: int64

body_297 Up

memberID (optional)
Long format: int64
type (optional)
byte[] format: byte
serverIP (optional)
String
groupID (optional)
array[Long] format: int64

body_298 Up

memberID (optional)
Long format: int64
type (optional)
byte[] format: byte
serverIP (optional)
String
groupID (optional)
array[Long] format: int64

body_299 Up

id (optional)
array[Long] format: int64
daysValid (optional)
Integer format: int32
daysInactive (optional)
Integer format: int32

body_3 Up

body_30 Up

id (optional)
array[Long] format: int64

body_300 Up

id (optional)
array[Long] format: int64
daysValid (optional)
Integer format: int32
daysInactive (optional)
Integer format: int32

body_301 Up

parentID (optional)
Long format: int64

598/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
array[Long] format: int64

body_302 Up

parentID (optional)
Long format: int64
id (optional)
array[Long] format: int64

body_303 Up

groupID (optional)
Long format: int64
parentID (optional)
array[Long] format: int64
replace (optional)
Boolean

body_304 Up

groupID (optional)
Long format: int64
parentID (optional)
array[Long] format: int64
replace (optional)
Boolean

body_305 Up

id (optional)
array[Long] format: int64

body_306 Up

id (optional)
array[Long] format: int64

body_307 Up

deviceList (optional)
array[Long] format: int64

body_308 Up

deviceList (optional)
array[Long] format: int64

body_309 Up

id (optional)
array[Long] format: int64

body_31 Up

id (optional)
array[Long] format: int64

body_310 Up

id (optional)
array[Long] format: int64

599/615
1/21/22, 11:27 AM FortiNAC REST Schema

body_311 Up

ip (optional)
String

body_312 Up

ip (optional)
String

body_313 Up

id (optional)
array[Long] format: int64

body_314 Up

id (optional)
array[Long] format: int64

body_315 Up

ip (optional)
String
name (optional)
String

body_316 Up

ip (optional)
String
name (optional)
String

body_317 Up

serverIP (optional)
String

body_318 Up

serverIP (optional)
String

body_319 Up

timezone (optional)
String
NTPAddr (optional)
String
IPParam (optional)
String

body_32 Up

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_320 Up

600/615
1/21/22, 11:27 AM FortiNAC REST Schema

timezone (optional)
String
NTPAddr (optional)
String
IPParam (optional)
String

body_321 Up

id (optional)
array[Long] format: int64

body_322 Up

id (optional)
array[Long] format: int64

body_323 Up

id (optional)
array[Long] format: int64

body_324 Up

id (optional)
array[Long] format: int64

body_325 Up

enable (optional)
Boolean
plugin (optional)
array[String]

body_326 Up

enable (optional)
Boolean
plugin (optional)
array[String]

body_327 Up

attrName (optional)
array[String]

body_328 Up

attrName (optional)
array[String]

body_329 Up

attrName (optional)
String
attrVal (optional)
String
isModify (optional)
Boolean

body_33 Up

601/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
Long format: int64
rank (optional)
Long format: int64

body_330 Up

attrName (optional)
String
attrVal (optional)
String
isModify (optional)
Boolean

body_331 Up

reloadType (optional)
String

body_332 Up

reloadType (optional)
String

body_333 Up

recipient (optional)
String
subject (optional)
String
message (optional)
String

body_334 Up

recipient (optional)
String
subject (optional)
String
message (optional)
String

body_335 Up

enabled (optional)
Boolean

body_336 Up

enabled (optional)
Boolean

body_337 Up

warningAttrName (optional)
String
warningAttrVal (optional)
String
criticalAttrName (optional)
String
criticalAttrVal (optional)
String

602/615
1/21/22, 11:27 AM FortiNAC REST Schema

body_338 Up

warningAttrName (optional)
String
warningAttrVal (optional)
String
criticalAttrName (optional)
String
criticalAttrVal (optional)
String

body_339 Up

licenseKey (optional)
String

body_34 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_340 Up

licenseKey (optional)
String

body_341 Up

testHost (optional)
String
testAutoDefDir (optional)
String
testProductDistDir (optional)
String
testAgentDistDir (optional)
String
testUser (optional)
String
testPassword (optional)
String
decodePW (optional)
String
protocol (optional)
String

body_342 Up

testHost (optional)
String
testAutoDefDir (optional)
String
testProductDistDir (optional)
String
testAgentDistDir (optional)
String
testUser (optional)
String
testPassword (optional)
String

603/615
1/21/22, 11:27 AM FortiNAC REST Schema

decodePW (optional)
String
protocol (optional)
String

body_343 Up

id (optional)
array[Long] format: int64

body_344 Up

id (optional)
array[Long] format: int64

body_345 Up

id (optional)
array[Long] format: int64

body_346 Up

id (optional)
array[Long] format: int64

body_347 Up

templateID (optional)
Long format: int64

body_348 Up

templateID (optional)
Long format: int64

body_349 Up

id (optional)
array[Long] format: int64
messageTemplate (optional)
Long format: int64

body_35 Up

id1 (optional)
Long format: int64
id2 (optional)
Long format: int64

body_350 Up

id (optional)
array[Long] format: int64
messageTemplate (optional)
Long format: int64

body_351 Up

id (optional)
array[Long] format: int64
messageTemplate (optional)
Long format: int64

604/615
1/21/22, 11:27 AM FortiNAC REST Schema

body_352 Up

id (optional)
array[Long] format: int64
messageTemplate (optional)
Long format: int64

body_353 Up

id (optional)
array[Long] format: int64

body_354 Up

id (optional)
array[Long] format: int64

body_355 Up

id (optional)
array[Long] format: int64

body_356 Up

id (optional)
array[Long] format: int64

body_357 Up

user (optional)
String
password (optional)
String

body_358 Up

user (optional)
String
password (optional)
String
newUserID (optional)
String
newPassword (optional)
String

body_359 Up

key (optional)
String
value (optional)
String

body_36 Up

id (optional)
array[Long] format: int64

body_360 Up

key (optional)
String

605/615
1/21/22, 11:27 AM FortiNAC REST Schema

value (optional)
String

body_361 Up

user (optional)
String
password (optional)
String

body_362 Up

guestMessage (optional)
String
requestKey (optional)
String

body_363 Up

guestMessage (optional)
String
requestKey (optional)
String

body_364 Up

guestMessage (optional)
String
requestKey (optional)
String

body_365 Up

guestMessage (optional)
String
requestKey (optional)
String

body_366 Up

value (optional)
String

body_367 Up

value (optional)
String

body_368 Up

userID (optional)
String
value (optional)
String

body_369 Up

userID (optional)
String
value (optional)
String

606/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_37 Up

id (optional)
array[Long] format: int64

body_370 Up

id (optional)
array[Long] format: int64

body_371 Up

id (optional)
array[Long] format: int64

body_372 Up

userID (optional)
String

body_373 Up

userID (optional)
String

body_374 Up

userID (optional)
String

body_375 Up

userID (optional)
String

body_376 Up

role (optional)
String
id (optional)
array[Long] format: int64

body_377 Up

role (optional)
String
id (optional)
array[Long] format: int64

body_378 Up

profileID (optional)
Long format: int64
id (optional)
array[Long] format: int64

body_379 Up

profileID (optional)
Long format: int64
id (optional)
array[Long] format: int64

607/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_38 Up

id (optional)
array[Long] format: int64

body_380 Up

userID (optional)
String
password (optional)
String

body_381 Up

userID (optional)
String
password (optional)
String

body_382 Up

allowedHosts (optional)
String

body_383 Up

allowedHosts (optional)
String

body_384 Up

id (optional)
array[Long] format: int64

body_385 Up

id (optional)
array[Long] format: int64

body_39 Up

id (optional)
array[Long] format: int64

body_4 Up

id (optional)
array[Long] format: int64

body_40 Up

override (optional)
Integer format: int32
appID (optional)
array[Long] format: int64

body_41 Up

override (optional)
Integer format: int32
appID (optional)
array[Long] format: int64

608/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_42 Up

id (optional)
array[Long] format: int64

body_43 Up

id (optional)
array[Long] format: int64

body_44 Up

id (optional)
array[Long] format: int64
role (optional)
String
devType (optional)
String
domainID (optional)
String
ip (optional)
String
regType (optional)
String

body_45 Up

id (optional)
array[Long] format: int64
role (optional)
String
devType (optional)
String
domainID (optional)
String
ip (optional)
String
regType (optional)
String

body_46 Up

mac (optional)
String

body_47 Up

mac (optional)
String

body_48 Up

mac (optional)
String

body_49 Up

mac (optional)
String

body_5 Up

609/615
1/21/22, 11:27 AM FortiNAC REST Schema

id (optional)
array[Long] format: int64

body_50 Up

mac (optional)
String
userID (optional)
String

body_51 Up

mac (optional)
String
userID (optional)
String

body_52 Up

ip (optional)
String

body_53 Up

ip (optional)
String

body_54 Up

ip (optional)
String

body_55 Up

ip (optional)
String

body_56 Up

id (optional)
array[Long] format: int64
message (optional)
String
url (optional)
String
duration (optional)
Long format: int64

body_57 Up

id (optional)
array[Long] format: int64
message (optional)
String
url (optional)
String
duration (optional)
Long format: int64

body_58 Up

id (optional)

610/615
1/21/22, 11:27 AM FortiNAC REST Schema
array[Long] format: int64
role (optional)
String

body_59 Up

id (optional)
array[Long] format: int64
role (optional)
String

body_6 Up

enabled (optional)
Boolean
createRogues (optional)
Boolean
frequencySeconds (optional)
Long format: int64
priority (optional)
Integer format: int32
id (optional)
array[Long] format: int64

body_60 Up

id (optional)
array[Long] format: int64
setExpiration (optional)
Boolean
setInactivity (optional)
Boolean
expireDays (optional)
Integer format: int32
expireDateMS (optional)
Long format: int64
inactiveDays (optional)
Integer format: int32

body_61 Up

id (optional)
array[Long] format: int64
setExpiration (optional)
Boolean
setInactivity (optional)
Boolean
expireDays (optional)
Integer format: int32
expireDateMS (optional)
Long format: int64
inactiveDays (optional)
Integer format: int32

body_62 Up

profileName (optional)
String
status (optional)
byte[] format: byte
profileID (optional)
Long format: int64

611/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_63 Up

profileName (optional)
String
status (optional)
byte[] format: byte
profileID (optional)
Long format: int64

body_64 Up

profileID (optional)
Long format: int64

body_65 Up

profileID (optional)
Long format: int64

body_66 Up

id (optional)
array[Long] format: int64

body_67 Up

id (optional)
array[Long] format: int64

body_68 Up

uuid (optional)
String

body_69 Up

uuid (optional)
String

body_7 Up

enabled (optional)
Boolean
createRogues (optional)
Boolean
frequencySeconds (optional)
Long format: int64
priority (optional)
Integer format: int32
id (optional)
array[Long] format: int64

body_70 Up

file (optional)
FormDataBodyPart

body_71 Up

id (optional)
array[Long] format: int64

612/615
1/21/22, 11:27 AM FortiNAC REST Schema
body_72 Up

id (optional)
array[Long] format: int64

body_73 Up

id (optional)
array[Long] format: int64

body_74 Up

id (optional)
array[Long] format: int64

body_75 Up

id (optional)
array[Long] format: int64

body_76 Up

id (optional)
array[Long] format: int64

body_77 Up

id (optional)
array[Long] format: int64

body_78 Up

id (optional)
array[Long] format: int64

body_79 Up

id (optional)
array[Long] format: int64

body_8 Up

isHost (optional)
Boolean
containerID (optional)
Long format: int64
deviceID (optional)
array[Long] format: int64

body_80 Up

id (optional)
array[Long] format: int64

body_81 Up

name (optional)
String

body_82 Up

name (optional)
String
613/615
1/21/22, 11:27 AM FortiNAC REST Schema

body_83 Up

fileName (optional)
String

body_84 Up

fileName (optional)
String

body_85 Up

id (optional)
array[Long] format: int64

body_86 Up

id (optional)
array[Long] format: int64

body_87 Up

fileName (optional)
String

body_88 Up

fileName (optional)
String

body_89 Up

note (optional)
String
id (optional)
array[Long] format: int64

body_9 Up

isHost (optional)
Boolean
containerID (optional)
Long format: int64
deviceID (optional)
array[Long] format: int64

body_90 Up

note (optional)
String
id (optional)
array[Long] format: int64

body_91 Up

id (optional)
array[Long] format: int64

body_92 Up

id (optional)

614/615
1/21/22, 11:27 AM FortiNAC REST Schema
array[Long] format: int64

body_93 Up

id (optional)
Long format: int64

body_94 Up

id (optional)
Long format: int64

body_95 Up

id (optional)
Long format: int64

body_96 Up

id (optional)
Long format: int64

body_97 Up

severity (optional)
Integer format: int32
notifyGroupID (optional)
Long format: int64
notifyByEmail (optional)
Boolean
notifyBySMS (optional)
Boolean
ids (optional)
array[Long] format: int64

body_98 Up

severity (optional)
Integer format: int32
notifyGroupID (optional)
Long format: int64
notifyByEmail (optional)
Boolean
notifyBySMS (optional)
Boolean
ids (optional)
array[Long] format: int64

body_99 Up

logLevel (optional)
String
id (optional)
array[Long] format: int64

615/615