Documentation

Monitor extends FortiOSAPI

FortiOS API Monitor

Tags
link

Fortinet developer ressource center.

Table of Contents

$config  : Config
$session_key  : string
$transaction  : int|null
$config  : Config
$session_key  : string
$transaction  : mixed
__construct()  : mixed
Constructor takes care of checking and registering firewall's data and login to the API
__destruct()  : mixed
Destructor takes care of logout.
abortTransaction()  : bool
Abort a transaction (rollback operations).
addAzureApplicationListRefresh()  : stdClass
Update the Azure application list data or get the status of an update.
addEndpointControlEmsVerifyCert()  : stdClass
Verify EMS server certificate for a specific EMS.
addExtenderControllerExtenderDiagnose()  : stdClass
Execute diagnotic commands.
addExtenderControllerExtenderReset()  : stdClass
Reset a specific FortiExtender unit.
addExtenderControllerExtenderUpgrade()  : stdClass
Upgrade FortiExtender.
addFirewallAcl6Clear_counters()  : stdClass
Reset counters for one or more IPv6 ACLs by policy ID.
addFirewallAclClear_counters()  : stdClass
Reset counters for one or more IPv4 ACLs by policy ID.
addFirewallClearpassAddressAdd()  : stdClass
Add ClearPass address with SPT (System Posture Token) value.
addFirewallClearpassAddressDelete()  : stdClass
Delete ClearPass address with SPT (System Posture Token) value.
addFirewallPerIpShaperReset()  : stdClass
Reset statistics for all configured firewall per-IP traffic shapers.
addFirewallPolicyClear_counters()  : stdClass
Reset traffic statistics for one or more firewall policies by policy ID.
addFirewallPolicyReset()  : stdClass
Reset traffic statistics for all firewall policies.
addFirewallProxyPolicyClear_counters()  : stdClass
Reset traffic statistics for one or more explicit proxy policies by policy ID.
addFirewallSecurityPolicyClear_counters()  : stdClass
Reset traffic statistics for one or more security policies by policy ID.
addFirewallSessionClear_all()  : stdClass
Immediately clear all active IPv4 and IPv6 sessions and IPS sessions of current VDOM.
addFirewallSessionClose()  : stdClass
Close a specific firewall session that matches all provided criteria.
addFirewallShaperReset()  : stdClass
Reset statistics for all configured traffic shapers.
addFortiviewSessionCancel()  : stdClass
Cancel a FortiView request session.
addGeoipGeoipQuerySelect()  : stdClass
Retrieve location details for IPs queried against FortiGuard's geoip service.
addLicenseDatabaseUpgrade()  : stdClass
Upgrade or downgrade UTM engine or signature package (IPS/AntiVirus/Application Control/Industrial database/Security Rating) using uploaded file.
addLogLocalReportDelete()  : stdClass
Delete a local report.
addLogStatsReset()  : stdClass
Reset logging statistics for all log devices.
addNsxServiceAdd()  : stdClass
Add NSX service to connector.
addRegistrationForticareAddLicense()  : stdClass
Add a FortiCare license.
addRegistrationForticareCreate()  : stdClass
Create a new FortiCare account.
addRegistrationForticareLogin()  : stdClass
Login to FortiCare.
addRegistrationForticareTransfer()  : stdClass
Transfer to a new FortiCare account.
addRegistrationForticloudCreate()  : stdClass
Create a FortiCloud account.
addRegistrationForticloudLogin()  : stdClass
Login to FortiCloud.
addRegistrationForticloudLogout()  : stdClass
Logout from FortiCloud.
addRegistrationForticloudMigrate()  : stdClass
Migrate standalone FortiGate Cloud account to FortiCloud.
addRegistrationForticloudRegisterDevice()  : stdClass
Register a device to FortiCloud through FortiGate. Currently FortiSwitch and FortiAP are supported.
addRegistrationVdomAddLicense()  : stdClass
Add a VDOM license.
addSwitchControllerFswFirmwareDownload()  : stdClass
Download FortiSwitch firmware from FortiGuard to the FortiGate according to FortiSwitch image ID.
addSwitchControllerFswFirmwarePush()  : stdClass
Push FortiSwitch firmware to the given device.
addSwitchControllerFswFirmwareUpload()  : stdClass
Upload FortiSwitch firmware to the management FortiGate and then push to target FortiSwitches.
addSwitchControllerManagedSwitchFactoryReset()  : stdClass
Send 'Factory Reset' command to a given FortiSwitch.
addSwitchControllerManagedSwitchPoeReset()  : stdClass
Reset PoE on a given FortiSwitch's port.
addSwitchControllerManagedSwitchRestart()  : stdClass
Restart a given FortiSwitch.
addSwitchControllerManagedSwitchUpdate()  : stdClass
Update administrative state for a given FortiSwitch (enable or disable authorization).
addSystemAdminChangeVdomMode()  : stdClass
Switch between VDOM modes.
addSystemApiUserGenerateKey()  : stdClass
Generate a new api-key for the specified api-key-auth admin. The old api-key will be replaced. The response contains the only chance to read the new api-key plaintext in the api_key field.
addSystemAutomationStitchTest()  : stdClass
Triggers an automation stitch for testing purposes.
addSystemAutomationStitchWebhook()  : stdClass
Triggers an incoming webhook for an automation stitch.
addSystemCertificateReadInfo()  : stdClass
Get certificate information from a certificate string.
addSystemChangePasswordSelect()  : stdClass
Save admin and guest-admin passwords.
addSystemComLogDump()  : stdClass
Dump system com-log to file.
addSystemConfigRestore()  : stdClass
Restore system configuration from uploaded file or from USB.
addSystemConfigRevisionDelete()  : stdClass
Deletes one or more system configuration revisions.
addSystemConfigRevisionSave()  : stdClass
Create a new config revision checkpoint.
addSystemConfigRevisionUpdateComments()  : stdClass
Updates comments for a system configuration file.
addSystemConfigSave()  : stdClass
Explicitly save all configuration.
addSystemConfigScriptDelete()  : stdClass
Delete the history of config scripts.
addSystemConfigScriptRun()  : stdClass
Run remote config scripts.
addSystemConfigScriptUpload()  : stdClass
Upload and run a new configuration script file.
addSystemCsfRegisterAppliance()  : stdClass
Register appliance to Security Fabric.
addSystemDhcp6Revoke()  : stdClass
Revoke IPv6 DHCP leases.
addSystemDhcpRevoke()  : stdClass
Revoke IPv4 DHCP leases.
addSystemDisconnectAdminsSelect()  : stdClass
Disconnects logged in administrators.
addSystemFirmwareUpgrade()  : stdClass
Upgrade firmware image on this device using uploaded file.
addSystemFortiguardClearStatistics()  : stdClass
Immediately clear all FortiGuard statistics.
addSystemFortiguardTestAvailability()  : stdClass
Test availability of FortiGuard services.
addSystemFortiguardUpdate()  : stdClass
Immediately update status for FortiGuard services.
addSystemFortimanagerBackupAction()  : stdClass
Import or update from FortiManager objects.
addSystemFortimanagerConfig()  : stdClass
Configure FortiManager IP. Register FortiManager if 'fortimanager_ip' is provided. Unregister FortiManager if only 'unregister' parameter is specified and set to true.
addSystemFsckStart()  : stdClass
Set file system check flag so that it will be executed on next device reboot.
addSystemHaPeerDisconnect()  : stdClass
Update configuration of peer in HA cluster.
addSystemHaPeerUpdate()  : stdClass
Update configuration of peer in HA cluster.
addSystemInterfaceDhcpRenew()  : stdClass
Renew DHCP lease of an interface.
addSystemInterfaceSpeedTestTrigger()  : stdClass
Run a speed-test on the given interface.
addSystemLogdiskFormat()  : stdClass
Format log disk.
addSystemModemConnect()  : stdClass
Trigger a connect for the configured modem.
addSystemModemDisconnect()  : stdClass
Trigger a disconnect for the configured modem.
addSystemModemReset()  : stdClass
Reset statistics for internal/external configured modem.
addSystemModemUpdate()  : stdClass
Update supported modem list from FortiGuard.
addSystemOsReboot()  : stdClass
Immediately reboot this device.
addSystemOsShutdown()  : stdClass
Immediately shutdown this device.
addSystemPasswordPolicyConformSelect()  : stdClass
Check whether password conforms to the password policy.
addSystemSdnConnectorUpdate()  : stdClass
Update an SDN connector's connection status.
addSystemSdnConnectorValidateGcpKey()  : stdClass
Validate a string representing a private key from GCP in PEM format.
addSystemSecurityRatingTrigger()  : stdClass
Run a Security Rating report.
addSystemSnifferClear()  : stdClass
Clear the results of a specified packet capture.
addSystemSnifferRestart()  : stdClass
Restart specified packet capture.
addSystemSnifferStart()  : stdClass
Start specified packet capture.
addSystemSnifferStop()  : stdClass
Stop specified packet capture.
addSystemTimeSet()  : stdClass
Sets current system time stamp.
addSystemUsbDeviceEject()  : stdClass
Eject USB drives for safe removal.
addSystemUsbLogStart()  : stdClass
Start backup of logs from current VDOM to USB drive.
addSystemUsbLogStop()  : stdClass
Stop backup of logs to USB drive.
addSystemVmlicenseUpload()  : stdClass
Update VM license using uploaded file. Reboots immediately if successful.
addUserBannedAdd_users()  : stdClass
Immediately add one or more users to the banned list.
addUserBannedClear_all()  : stdClass
Immediately clear all banned users.
addUserBannedClear_users()  : stdClass
Immediately clear a list of specific banned users by IP.
addUserDeviceRemove()  : stdClass
Remove single or multiple user devices specified by host MAC addresses.
addUserFirewallAuth()  : stdClass
Trigger authentication for a single firewall user.
addUserFirewallDeauth()  : stdClass
Deauthenticate single, multiple, or all firewall users.
addUserFortitokenActivate()  : stdClass
Activate a set of FortiTokens by serial number.
addUserFortitokenImportMobile()  : stdClass
Import a list of tokens from FortiGuard to the FortiGate unit.
addUserFortitokenImportSeed()  : stdClass
Import a FortiToken seed file.
addUserFortitokenImportTrial()  : stdClass
Import trial mobile FortiTokens.
addUserFortitokenProvision()  : stdClass
Provision a set of FortiTokens by serial number.
addUserFortitokenRefresh()  : stdClass
Refresh a set of FortiTokens by serial number.
addUserFortitokenSendActivation()  : stdClass
Send a FortiToken activation code to a user via SMS or Email.
addUserFssoRefreshServer()  : stdClass
Refresh remote agent group list for all fsso agents.
addUserGuestEmail()  : stdClass
Sent guest login details via email.
addUserGuestSms()  : stdClass
Sent guest login details via SMS.
addUserRadiusTestConnect()  : stdClass
Test the connectivity of the given RADIUS server and, optionally, the validity of a username & password.
addUserTacacsPlusTest()  : stdClass
Test the connectivity of the given TACACS+ server.
addUtmRatingLookupSelect()  : stdClass
Lookup FortiGuard rating for a specific URL.
addVpnCertificateCaImport()  : stdClass
Import CA certificate.
addVpnCertificateCrlImport()  : stdClass
Import certificate revocation lists (CRL) from file content.
addVpnCertificateCsrGenerate()  : stdClass
Generate a certificate signing request (CSR) and a private key. The CSR can be retrieved / downloaded from CLI, GUI and REST API.
addVpnCertificateLocalImport()  : stdClass
Import local certificate.
addVpnCertificateRemoteImport()  : stdClass
Import remote certificate.
addVpnIkeClear()  : stdClass
Clear IKE gateways.
addVpnIpsecTunnel_down()  : stdClass
Bring down a specific IPsec VPN tunnel.
addVpnIpsecTunnel_reset_stats()  : stdClass
Reset statistics for a specific IPsec VPN tunnel.
addVpnIpsecTunnel_up()  : stdClass
Bring up a specific IPsec VPN tunnel.
addVpnSslClear_tunnel()  : stdClass
Remove all active tunnel sessions in current virtual domain.
addVpnSslDelete()  : stdClass
Terminate the provided SSL-VPN session.
addVpnSslProvisionUser()  : stdClass
Provision SSL-VPN users with target applications. The provisioning message (email or SMS) is sent with no confirmation of success.
addWanoptHistoryReset()  : stdClass
Reset WAN opt. statistics.
addWanoptPeer_statsReset()  : stdClass
Reset WAN opt peer statistics.
addWanoptWebcacheReset()  : stdClass
Reset webcache statistics.
addWebcacheStatsReset()  : stdClass
Reset all webcache statistics.
addWebfilterCategoryQuotaReset()  : stdClass
Reset webfilter quota for user or IP.
addWebfilterOverrideDelete()  : stdClass
Delete a configured webfilter override.
addWebproxyPacfileUpload()  : stdClass
Upload webproxy PAC file.
addWebUiCustomLanguageCreate()  : stdClass
Upload custom language file to this Fortigate.
addWebUiCustomLanguageUpdate()  : stdClass
Update custom language file to this Fortigate.
addWebUiLanguageImport()  : stdClass
Import localization language file to this FortiGate.
addWifiClientDisassociate()  : stdClass
Disassociate a WiFi client from the FortiAP it's currently connected to. The client will need to reassociate with the same FortiAP or another to resume connectivity.
addWifiEuclidReset()  : stdClass
Reset presence analytics statistics.
addWifiFirmwareDownload()  : stdClass
Download FortiAP firmware from FortiGuard to the FortiGate according to FortiAP image ID.
addWifiFirmwarePush()  : stdClass
Push FortiAP firmware to the given device.
addWifiFirmwareUpload()  : stdClass
Upload FortiAP firmware to the management FortiGate and then push to target FortiAPs.
addWifiManaged_apLedBlink()  : stdClass
Turn a managed FortiAP's LED blinking on or off.
addWifiManaged_apRestart()  : stdClass
Restart a given FortiAP.
addWifiManaged_apSet_status()  : stdClass
Update administrative state for a given FortiAP (enable or disable authorization).
addWifiNetworkConnect()  : stdClass
When FortiWiFi is in client mode, connect to the specified network, if configured in the 'wifi' interface.
addWifiNetworkScan()  : stdClass
When FortiWiFi is in client mode, start a scan for local WiFi networks.
addWifiRegionImageUpload()  : stdClass
Saves a floorplan/region image to an existing region.
addWifiRogue_apClear_all()  : stdClass
Clear all detected rogue APs.
addWifiRogue_apSet_status()  : stdClass
Mark detected APs as rogue APs.
addWifiSpectrumKeepAlive()  : stdClass
Extend duration of an existing spectrum analysis for a specific FortiAP.
addWifiSpectrumStart()  : stdClass
Start spectrum analysis for a specific FortiAP for a duration of time.
addWifiSpectrumStop()  : stdClass
Stop spectrum analysis for a specific FortiAP.
addWifiSsidGenerateKeys()  : stdClass
Generate pre-shared keys for specific multi pre-shared key profile.
addWifiVlanProbeStart()  : stdClass
Start a VLAN probe.
addWifiVlanProbeStop()  : stdClass
Stop a VLAN probe.
commitTransaction()  : bool
Commit a transaction (apply operations).
getAllAzureApplicationList()  : stdClass
Retrieve a list of Azure applications that can be used for configuring an Azure SDN connector.
getAllEndpointControlAvatarDownload()  : stdClass
Download an endpoint avatar image.
getAllEndpointControlEmsCertStatus()  : stdClass
Retrieve authentication status of the EMS server certificate for a specific EMS.
getAllEndpointControlEmsStatus()  : stdClass
Retrieve EMS connection status for a specific EMS.
getAllEndpointControlEmsStatusSummary()  : stdClass
Retrieve status summary for all configured EMS.
getAllEndpointControlInstaller()  : stdClass
List available FortiClient installers.
getAllEndpointControlInstallerDownload()  : stdClass
Download a FortiClient installer via FortiGuard.
getAllEndpointControlRecordList()  : stdClass
List endpoint records.
getAllEndpointControlSummary()  : stdClass
Summary of FortiClient endpoint records.
getAllExtenderControllerExtender()  : stdClass
Retrieve statistics for specific configured FortiExtender units.
getAllFirewallAcl()  : stdClass
List counters for all IPv4 ACL.
getAllFirewallAcl6()  : stdClass
List counters for all IPv6 ACL.
getAllFirewallAddress6Dynamic()  : stdClass
List of IPv6 Fabric Connector address objects and the IPs they resolve to.
getAllFirewallAddressDynamic()  : stdClass
List of Fabric Connector address objects and the IPs they resolve to.
getAllFirewallAddressFqdns()  : stdClass
List of FQDN address objects and the IPs they resolved to.
getAllFirewallAddressFqdns6()  : stdClass
List of IPv6 FQDN address objects and the IPs they resolved to.
getAllFirewallHealth()  : stdClass
List configured load balance server health monitors.
getAllFirewallInternetServiceDetails()  : stdClass
List all details for a given Internet Service ID.
getAllFirewallInternetServiceMatch()  : stdClass
List internet services that exist at a given IP or Subnet.
getAllFirewallIppool()  : stdClass
List IPv4 pool statistics.
getAllFirewallIppoolMapping()  : stdClass
Get the list of IPv4 mappings for the specified IP pool.
getAllFirewallLoadBalance()  : stdClass
List all firewall load balance servers.
getAllFirewallLocalIn()  : stdClass
List implicit and explicit local-in firewall policies.
getAllFirewallPerIpShaper()  : stdClass
List of statistics for configured firewall per-IP traffic shapers.
getAllFirewallPolicy()  : stdClass
List traffic statistics for firewall policies.
getAllFirewallPolicyLookup()  : stdClass
Performs a policy lookup by creating a dummy packet and asking the kernel which policy would be hit.
getAllFirewallProxyPolicy()  : stdClass
List traffic statistics for all explicit proxy policies.
getAllFirewallSdnConnectorFilters()  : stdClass
List all available filters for a specified SDN Fabric Connector. Used for Fabric Connector address objects.
getAllFirewallSecurityPolicy()  : stdClass
List IPS engine statistics for security policies.
getAllFirewallSession()  : stdClass
List all active firewall sessions (optionally filtered).
getAllFirewallShaper()  : stdClass
List of statistics for configured firewall shared traffic shapers.
getAllFirewallUuidList()  : stdClass
Retrieve a list of all UUIDs with their object type and VDOM.
getAllFirewallUuidTypeLookup()  : stdClass
Retrieve a mapping of UUIDs to their firewall object type for given UUIDs.
getAllFortiguardRedirectPortal()  : stdClass
Retrieve the FortiGuard redirect portal IP.
getAllFortiguardServiceCommunicationStats()  : stdClass
Retrieve historical statistics for communication with FortiGuard services.
getAllFortiviewSandboxFileDetails()  : stdClass
Retrieve FortiSandbox analysis details for a specific file checksum.
getAllFortiviewSandboxFileList()  : stdClass
Retrieve list of available FortiSandbox analysis files.
getAllFortiviewStatistics()  : stdClass
Retrieve drill-down and summary data for FortiView (both realtime and historical).
getAllIpsAnomaly()  : stdClass
Returns IPS anomaly list.
getAllIpsExceedScanRange()  : stdClass
Returns a list of applications that exceed the scan range from a list of application IDs.
getAllIpsMetadata()  : stdClass
Returns IPS meta data.
getAllIpsRateBased()  : stdClass
Returns a list of rate-based signatures in IPS package.
getAllLicenseFortianalyzerStatus()  : stdClass
Get current license & registration status for the connected FortiAnalyzer.
getAllLicenseForticareOrgList()  : stdClass
Get FortiCare organization size and industry lists.
getAllLicenseForticareResellers()  : stdClass
Get current FortiCare resellers for the requested country.
getAllLicenseStatus()  : stdClass
Get current license & registration status.
getAllLogAvArchiveDownload()  : stdClass
Download file quarantined by AntiVirus.
getAllLogCurrentDiskUsage()  : stdClass
Return current used, free and total disk bytes.
getAllLogDeviceState()  : stdClass
Retrieve information on state of log devices.
getAllLogEvent()  : stdClass
List all event log descriptions. Deprecated in 6.2.3 replaced by /api/v2/static/logid_metadata.json.
getAllLogFortianalyzer()  : stdClass
Return FortiAnalyzer/FortiManager log status.
getAllLogFortianalyzerQueue()  : stdClass
Retrieve information on FortiAnalyzer's queue state. Note:- FortiAnalyzer logs are queued only if upload-option is realtime.
getAllLogForticloud()  : stdClass
Return FortiCloud log status.
getAllLogForticloudReportDownload()  : stdClass
Download PDF report from FortiCloud.
getAllLogForticloudReportList()  : stdClass
Get FortiCloud report list.
getAllLogHistoricDailyRemoteLogs()  : stdClass
Returns the amount of logs in bytes sent daily to a remote logging service (FortiCloud or FortiAnalyzer).
getAllLogHourlyDiskUsage()  : stdClass
Return historic hourly disk usage in bytes.
getAllLogIpsArchiveDownload()  : stdClass
Download IPS/application control packet capture files. Uses configured log display device.
getAllLogLocalReportDownload()  : stdClass
Download local report Access Group: loggrp.data-access
getAllLogLocalReportList()  : stdClass
Get local reports list.
getAllLogPolicyArchiveDownload()  : stdClass
Download policy-based packet capture archive.
getAllLogStats()  : stdClass
Return number of logs sent by category per day for a specific log device.
getAllNetworkArp()  : stdClass
Get IPv4 ARP table.
getAllNetworkDdnsLookup()  : stdClass
Check DDNS FQDN availability.
getAllNetworkDdnsServers()  : stdClass
Get DDNS servers.
getAllNetworkDnsLatency()  : stdClass
Get DNS latency.
getAllNetworkFortiguardLiveServicesLatency()  : stdClass
Get latency information for live FortiGuard services.
getAllNetworkLldpNeighbors()  : stdClass
List all active LLDP neighbors.
getAllNetworkLldpPorts()  : stdClass
List all active LLDP ports.
getAllNetworkReverseIpLookup()  : stdClass
Retrieve the resolved DNS domain name for a given IP address.
getAllNsxInstance()  : stdClass
List NSX instances and their resource statistics.
getAllNsxServiceStatus()  : stdClass
Retrieve NSX service status.
getAllRegistrationForticloudDeviceStatus()  : stdClass
Fetch device registration status from FortiCloud. Currently FortiSwitch and FortiAP are supported.
getAllRegistrationForticloudDisclaimer()  : stdClass
Retrieve the FortiCloud disclaimer.
getAllRegistrationForticloudDomains()  : stdClass
Retrieve a list of FortiCloud login domains.
getAllRouterIpv4()  : stdClass
List all active IPv4 routing table entries.
getAllRouterIpv6()  : stdClass
List all active IPv6 routing table entries.
getAllRouterLookup()  : stdClass
Performs a route lookup by querying the routing table.
getAllRouterLookupPolicy()  : stdClass
Performs a route lookup by querying the policy routing table.
getAllRouterPolicy()  : stdClass
Retrieve a list of active IPv4 policy routes.
getAllRouterPolicy6()  : stdClass
Retrieve a list of active IPv6 policy routes.
getAllRouterStatistics()  : stdClass
Retrieve routing table statistics, including number of matched routes.
getAllSwitchControllerDetectedDevice()  : stdClass
Retrieve a list of devices detected on all switches.
getAllSwitchControllerFswFirmware()  : stdClass
Retrieve a list of recommended firmware for managed FortiSwitches.
getAllSwitchControllerManagedSwitch()  : stdClass
Retrieve statistics for configured FortiSwitches Access Group: wifi
getAllSwitchControllerManagedSwitchCableStatus()  : stdClass
Diagnose cable information for a port. Virtual FortiSwitches and FortiLink ports are not supported.
getAllSwitchControllerManagedSwitchDhcpSnooping()  : stdClass
Retrieve DHCP servers monitored by FortiSwitches.
getAllSwitchControllerManagedSwitchFaceplateXml()  : stdClass
Retrieve XML for rendering FortiSwitch faceplate widget.
getAllSwitchControllerManagedSwitchHealth()  : stdClass
Retrieve health-check statistics for managed FortiSwitches.
getAllSwitchControllerManagedSwitchTransceivers()  : stdClass
Get a list of transceivers being used by managed FortiSwitches.
getAllSwitchControllerMclagIclEligiblePeer()  : stdClass
Find a pair of FortiSwitches that are eligible to form a tier-1 MCLAG.
getAllSwitchControllerValidateSwitchPrefix()  : stdClass
Validate a FortiSwitch serial number prefix.
getAllSystem3gModem()  : stdClass
List all 3G modems available via FortiGuard.
getAllSystemAcquiredDns()  : stdClass
Retrieve a list of interfaces and their acquired DNS servers.
getAllSystemAutomationStitchStats()  : stdClass
Stats for automation stitches.
getAllSystemAvailableCertificates()  : stdClass
Get available certificates.
getAllSystemAvailableInterfaces()  : stdClass
Retrieve a list of all interfaces along with some meta information regarding their availability.
getAllSystemBotnet()  : stdClass
List all known IP-based botnet entries in FortiGuard botnet database.
getAllSystemBotnetDomains()  : stdClass
List all known domain-based botnet entries in FortiGuard botnet database.
getAllSystemBotnetDomainsHits()  : stdClass
List hit botnet domains with hit count > 0.
getAllSystemBotnetDomainsStat()  : stdClass
List statistics on domain-based botnet entries in FortiGuard botnet database.
getAllSystemBotnetStat()  : stdClass
Retrieve statistics for FortiGuard botnet database.
getAllSystemCertificateDownload()  : stdClass
Download certificate.
getAllSystemCheckPortAvailability()  : stdClass
Check whether a list of TCP port ranges is available for a certain service.
getAllSystemComLogDownload()  : stdClass
Download com-log file (after file dump is complete).
getAllSystemComLogUpdate()  : stdClass
Fetch system com-log file dump progress.
getAllSystemConfigBackup()  : stdClass
Backup system config Access Group: sysgrp.mnt
getAllSystemConfigErrorLogDownload()  : stdClass
Download the error log of the configuration management database.
getAllSystemConfigRevision()  : stdClass
Returns a list of system configuration revisions.
getAllSystemConfigRevisionFile()  : stdClass
Download a specific configuration revision.
getAllSystemConfigRevisionInfo()  : stdClass
Retrieve meta information for a specific configuration revision.
getAllSystemConfigScript()  : stdClass
Retrieve the information about config scripts.
getAllSystemConfigSyncStatus()  : stdClass
Get configuration sync status of SLBC cluster master and slave.
getAllSystemConfigUsbFilelist()  : stdClass
List configuration files available on connected USB drive.
getAllSystemCsf()  : stdClass
Retrieve a full tree of downstream FortiGates registered to the Security Fabric.
getAllSystemCsfPendingAuthorizations()  : stdClass
Retrieve fabric devices with pending authorizations for joining the Security Fabric. Note:- This list is currently available on Security Fabric root only.
getAllSystemCurrentAdmins()  : stdClass
Return a list of currently logged in administrators.
getAllSystemDebugDownload()  : stdClass
Download debug report for technical support.
getAllSystemDhcp()  : stdClass
List all DHCP and DHCPv6 leases.
getAllSystemFirmware()  : stdClass
Retrieve a list of firmware images available to use for upgrade on this device.
getAllSystemFirmwareUpgradePaths()  : stdClass
Retrieve a list of supported firmware upgrade paths.
getAllSystemFortiguardServerInfo()  : stdClass
Get FortiGuard server list and information.
getAllSystemFortimanagerBackupDetails()  : stdClass
Get the properties of a FortiManager object.
getAllSystemFortimanagerBackupSummary()  : stdClass
Get FortiManager backup summary.
getAllSystemFortimanagerStatus()  : stdClass
Get FortiManager status.
getAllSystemGlobalResources()  : stdClass
Retrieve current usage of global resources as well as both the default and user configured maximum values.
getAllSystemHaChecksums()  : stdClass
List of checksums for members of HA cluster.
getAllSystemHaHistory()  : stdClass
Get HA cluster historical logs.
getAllSystemHaPeer()  : stdClass
Get configuration of peer(s) in HA cluster. Uptime is expressed in seconds.
getAllSystemHaStatistics()  : stdClass
List of statistics for members of HA cluster.
getAllSystemInterface()  : stdClass
Retrieve statistics for all system interfaces.
getAllSystemInterfaceConnectedAdminsInfo()  : stdClass
Return admins info that are connected to current interface.
getAllSystemInterfaceDhcpStatus()  : stdClass
Retrieve the DHCP client status of an interface.
getAllSystemInterfacePoe()  : stdClass
Retrieve PoE statistics for system interfaces.
getAllSystemInterfaceSpeedTestStatus()  : stdClass
Retrieve the current status of a speed-test with the results if finished.
getAllSystemInterfaceTransceivers()  : stdClass
Get a list of transceivers being used by the FortiGate.
getAllSystemIpconf()  : stdClass
Determine if there is an IP conflict for a specific IP using ARP.
getAllSystemLinkMonitor()  : stdClass
Retrieve per-interface statistics for active link monitors.
getAllSystemModem()  : stdClass
Retrieve statistics for internal/external configured modem.
getAllSystemNat46Ippools()  : stdClass
Retrieve a list of all IPv6 IP pools that are valid for NAT 46 policies.
getAllSystemNtpStatus()  : stdClass
List NTP servers status.
getAllSystemObjectUsage()  : stdClass
Retrieve all objects that are currently using as well as objects that can use the given object.
getAllSystemResolveFqdn()  : stdClass
Resolves the provided FQDNs to FQDN -> IP mappings.
getAllSystemResourceUsage()  : stdClass
Retreive current and historical usage data for a provided resource.
getAllSystemRunningProcesses()  : stdClass
List of running processes and their resource usage.
getAllSystemSandboxCloudRegions()  : stdClass
Retrieve a list of FortiSandbox cloud regions.
getAllSystemSandboxStats()  : stdClass
Retrieve sandbox statistics.
getAllSystemSandboxStatus()  : stdClass
Retrieve sandbox status.
getAllSystemSandboxTestConnect()  : stdClass
Test the connectivity of a given FortiSandbox IP.
getAllSystemSdnConnectorNsxSecurityTags()  : stdClass
Retrieve a list of NSX security tags for connected NSX servers.
getAllSystemSdnConnectorStatus()  : stdClass
Retrieve connection status for SDN connectors.
getAllSystemSecurityRating()  : stdClass
Retrieve a Security Rating report result. Without ID specified, returns the most recent result.
getAllSystemSecurityRatingHistory()  : stdClass
Retrieve Security Rating history.
getAllSystemSecurityRatingLang()  : stdClass
Returns the requested Security Rating language mapping.
getAllSystemSecurityRatingStatus()  : stdClass
Check if a Security Rating report is currently running.
getAllSystemSecurityRatingSupportedReports()  : stdClass
Retrieve list of report types the Security Rating package supports.
getAllSystemSensorInfo()  : stdClass
Retrieve system sensor status.
getAllSystemSniffer()  : stdClass
Return a list of all configured packet captures.
getAllSystemSnifferDownload()  : stdClass
Download a stored packet capture.
getAllSystemStatus()  : stdClass
Retrieve basic system status.
getAllSystemStorage()  : stdClass
Retrieve information for the non-boot disk.
getAllSystemTime()  : stdClass
Gets current system time stamp.
getAllSystemTimezone()  : stdClass
Get world timezone and daylight saving time.
getAllSystemTrustedCertAuthorities()  : stdClass
Get trusted certifiate authorities.
getAllSystemUsbLog()  : stdClass
Retrieve information about connected USB drives, including estimated log sizes.
getAllSystemVdomLink()  : stdClass
Gets a list of all NPU VDOM Links and VDOM Links.
getAllSystemVdomResource()  : stdClass
Retrieve VDOM resource information, including CPU and memory usage.
getAllSystemVmInformation()  : stdClass
Get VM information.
getAllUserBanned()  : stdClass
Return a list of all banned users by IP.
getAllUserCollectedEmail()  : stdClass
List email addresses collected from captive portal.
getAllUserDetectedDevice()  : stdClass
Retrieve a list of detected devices.
getAllUserDevice()  : stdClass
Retrieve a list of detected devices.
getAllUserDeviceQuery()  : stdClass
Retrieve user devices from user device store. List all the user devices if there is no filter set.
getAllUserFirewall()  : stdClass
List authenticated firewall users.
getAllUserFortitoken()  : stdClass
Retrieve a map of FortiTokens and their status.
getAllUserFortitokenCloudStatus()  : stdClass
Retrieve FortiToken Cloud service status.
getAllUserFsso()  : stdClass
Get a list of fsso and fsso polling status.
getAllUserInfoQuery()  : stdClass
Query user info.
getAllUserInfoThumbnail()  : stdClass
Get user info thumbnail. Returns the first match to the filter.
getAllUtmAntivirusStats()  : stdClass
Retrieve antivirus scanning statistics.
getAllUtmApplicationCategories()  : stdClass
Retrieve a list of application control categories.
getAllUtmAppLookup()  : stdClass
Query remote FortiFlow database to resolve hosts to application control entries.
getAllUtmBlacklistedCertificates()  : stdClass
Retrieve a list of blacklisted SSL certificates.
getAllUtmBlacklistedCertificatesStatistics()  : stdClass
Retrieve blacklisted SSL certificates statistics.
getAllVirtualWanHealthCheck()  : stdClass
Retrieve health-check statistics for each SD-WAN link.
getAllVirtualWanInterfaceLog()  : stdClass
Retrieve log of SD-WAN interface quality information.
getAllVirtualWanMembers()  : stdClass
Retrieve interface statistics for each SD-WAN link.
getAllVirtualWanSlaLog()  : stdClass
Retrieve log of SLA probe results for for each SD-WAN SLA rule.
getAllVpnIpsec()  : stdClass
Return an array of active IPsec VPNs.
getAllVpnOcvpnMembers()  : stdClass
Get information on devices registered in the Overlay Controller VPN cloud assisted group.
getAllVpnOcvpnMeta()  : stdClass
Get meta information (e.g. licenses and registered members) from Overlay Controller VPN cloud service.
getAllVpnOcvpnStatus()  : stdClass
Get the last status message from FortiCloud Overlay Controller VPN cloud service.
getAllVpnSsl()  : stdClass
Retrieve a list of all SSL-VPN sessions and sub-sessions.
getAllVpnSslStats()  : stdClass
Return statistics about the SSL-VPN.
getAllWanoptHistory()  : stdClass
Retrieve WAN opt. statistics history.
getAllWanoptPeer_stats()  : stdClass
Retrieve a list of WAN opt peer statistics.
getAllWanoptWebcache()  : stdClass
Retrieve webcache statistics history.
getAllWebcacheStats()  : stdClass
Retrieve webcache statistics.
getAllWebfilterCategoryQuota()  : stdClass
Retrieve quota usage statistics for webfilter categories.
getAllWebfilterFortiguardCategories()  : stdClass
Return FortiGuard web filter categories.
getAllWebfilterMaliciousUrls()  : stdClass
List all URLs in FortiSandbox malicious URL database.
getAllWebfilterMaliciousUrlsStat()  : stdClass
Retrieve statistics for the FortiSandbox malicious URL database.
getAllWebfilterOverride()  : stdClass
List all administrative and user initiated webfilter overrides.
getAllWebfilterTrustedUrls()  : stdClass
List all URLs in FortiGuard trusted URL database.
getAllWebproxyPacfileDownload()  : stdClass
Download webproxy PAC file.
getAllWebUiCustomLanguageDownload()  : stdClass
Download a custom language file.
getAllWifiAp_status()  : stdClass
Retrieve statistics for all managed FortiAPs.
getAllWifiClient()  : stdClass
Retrieve a list of connected WiFi clients.
getAllWifiEuclid()  : stdClass
Retrieve presence analytics statistics.
getAllWifiFirmware()  : stdClass
Retrieve a list of current and recommended firmware for FortiAPs in use.
getAllWifiInterfering_ap()  : stdClass
Retrieve a list of interfering APs for one FortiAP radio.
getAllWifiManaged_ap()  : stdClass
Retrieve a list of managed FortiAPs.
getAllWifiNetworkList()  : stdClass
When FortiWiFi is in client mode, retrieve list of local WiFi networks.
getAllWifiNetworkStatus()  : stdClass
When FortiWiFi is in client mode, retrieve status of currently connected WiFi network, if any.
getAllWifiRegionImage()  : stdClass
Retrieves a floorplan/region image from a configured FortiAP region.
getAllWifiRogue_ap()  : stdClass
Retrieve a list of detected rogue APs.
getAllWifiSpectrum()  : stdClass
Retrieve spectrum analysis information for a specific FortiAP.
getAllWifiVlanProbe()  : stdClass
Retrieve the VLAN probe results.
listTransactions()  : bool
List all transactions.
startTransaction()  : bool
Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).
curlRequest()  : stdClass
Method to request the firewall's API.
httpBuildCustomQuery()  : string
Function used to build a query with params but following fortigate satndards.
login()  : bool
Login in the firewall.
logout()  : Return
Logout from the firewall.

Properties

$session_key

public string $session_key

Authentication token kept in cache.

$transaction

public int|null $transaction

Ongoning transaction ID. WARNING : When going through the method prepareRequestData(), all upper case letter in function parameter name will be replaced by '-' and ;brought down to lower case. If you modify or add new endpoints replace all '-' in parameter name by the next letter in uppercase.

Methods

__construct()

Constructor takes care of checking and registering firewall's data and login to the API

public __construct(Config $config) : mixed
Parameters
$config : Config

Object containing all necessary configuration.

Return values
mixed —

__destruct()

Destructor takes care of logout.

public __destruct() : mixed
Return values
mixed —

abortTransaction()

Abort a transaction (rollback operations).

public abortTransaction([string|null $vdom = null ]) : bool
Parameters
$vdom : string|null = null

Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

Return values
bool —

Return TRUE on success and FALSE on failure.

addAzureApplicationListRefresh()

Update the Azure application list data or get the status of an update.

public addAzureApplicationListRefresh( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /azure/application-list/refresh

Return values
stdClass —

Return the firewall's response as an object.

addEndpointControlEmsVerifyCert()

Verify EMS server certificate for a specific EMS.

public addEndpointControlEmsVerifyCert( $body) : stdClass

Access Group: utmgrp.endpoint-control

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /endpoint-control/ems/verify-cert

Return values
stdClass —

Return the firewall's response as an object.

addExtenderControllerExtenderDiagnose()

Execute diagnotic commands.

public addExtenderControllerExtenderDiagnose( $body) : stdClass

Access Group: netgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /extender-controller/extender/diagnose

Return values
stdClass —

Return the firewall's response as an object.

addExtenderControllerExtenderReset()

Reset a specific FortiExtender unit.

public addExtenderControllerExtenderReset( $body) : stdClass

Access Group: netgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /extender-controller/extender/reset

Return values
stdClass —

Return the firewall's response as an object.

addExtenderControllerExtenderUpgrade()

Upgrade FortiExtender.

public addExtenderControllerExtenderUpgrade( $body) : stdClass

Access Group: sysgrp.mnt

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /extender-controller/extender/upgrade

Return values
stdClass —

Return the firewall's response as an object.

addFirewallAcl6Clear_counters()

Reset counters for one or more IPv6 ACLs by policy ID.

public addFirewallAcl6Clear_counters( $body) : stdClass

Access Group: fwgrp.policy

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /firewall/acl6/clear_counters

Return values
stdClass —

Return the firewall's response as an object.

addFirewallAclClear_counters()

Reset counters for one or more IPv4 ACLs by policy ID.

public addFirewallAclClear_counters( $body) : stdClass

Access Group: fwgrp.policy

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /firewall/acl/clear_counters

Return values
stdClass —

Return the firewall's response as an object.

addFirewallClearpassAddressAdd()

Add ClearPass address with SPT (System Posture Token) value.

public addFirewallClearpassAddressAdd( $body) : stdClass

Access Group: fwgrp.address

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /firewall/clearpass-address/add

Return values
stdClass —

Return the firewall's response as an object.

addFirewallClearpassAddressDelete()

Delete ClearPass address with SPT (System Posture Token) value.

public addFirewallClearpassAddressDelete( $body) : stdClass

Access Group: fwgrp.address

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /firewall/clearpass-address/delete

Return values
stdClass —

Return the firewall's response as an object.

addFirewallPerIpShaperReset()

Reset statistics for all configured firewall per-IP traffic shapers.

public addFirewallPerIpShaperReset() : stdClass

Access Group: fwgrp.others

Tags
route

POST /firewall/per-ip-shaper/reset

Return values
stdClass —

Return the firewall's response as an object.

addFirewallPolicyClear_counters()

Reset traffic statistics for one or more firewall policies by policy ID.

public addFirewallPolicyClear_counters( $body) : stdClass

Access Group: fwgrp.policy

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /firewall/policy/clear_counters

Return values
stdClass —

Return the firewall's response as an object.

addFirewallPolicyReset()

Reset traffic statistics for all firewall policies.

public addFirewallPolicyReset() : stdClass

Access Group: fwgrp.policy

Tags
route

POST /firewall/policy/reset

Return values
stdClass —

Return the firewall's response as an object.

addFirewallProxyPolicyClear_counters()

Reset traffic statistics for one or more explicit proxy policies by policy ID.

public addFirewallProxyPolicyClear_counters( $body) : stdClass

Access Group: fwgrp.policy

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /firewall/proxy-policy/clear_counters

Return values
stdClass —

Return the firewall's response as an object.

addFirewallSecurityPolicyClear_counters()

Reset traffic statistics for one or more security policies by policy ID.

public addFirewallSecurityPolicyClear_counters( $body) : stdClass

Access Group: fwgrp.policy

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /firewall/security-policy/clear_counters

Return values
stdClass —

Return the firewall's response as an object.

addFirewallSessionClear_all()

Immediately clear all active IPv4 and IPv6 sessions and IPS sessions of current VDOM.

public addFirewallSessionClear_all() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /firewall/session/clear_all

Return values
stdClass —

Return the firewall's response as an object.

addFirewallSessionClose()

Close a specific firewall session that matches all provided criteria.

public addFirewallSessionClose( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /firewall/session/close

Return values
stdClass —

Return the firewall's response as an object.

addFirewallShaperReset()

Reset statistics for all configured traffic shapers.

public addFirewallShaperReset() : stdClass

Access Group: fwgrp.others

Tags
route

POST /firewall/shaper/reset

Return values
stdClass —

Return the firewall's response as an object.

addFortiviewSessionCancel()

Cancel a FortiView request session.

public addFortiviewSessionCancel( $body) : stdClass

Access Group: ftviewgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /fortiview/session/cancel

Return values
stdClass —

Return the firewall's response as an object.

addGeoipGeoipQuerySelect()

Retrieve location details for IPs queried against FortiGuard's geoip service.

public addGeoipGeoipQuerySelect( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /geoip/geoip-query/select

Return values
stdClass —

Return the firewall's response as an object.

addLicenseDatabaseUpgrade()

Upgrade or downgrade UTM engine or signature package (IPS/AntiVirus/Application Control/Industrial database/Security Rating) using uploaded file.

public addLicenseDatabaseUpgrade( $body) : stdClass

Access Group: sysgrp.upd

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /license/database/upgrade

Return values
stdClass —

Return the firewall's response as an object.

addLogLocalReportDelete()

Delete a local report.

public addLogLocalReportDelete( $body) : stdClass

Access Group: loggrp.data-access

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /log/local-report/delete

Return values
stdClass —

Return the firewall's response as an object.

addLogStatsReset()

Reset logging statistics for all log devices.

public addLogStatsReset() : stdClass

Access Group: loggrp.data-access

Tags
route

POST /log/stats/reset

Return values
stdClass —

Return the firewall's response as an object.

addNsxServiceAdd()

Add NSX service to connector.

public addNsxServiceAdd( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /nsx/service/add

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticareAddLicense()

Add a FortiCare license.

public addRegistrationForticareAddLicense( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/forticare/add-license

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticareCreate()

Create a new FortiCare account.

public addRegistrationForticareCreate( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/forticare/create

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticareLogin()

Login to FortiCare.

public addRegistrationForticareLogin( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/forticare/login

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticareTransfer()

Transfer to a new FortiCare account.

public addRegistrationForticareTransfer( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/forticare/transfer

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticloudCreate()

Create a FortiCloud account.

public addRegistrationForticloudCreate( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/forticloud/create

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticloudLogin()

Login to FortiCloud.

public addRegistrationForticloudLogin( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/forticloud/login

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticloudLogout()

Logout from FortiCloud.

public addRegistrationForticloudLogout() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /registration/forticloud/logout

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticloudMigrate()

Migrate standalone FortiGate Cloud account to FortiCloud.

public addRegistrationForticloudMigrate( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/forticloud/migrate

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationForticloudRegisterDevice()

Register a device to FortiCloud through FortiGate. Currently FortiSwitch and FortiAP are supported.

public addRegistrationForticloudRegisterDevice( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/forticloud/register-device

Return values
stdClass —

Return the firewall's response as an object.

addRegistrationVdomAddLicense()

Add a VDOM license.

public addRegistrationVdomAddLicense( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /registration/vdom/add-license

Return values
stdClass —

Return the firewall's response as an object.

addSwitchControllerFswFirmwareDownload()

Download FortiSwitch firmware from FortiGuard to the FortiGate according to FortiSwitch image ID.

public addSwitchControllerFswFirmwareDownload( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /switch-controller/fsw-firmware/download

Return values
stdClass —

Return the firewall's response as an object.

addSwitchControllerFswFirmwarePush()

Push FortiSwitch firmware to the given device.

public addSwitchControllerFswFirmwarePush( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /switch-controller/fsw-firmware/push

Return values
stdClass —

Return the firewall's response as an object.

addSwitchControllerFswFirmwareUpload()

Upload FortiSwitch firmware to the management FortiGate and then push to target FortiSwitches.

public addSwitchControllerFswFirmwareUpload( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /switch-controller/fsw-firmware/upload

Return values
stdClass —

Return the firewall's response as an object.

addSwitchControllerManagedSwitchFactoryReset()

Send 'Factory Reset' command to a given FortiSwitch.

public addSwitchControllerManagedSwitchFactoryReset( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /switch-controller/managed-switch/factory-reset

Return values
stdClass —

Return the firewall's response as an object.

addSwitchControllerManagedSwitchPoeReset()

Reset PoE on a given FortiSwitch's port.

public addSwitchControllerManagedSwitchPoeReset( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /switch-controller/managed-switch/poe-reset

Return values
stdClass —

Return the firewall's response as an object.

addSwitchControllerManagedSwitchRestart()

Restart a given FortiSwitch.

public addSwitchControllerManagedSwitchRestart( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /switch-controller/managed-switch/restart

Return values
stdClass —

Return the firewall's response as an object.

addSwitchControllerManagedSwitchUpdate()

Update administrative state for a given FortiSwitch (enable or disable authorization).

public addSwitchControllerManagedSwitchUpdate( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /switch-controller/managed-switch/update

Return values
stdClass —

Return the firewall's response as an object.

addSystemAdminChangeVdomMode()

Switch between VDOM modes.

public addSystemAdminChangeVdomMode( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/admin/change-vdom-mode

Return values
stdClass —

Return the firewall's response as an object.

addSystemApiUserGenerateKey()

Generate a new api-key for the specified api-key-auth admin. The old api-key will be replaced. The response contains the only chance to read the new api-key plaintext in the api_key field.

public addSystemApiUserGenerateKey( $body) : stdClass

Access Group: sysgrp.admin

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/api-user/generate-key

Return values
stdClass —

Return the firewall's response as an object.

addSystemAutomationStitchTest()

Triggers an automation stitch for testing purposes.

public addSystemAutomationStitchTest( $body) : stdClass

Access Group: sysgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/automation-stitch/test

Return values
stdClass —

Return the firewall's response as an object.

addSystemAutomationStitchWebhook()

Triggers an incoming webhook for an automation stitch.

public addSystemAutomationStitchWebhook( $body) : stdClass

Access Group: secfabgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/automation-stitch/webhook

Return values
stdClass —

Return the firewall's response as an object.

addSystemCertificateReadInfo()

Get certificate information from a certificate string.

public addSystemCertificateReadInfo( $body) : stdClass

Access Group: any

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/certificate/read-info

Return values
stdClass —

Return the firewall's response as an object.

addSystemChangePasswordSelect()

Save admin and guest-admin passwords.

public addSystemChangePasswordSelect( $body) : stdClass

Access Group: any

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/change-password/select

Return values
stdClass —

Return the firewall's response as an object.

addSystemComLogDump()

Dump system com-log to file.

public addSystemComLogDump() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/com-log/dump

Return values
stdClass —

Return the firewall's response as an object.

addSystemConfigRestore()

Restore system configuration from uploaded file or from USB.

public addSystemConfigRestore( $body) : stdClass

Access Group: sysgrp.mnt

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/config/restore

Return values
stdClass —

Return the firewall's response as an object.

addSystemConfigRevisionDelete()

Deletes one or more system configuration revisions.

public addSystemConfigRevisionDelete( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/config-revision/delete

Return values
stdClass —

Return the firewall's response as an object.

addSystemConfigRevisionSave()

Create a new config revision checkpoint.

public addSystemConfigRevisionSave( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/config-revision/save

Return values
stdClass —

Return the firewall's response as an object.

addSystemConfigRevisionUpdateComments()

Updates comments for a system configuration file.

public addSystemConfigRevisionUpdateComments( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/config-revision/update-comments

Return values
stdClass —

Return the firewall's response as an object.

addSystemConfigSave()

Explicitly save all configuration.

public addSystemConfigSave() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/config/save

Return values
stdClass —

Return the firewall's response as an object.

addSystemConfigScriptDelete()

Delete the history of config scripts.

public addSystemConfigScriptDelete( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/config-script/delete

Return values
stdClass —

Return the firewall's response as an object.

addSystemConfigScriptRun()

Run remote config scripts.

public addSystemConfigScriptRun( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/config-script/run

Return values
stdClass —

Return the firewall's response as an object.

addSystemConfigScriptUpload()

Upload and run a new configuration script file.

public addSystemConfigScriptUpload( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/config-script/upload

Return values
stdClass —

Return the firewall's response as an object.

addSystemCsfRegisterAppliance()

Register appliance to Security Fabric.

public addSystemCsfRegisterAppliance( $body) : stdClass

Access Group: secfabgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/csf/register-appliance

Return values
stdClass —

Return the firewall's response as an object.

addSystemDhcp6Revoke()

Revoke IPv6 DHCP leases.

public addSystemDhcp6Revoke( $body) : stdClass

Access Group: netgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/dhcp6/revoke

Return values
stdClass —

Return the firewall's response as an object.

addSystemDhcpRevoke()

Revoke IPv4 DHCP leases.

public addSystemDhcpRevoke( $body) : stdClass

Access Group: netgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/dhcp/revoke

Return values
stdClass —

Return the firewall's response as an object.

addSystemDisconnectAdminsSelect()

Disconnects logged in administrators.

public addSystemDisconnectAdminsSelect( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/disconnect-admins/select

Return values
stdClass —

Return the firewall's response as an object.

addSystemFirmwareUpgrade()

Upgrade firmware image on this device using uploaded file.

public addSystemFirmwareUpgrade( $body) : stdClass

Access Group: sysgrp.mnt

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/firmware/upgrade

Return values
stdClass —

Return the firewall's response as an object.

addSystemFortiguardClearStatistics()

Immediately clear all FortiGuard statistics.

public addSystemFortiguardClearStatistics() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/fortiguard/clear-statistics

Return values
stdClass —

Return the firewall's response as an object.

addSystemFortiguardTestAvailability()

Test availability of FortiGuard services.

public addSystemFortiguardTestAvailability( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/fortiguard/test-availability

Return values
stdClass —

Return the firewall's response as an object.

addSystemFortiguardUpdate()

Immediately update status for FortiGuard services.

public addSystemFortiguardUpdate() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/fortiguard/update

Return values
stdClass —

Return the firewall's response as an object.

addSystemFortimanagerBackupAction()

Import or update from FortiManager objects.

public addSystemFortimanagerBackupAction( $body) : stdClass

Access Group: fwgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/fortimanager/backup-action

Return values
stdClass —

Return the firewall's response as an object.

addSystemFortimanagerConfig()

Configure FortiManager IP. Register FortiManager if 'fortimanager_ip' is provided. Unregister FortiManager if only 'unregister' parameter is specified and set to true.

public addSystemFortimanagerConfig( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/fortimanager/config

Return values
stdClass —

Return the firewall's response as an object.

addSystemFsckStart()

Set file system check flag so that it will be executed on next device reboot.

public addSystemFsckStart() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/fsck/start

Return values
stdClass —

Return the firewall's response as an object.

addSystemHaPeerDisconnect()

Update configuration of peer in HA cluster.

public addSystemHaPeerDisconnect( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/ha-peer/disconnect

Return values
stdClass —

Return the firewall's response as an object.

addSystemHaPeerUpdate()

Update configuration of peer in HA cluster.

public addSystemHaPeerUpdate( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/ha-peer/update

Return values
stdClass —

Return the firewall's response as an object.

addSystemInterfaceDhcpRenew()

Renew DHCP lease of an interface.

public addSystemInterfaceDhcpRenew( $body) : stdClass

Access Group: netgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/interface/dhcp-renew

Return values
stdClass —

Return the firewall's response as an object.

addSystemInterfaceSpeedTestTrigger()

Run a speed-test on the given interface.

public addSystemInterfaceSpeedTestTrigger( $body) : stdClass

Access Group: netgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/interface/speed-test-trigger

Return values
stdClass —

Return the firewall's response as an object.

addSystemLogdiskFormat()

Format log disk.

public addSystemLogdiskFormat() : stdClass

Access Group: loggrp.data-access

Tags
route

POST /system/logdisk/format

Return values
stdClass —

Return the firewall's response as an object.

addSystemModemConnect()

Trigger a connect for the configured modem.

public addSystemModemConnect() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/modem/connect

Return values
stdClass —

Return the firewall's response as an object.

addSystemModemDisconnect()

Trigger a disconnect for the configured modem.

public addSystemModemDisconnect() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/modem/disconnect

Return values
stdClass —

Return the firewall's response as an object.

addSystemModemReset()

Reset statistics for internal/external configured modem.

public addSystemModemReset() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/modem/reset

Return values
stdClass —

Return the firewall's response as an object.

addSystemModemUpdate()

Update supported modem list from FortiGuard.

public addSystemModemUpdate() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/modem/update

Return values
stdClass —

Return the firewall's response as an object.

addSystemOsReboot()

Immediately reboot this device.

public addSystemOsReboot( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/os/reboot

Return values
stdClass —

Return the firewall's response as an object.

addSystemOsShutdown()

Immediately shutdown this device.

public addSystemOsShutdown( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/os/shutdown

Return values
stdClass —

Return the firewall's response as an object.

addSystemPasswordPolicyConformSelect()

Check whether password conforms to the password policy.

public addSystemPasswordPolicyConformSelect( $body) : stdClass

Access Group: any

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/password-policy-conform/select

Return values
stdClass —

Return the firewall's response as an object.

addSystemSdnConnectorUpdate()

Update an SDN connector's connection status.

public addSystemSdnConnectorUpdate( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/sdn-connector/update

Return values
stdClass —

Return the firewall's response as an object.

addSystemSdnConnectorValidateGcpKey()

Validate a string representing a private key from GCP in PEM format.

public addSystemSdnConnectorValidateGcpKey( $body) : stdClass

Access Group: any

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/sdn-connector/validate-gcp-key

Return values
stdClass —

Return the firewall's response as an object.

addSystemSecurityRatingTrigger()

Run a Security Rating report.

public addSystemSecurityRatingTrigger( $body) : stdClass

Access Group: secfabgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/security-rating/trigger

Return values
stdClass —

Return the firewall's response as an object.

addSystemSnifferClear()

Clear the results of a specified packet capture.

public addSystemSnifferClear( $body) : stdClass

Access Group: netgrp.packet-capture

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/sniffer/clear

Return values
stdClass —

Return the firewall's response as an object.

addSystemSnifferRestart()

Restart specified packet capture.

public addSystemSnifferRestart( $body) : stdClass

Access Group: netgrp.packet-capture

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/sniffer/restart

Return values
stdClass —

Return the firewall's response as an object.

addSystemSnifferStart()

Start specified packet capture.

public addSystemSnifferStart( $body) : stdClass

Access Group: netgrp.packet-capture

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/sniffer/start

Return values
stdClass —

Return the firewall's response as an object.

addSystemSnifferStop()

Stop specified packet capture.

public addSystemSnifferStop( $body) : stdClass

Access Group: netgrp.packet-capture

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/sniffer/stop

Return values
stdClass —

Return the firewall's response as an object.

addSystemTimeSet()

Sets current system time stamp.

public addSystemTimeSet( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/time/set

Return values
stdClass —

Return the firewall's response as an object.

addSystemUsbDeviceEject()

Eject USB drives for safe removal.

public addSystemUsbDeviceEject() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/usb-device/eject

Return values
stdClass —

Return the firewall's response as an object.

addSystemUsbLogStart()

Start backup of logs from current VDOM to USB drive.

public addSystemUsbLogStart() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/usb-log/start

Return values
stdClass —

Return the firewall's response as an object.

addSystemUsbLogStop()

Stop backup of logs to USB drive.

public addSystemUsbLogStop() : stdClass

Access Group: sysgrp.cfg

Tags
route

POST /system/usb-log/stop

Return values
stdClass —

Return the firewall's response as an object.

addSystemVmlicenseUpload()

Update VM license using uploaded file. Reboots immediately if successful.

public addSystemVmlicenseUpload( $body) : stdClass

Access Group: sysgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /system/vmlicense/upload

Return values
stdClass —

Return the firewall's response as an object.

addUserBannedAdd_users()

Immediately add one or more users to the banned list.

public addUserBannedAdd_users( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/banned/add_users

Return values
stdClass —

Return the firewall's response as an object.

addUserBannedClear_all()

Immediately clear all banned users.

public addUserBannedClear_all() : stdClass

Access Group: authgrp

Tags
route

POST /user/banned/clear_all

Return values
stdClass —

Return the firewall's response as an object.

addUserBannedClear_users()

Immediately clear a list of specific banned users by IP.

public addUserBannedClear_users( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/banned/clear_users

Return values
stdClass —

Return the firewall's response as an object.

addUserDeviceRemove()

Remove single or multiple user devices specified by host MAC addresses.

public addUserDeviceRemove( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/device/remove

Return values
stdClass —

Return the firewall's response as an object.

addUserFirewallAuth()

Trigger authentication for a single firewall user.

public addUserFirewallAuth( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/firewall/auth

Return values
stdClass —

Return the firewall's response as an object.

addUserFirewallDeauth()

Deauthenticate single, multiple, or all firewall users.

public addUserFirewallDeauth( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/firewall/deauth

Return values
stdClass —

Return the firewall's response as an object.

addUserFortitokenActivate()

Activate a set of FortiTokens by serial number.

public addUserFortitokenActivate( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/fortitoken/activate

Return values
stdClass —

Return the firewall's response as an object.

addUserFortitokenImportMobile()

Import a list of tokens from FortiGuard to the FortiGate unit.

public addUserFortitokenImportMobile( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/fortitoken/import-mobile

Return values
stdClass —

Return the firewall's response as an object.

addUserFortitokenImportSeed()

Import a FortiToken seed file.

public addUserFortitokenImportSeed( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/fortitoken/import-seed

Return values
stdClass —

Return the firewall's response as an object.

addUserFortitokenImportTrial()

Import trial mobile FortiTokens.

public addUserFortitokenImportTrial() : stdClass

Access Group: authgrp

Tags
route

POST /user/fortitoken/import-trial

Return values
stdClass —

Return the firewall's response as an object.

addUserFortitokenProvision()

Provision a set of FortiTokens by serial number.

public addUserFortitokenProvision( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/fortitoken/provision

Return values
stdClass —

Return the firewall's response as an object.

addUserFortitokenRefresh()

Refresh a set of FortiTokens by serial number.

public addUserFortitokenRefresh( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/fortitoken/refresh

Return values
stdClass —

Return the firewall's response as an object.

addUserFortitokenSendActivation()

Send a FortiToken activation code to a user via SMS or Email.

public addUserFortitokenSendActivation( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/fortitoken/send-activation

Return values
stdClass —

Return the firewall's response as an object.

addUserFssoRefreshServer()

Refresh remote agent group list for all fsso agents.

public addUserFssoRefreshServer() : stdClass

Access Group: authgrp

Tags
route

POST /user/fsso/refresh-server

Return values
stdClass —

Return the firewall's response as an object.

addUserGuestEmail()

Sent guest login details via email.

public addUserGuestEmail( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/guest/email

Return values
stdClass —

Return the firewall's response as an object.

addUserGuestSms()

Sent guest login details via SMS.

public addUserGuestSms( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/guest/sms

Return values
stdClass —

Return the firewall's response as an object.

addUserRadiusTestConnect()

Test the connectivity of the given RADIUS server and, optionally, the validity of a username & password.

public addUserRadiusTestConnect( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/radius/test-connect

Return values
stdClass —

Return the firewall's response as an object.

addUserTacacsPlusTest()

Test the connectivity of the given TACACS+ server.

public addUserTacacsPlusTest( $body) : stdClass

Access Group: authgrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /user/tacacs-plus/test

Return values
stdClass —

Return the firewall's response as an object.

addUtmRatingLookupSelect()

Lookup FortiGuard rating for a specific URL.

public addUtmRatingLookupSelect( $body) : stdClass

Access Group: utmgrp.webfilter

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /utm/rating-lookup/select

Return values
stdClass —

Return the firewall's response as an object.

addVpnCertificateCaImport()

Import CA certificate.

public addVpnCertificateCaImport( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn-certificate/ca/import

Return values
stdClass —

Return the firewall's response as an object.

addVpnCertificateCrlImport()

Import certificate revocation lists (CRL) from file content.

public addVpnCertificateCrlImport( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn-certificate/crl/import

Return values
stdClass —

Return the firewall's response as an object.

addVpnCertificateCsrGenerate()

Generate a certificate signing request (CSR) and a private key. The CSR can be retrieved / downloaded from CLI, GUI and REST API.

public addVpnCertificateCsrGenerate( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn-certificate/csr/generate

Return values
stdClass —

Return the firewall's response as an object.

addVpnCertificateLocalImport()

Import local certificate.

public addVpnCertificateLocalImport( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn-certificate/local/import

Return values
stdClass —

Return the firewall's response as an object.

addVpnCertificateRemoteImport()

Import remote certificate.

public addVpnCertificateRemoteImport( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn-certificate/remote/import

Return values
stdClass —

Return the firewall's response as an object.

addVpnIkeClear()

Clear IKE gateways.

public addVpnIkeClear( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn/ike/clear

Return values
stdClass —

Return the firewall's response as an object.

addVpnIpsecTunnel_down()

Bring down a specific IPsec VPN tunnel.

public addVpnIpsecTunnel_down( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn/ipsec/tunnel_down

Return values
stdClass —

Return the firewall's response as an object.

addVpnIpsecTunnel_reset_stats()

Reset statistics for a specific IPsec VPN tunnel.

public addVpnIpsecTunnel_reset_stats( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn/ipsec/tunnel_reset_stats

Return values
stdClass —

Return the firewall's response as an object.

addVpnIpsecTunnel_up()

Bring up a specific IPsec VPN tunnel.

public addVpnIpsecTunnel_up( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn/ipsec/tunnel_up

Return values
stdClass —

Return the firewall's response as an object.

addVpnSslClear_tunnel()

Remove all active tunnel sessions in current virtual domain.

public addVpnSslClear_tunnel() : stdClass

Access Group: vpngrp

Tags
route

POST /vpn/ssl/clear_tunnel

Return values
stdClass —

Return the firewall's response as an object.

addVpnSslDelete()

Terminate the provided SSL-VPN session.

public addVpnSslDelete( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn/ssl/delete

Return values
stdClass —

Return the firewall's response as an object.

addVpnSslProvisionUser()

Provision SSL-VPN users with target applications. The provisioning message (email or SMS) is sent with no confirmation of success.

public addVpnSslProvisionUser( $body) : stdClass

Access Group: vpngrp

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /vpn/ssl/provision-user

Return values
stdClass —

Return the firewall's response as an object.

addWanoptHistoryReset()

Reset WAN opt. statistics.

public addWanoptHistoryReset() : stdClass

Access Group: wanoptgrp

Tags
route

POST /wanopt/history/reset

Return values
stdClass —

Return the firewall's response as an object.

addWanoptPeer_statsReset()

Reset WAN opt peer statistics.

public addWanoptPeer_statsReset() : stdClass

Access Group: wanoptgrp

Tags
route

POST /wanopt/peer_stats/reset

Return values
stdClass —

Return the firewall's response as an object.

addWanoptWebcacheReset()

Reset webcache statistics.

public addWanoptWebcacheReset() : stdClass

Access Group: wanoptgrp

Tags
route

POST /wanopt/webcache/reset

Return values
stdClass —

Return the firewall's response as an object.

addWebcacheStatsReset()

Reset all webcache statistics.

public addWebcacheStatsReset() : stdClass

Access Group: wanoptgrp

Tags
route

POST /webcache/stats/reset

Return values
stdClass —

Return the firewall's response as an object.

addWebfilterCategoryQuotaReset()

Reset webfilter quota for user or IP.

public addWebfilterCategoryQuotaReset( $body) : stdClass

Access Group: utmgrp.webfilter

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /webfilter/category-quota/reset

Return values
stdClass —

Return the firewall's response as an object.

addWebfilterOverrideDelete()

Delete a configured webfilter override.

public addWebfilterOverrideDelete( $body) : stdClass

Access Group: utmgrp.webfilter

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /webfilter/override/delete

Return values
stdClass —

Return the firewall's response as an object.

addWebproxyPacfileUpload()

Upload webproxy PAC file.

public addWebproxyPacfileUpload( $body) : stdClass

Access Group: netgrp.cfg

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /webproxy/pacfile/upload

Return values
stdClass —

Return the firewall's response as an object.

addWebUiCustomLanguageCreate()

Upload custom language file to this Fortigate.

public addWebUiCustomLanguageCreate( $body) : stdClass

Access Group: sysgrp.mnt

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /web-ui/custom-language/create

Return values
stdClass —

Return the firewall's response as an object.

addWebUiCustomLanguageUpdate()

Update custom language file to this Fortigate.

public addWebUiCustomLanguageUpdate( $body) : stdClass

Access Group: sysgrp.mnt

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /web-ui/custom-language/update

Return values
stdClass —

Return the firewall's response as an object.

addWebUiLanguageImport()

Import localization language file to this FortiGate.

public addWebUiLanguageImport( $body) : stdClass

Access Group: sysgrp.mnt

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /web-ui/language/import

Return values
stdClass —

Return the firewall's response as an object.

addWifiClientDisassociate()

Disassociate a WiFi client from the FortiAP it's currently connected to. The client will need to reassociate with the same FortiAP or another to resume connectivity.

public addWifiClientDisassociate( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/client/disassociate

Return values
stdClass —

Return the firewall's response as an object.

addWifiEuclidReset()

Reset presence analytics statistics.

public addWifiEuclidReset() : stdClass

Access Group: wifi

Tags
route

POST /wifi/euclid/reset

Return values
stdClass —

Return the firewall's response as an object.

addWifiFirmwareDownload()

Download FortiAP firmware from FortiGuard to the FortiGate according to FortiAP image ID.

public addWifiFirmwareDownload( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/firmware/download

Return values
stdClass —

Return the firewall's response as an object.

addWifiFirmwarePush()

Push FortiAP firmware to the given device.

public addWifiFirmwarePush( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/firmware/push

Return values
stdClass —

Return the firewall's response as an object.

addWifiFirmwareUpload()

Upload FortiAP firmware to the management FortiGate and then push to target FortiAPs.

public addWifiFirmwareUpload( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/firmware/upload

Return values
stdClass —

Return the firewall's response as an object.

addWifiManaged_apLedBlink()

Turn a managed FortiAP's LED blinking on or off.

public addWifiManaged_apLedBlink( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/managed_ap/led-blink

Return values
stdClass —

Return the firewall's response as an object.

addWifiManaged_apRestart()

Restart a given FortiAP.

public addWifiManaged_apRestart( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/managed_ap/restart

Return values
stdClass —

Return the firewall's response as an object.

addWifiManaged_apSet_status()

Update administrative state for a given FortiAP (enable or disable authorization).

public addWifiManaged_apSet_status( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/managed_ap/set_status

Return values
stdClass —

Return the firewall's response as an object.

addWifiNetworkConnect()

When FortiWiFi is in client mode, connect to the specified network, if configured in the 'wifi' interface.

public addWifiNetworkConnect( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/network/connect

Return values
stdClass —

Return the firewall's response as an object.

addWifiNetworkScan()

When FortiWiFi is in client mode, start a scan for local WiFi networks.

public addWifiNetworkScan() : stdClass

Access Group: wifi

Tags
route

POST /wifi/network/scan

Return values
stdClass —

Return the firewall's response as an object.

addWifiRegionImageUpload()

Saves a floorplan/region image to an existing region.

public addWifiRegionImageUpload( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/region-image/upload

Return values
stdClass —

Return the firewall's response as an object.

addWifiRogue_apClear_all()

Clear all detected rogue APs.

public addWifiRogue_apClear_all() : stdClass

Access Group: wifi

Tags
route

POST /wifi/rogue_ap/clear_all

Return values
stdClass —

Return the firewall's response as an object.

addWifiRogue_apSet_status()

Mark detected APs as rogue APs.

public addWifiRogue_apSet_status( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/rogue_ap/set_status

Return values
stdClass —

Return the firewall's response as an object.

addWifiSpectrumKeepAlive()

Extend duration of an existing spectrum analysis for a specific FortiAP.

public addWifiSpectrumKeepAlive( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/spectrum/keep-alive

Return values
stdClass —

Return the firewall's response as an object.

addWifiSpectrumStart()

Start spectrum analysis for a specific FortiAP for a duration of time.

public addWifiSpectrumStart( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/spectrum/start

Return values
stdClass —

Return the firewall's response as an object.

addWifiSpectrumStop()

Stop spectrum analysis for a specific FortiAP.

public addWifiSpectrumStop( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/spectrum/stop

Return values
stdClass —

Return the firewall's response as an object.

addWifiSsidGenerateKeys()

Generate pre-shared keys for specific multi pre-shared key profile.

public addWifiSsidGenerateKeys( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/ssid/generate-keys

Return values
stdClass —

Return the firewall's response as an object.

addWifiVlanProbeStart()

Start a VLAN probe.

public addWifiVlanProbeStart( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/vlan-probe/start

Return values
stdClass —

Return the firewall's response as an object.

addWifiVlanProbeStop()

Stop a VLAN probe.

public addWifiVlanProbeStop( $body) : stdClass

Access Group: wifi

Parameters
$body :

Possible parameters to go in the body for the request.

Tags
route

POST /wifi/vlan-probe/stop

Return values
stdClass —

Return the firewall's response as an object.

commitTransaction()

Commit a transaction (apply operations).

public commitTransaction([string|null $vdom = null ]) : bool
Parameters
$vdom : string|null = null

Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

Return values
bool —

Return TRUE on success and FALSE on failure.

getAllAzureApplicationList()

Retrieve a list of Azure applications that can be used for configuring an Azure SDN connector.

public getAllAzureApplicationList() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /azure/application-list

Return values
stdClass —

Return the firewall's response as an object.

getAllEndpointControlAvatarDownload()

Download an endpoint avatar image.

public getAllEndpointControlAvatarDownload([ $uid = null ][,  $user = null ][,  $fingerprint = null ][,  $default = null ]) : stdClass

Access Group: utmgrp.endpoint-control

Parameters
$uid : = null

Single FortiClient UID.

$user : = null

User name of the endpoint.

$fingerprint : = null

Avatar fingerprint.

$default : = null

Default avatar name ['authuser'|'unauthuser'|'authuser_72'|'unauthuser_72']. Default avatar when endpoint / device avatar is not available. If default is not set, Not found 404 is returned.

Tags
route

GET /endpoint-control/avatar/download

Return values
stdClass —

Return the firewall's response as an object.

getAllEndpointControlEmsCertStatus()

Retrieve authentication status of the EMS server certificate for a specific EMS.

public getAllEndpointControlEmsCertStatus( $ems_name[,  $with_cert = null ]) : stdClass

Access Group: utmgrp.endpoint-control

Parameters
$ems_name :

EMS server name (as defined in CLI table endpoint-control.fctems).

$with_cert : = null

Return detailed certificate information. Available when the certificate is authenticated by installed CA certificates.

Tags
route

GET /endpoint-control/ems/cert-status

Return values
stdClass —

Return the firewall's response as an object.

getAllEndpointControlEmsStatus()

Retrieve EMS connection status for a specific EMS.

public getAllEndpointControlEmsStatus( $ems_name) : stdClass

Access Group: utmgrp.endpoint-control

Parameters
$ems_name :

EMS server name (as defined in CLI table endpoint-control.fctems).

Tags
route

GET /endpoint-control/ems/status

Return values
stdClass —

Return the firewall's response as an object.

getAllEndpointControlEmsStatusSummary()

Retrieve status summary for all configured EMS.

public getAllEndpointControlEmsStatusSummary() : stdClass

Access Group: utmgrp.endpoint-control

Tags
route

GET /endpoint-control/ems/status-summary

Return values
stdClass —

Return the firewall's response as an object.

getAllEndpointControlInstaller()

List available FortiClient installers.

public getAllEndpointControlInstaller([ $min_version = null ]) : stdClass

Access Group: utmgrp.endpoint-control

Parameters
$min_version : = null

Filter: Minimum installer version. (String of the format n[.n[.n]]).

Tags
route

GET /endpoint-control/installer

Return values
stdClass —

Return the firewall's response as an object.

getAllEndpointControlInstallerDownload()

Download a FortiClient installer via FortiGuard.

public getAllEndpointControlInstallerDownload( $mkey) : stdClass

Access Group: utmgrp.endpoint-control

Parameters
$mkey :

Name of installer (image_id).

Tags
route

GET /endpoint-control/installer/download

Return values
stdClass —

Return the firewall's response as an object.

getAllEndpointControlRecordList()

List endpoint records.

public getAllEndpointControlRecordList([ $intf_name = null ]) : stdClass

Access Group: utmgrp.endpoint-control

Parameters
$intf_name : = null

Filter: Name of interface where the endpoint was detected.

Tags
route

GET /endpoint-control/record-list

Return values
stdClass —

Return the firewall's response as an object.

getAllEndpointControlSummary()

Summary of FortiClient endpoint records.

public getAllEndpointControlSummary() : stdClass

Access Group: utmgrp.endpoint-control

Tags
route

GET /endpoint-control/summary

Return values
stdClass —

Return the firewall's response as an object.

getAllExtenderControllerExtender()

Retrieve statistics for specific configured FortiExtender units.

public getAllExtenderControllerExtender( $id[,  $name = null ][,  $type = null ]) : stdClass

Access Group: netgrp.cfg

Parameters
$id :

FortiExtender ID.

$name : = null

List of FortiExtender IDs to query.

$type : = null

Statistic type.'type' options are [system | modem | usage | last]. If 'type' is not specified, all types of statistics are retrieved.

Tags
route

GET /extender-controller/extender

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallAcl()

List counters for all IPv4 ACL.

public getAllFirewallAcl() : stdClass

Access Group: fwgrp.policy

Tags
route

GET /firewall/acl

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallAcl6()

List counters for all IPv6 ACL.

public getAllFirewallAcl6() : stdClass

Access Group: fwgrp.policy

Tags
route

GET /firewall/acl6

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallAddress6Dynamic()

List of IPv6 Fabric Connector address objects and the IPs they resolve to.

public getAllFirewallAddress6Dynamic() : stdClass

Access Group: fwgrp.address

Tags
route

GET /firewall/address6-dynamic

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallAddressDynamic()

List of Fabric Connector address objects and the IPs they resolve to.

public getAllFirewallAddressDynamic() : stdClass

Access Group: fwgrp.address

Tags
route

GET /firewall/address-dynamic

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallAddressFqdns()

List of FQDN address objects and the IPs they resolved to.

public getAllFirewallAddressFqdns() : stdClass

Access Group: fwgrp.address

Tags
route

GET /firewall/address-fqdns

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallAddressFqdns6()

List of IPv6 FQDN address objects and the IPs they resolved to.

public getAllFirewallAddressFqdns6() : stdClass

Access Group: fwgrp.address

Tags
route

GET /firewall/address-fqdns6

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallHealth()

List configured load balance server health monitors.

public getAllFirewallHealth() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /firewall/health

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallInternetServiceDetails()

List all details for a given Internet Service ID.

public getAllFirewallInternetServiceDetails( $id[,  $country_id = null ][,  $region_id = null ][,  $city_id = null ][,  $start = null ][,  $count = null ][,  $summary_only = null ]) : stdClass

Access Group: fwgrp.address

Parameters
$id :

ID of the Internet Service to get details for.

$country_id : = null

Filter: Country ID.

$region_id : = null

Filter: Region ID.

$city_id : = null

Filter: City ID.

$start : = null

Starting entry index. If a value is less than zero, it will be set to zero.

$count : = null

Maximum number of entries to return. Valid range is [20, 1000]; if a value is specified out of that range, it will be rounded up or down. Default value is 1000.

$summary_only : = null

Only return number of entries instead of entries.

Tags
route

GET /firewall/internet-service-details

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallInternetServiceMatch()

List internet services that exist at a given IP or Subnet.

public getAllFirewallInternetServiceMatch( $ip,  $mask) : stdClass

Access Group: any

Parameters
$ip :

IP (in dot-decimal notation).

$mask :

IP Mask (in dot-decimal notation).

Tags
route

GET /firewall/internet-service-match

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallIppool()

List IPv4 pool statistics.

public getAllFirewallIppool() : stdClass

Access Group: fwgrp.policy

Tags
route

GET /firewall/ippool

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallIppoolMapping()

Get the list of IPv4 mappings for the specified IP pool.

public getAllFirewallIppoolMapping( $mkey) : stdClass

Access Group: fwgrp.policy

Parameters
$mkey :

The IP pool name.

Tags
route

GET /firewall/ippool/mapping

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallLoadBalance()

List all firewall load balance servers.

public getAllFirewallLoadBalance([ $start = null ],  $count) : stdClass

Access Group: fwgrp.others

Parameters
$start : = null

Starting entry index.

$count :

Maximum number of entries to return.

Tags
route

GET /firewall/load-balance

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallLocalIn()

List implicit and explicit local-in firewall policies.

public getAllFirewallLocalIn() : stdClass

Access Group: fwgrp.policy

Tags
route

GET /firewall/local-in

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallPerIpShaper()

List of statistics for configured firewall per-IP traffic shapers.

public getAllFirewallPerIpShaper() : stdClass

Access Group: fwgrp.others

Tags
route

GET /firewall/per-ip-shaper

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallPolicy()

List traffic statistics for firewall policies.

public getAllFirewallPolicy([ $policyid = null ][,  $ip_version = null ]) : stdClass

Access Group: fwgrp.policy

Parameters
$policyid : = null

Filter: Policy ID.

$ip_version : = null

Filter: Traffic IP Version. [ ipv4 | ipv6 ], if left empty, will retrieve data for both ipv4 and ipv6.

Tags
route

GET /firewall/policy

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallPolicyLookup()

Performs a policy lookup by creating a dummy packet and asking the kernel which policy would be hit.

public getAllFirewallPolicyLookup([ $ipv6 = null ],  $srcintf[,  $sourceport = null ][,  $sourceip = null ],  $protocol,  $dest[,  $destport = null ][,  $icmptype = null ][,  $icmpcode = null ]) : stdClass

Access Group: fwgrp.policy

Parameters
$ipv6 : = null

Perform an IPv6 lookup?

$srcintf :

Source interface.

$sourceport : = null

Source port.

$sourceip : = null

Source IP.

$protocol :

Protocol.

$dest :

Destination IP/FQDN.

$destport : = null

Destination port.

$icmptype : = null

ICMP type.

$icmpcode : = null

ICMP code.

Tags
route

GET /firewall/policy-lookup

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallProxyPolicy()

List traffic statistics for all explicit proxy policies.

public getAllFirewallProxyPolicy([ $policyid = null ]) : stdClass

Access Group: fwgrp.policy

Parameters
$policyid : = null

Filter: Policy ID.

Tags
route

GET /firewall/proxy-policy

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallSdnConnectorFilters()

List all available filters for a specified SDN Fabric Connector. Used for Fabric Connector address objects.

public getAllFirewallSdnConnectorFilters( $connector) : stdClass

Access Group: fwgrp.address

Parameters
$connector :

Name of the SDN Fabric Connector to get the filters from.

Tags
route

GET /firewall/sdn-connector-filters

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallSecurityPolicy()

List IPS engine statistics for security policies.

public getAllFirewallSecurityPolicy([ $policyid = null ]) : stdClass

Access Group: fwgrp.policy

Parameters
$policyid : = null

Filter: Policy ID.

Tags
route

GET /firewall/security-policy

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallSession()

List all active firewall sessions (optionally filtered).

public getAllFirewallSession([ $ip_version = null ][,  $start = null ],  $count[,  $summary = null ][,  $sourceport = null ][,  $policyid = null ][,  $application = null ][,  $protocol = null ][,  $destport = null ][,  $srcintf = null ][,  $dstintf = null ][,  $srcintfrole = null ][,  $dstintfrole = null ][,  $source = null ][,  $srcuuid = null ][,  $destination = null ][,  $dstuuid = null ][,  $username = null ][,  $shaper = null ][,  $country = null ][,  $owner = null ][,  $natsourceaddress = null ][,  $natsourceport = null ][,  $filterCsf = null ][,  $since = null ][,  $seconds = null ][,  $webDomain = null ][,  $webCategory = null ][,  $fortiasic = null ][,  $nturbo = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$ip_version : = null

IP version [*ipv4 | ipv6 | ipboth].

$start : = null

Starting entry index.

$count :

Maximum number of entries to return. Valid range is [20, 1000]; if a value is specified out of that range, it will be rounded up or down.

$summary : = null

Enable/disable inclusion of session summary (setup rate, total sessions, etc).

$sourceport : = null

Filter: Source port.

$policyid : = null

Filter: Policy ID.

$application : = null

Filter: Application PROTO/PORT. (e.g. "TCP/443")

$protocol : = null

Filter: Protocol name [all|igmp|tcp|udp|icmp|etc].

$destport : = null

Filter: Destination port.

$srcintf : = null

Filter: Source interface name.

$dstintf : = null

Filter: Destination interface name.

$srcintfrole : = null

Filter: Source interface roles.

$dstintfrole : = null

Filter: Destination interface roles.

$source : = null

Filter: Source IP address.

$srcuuid : = null

Filter: Source UUID.

$destination : = null

Filter: Destination IP address.

$dstuuid : = null

Filter: Destination UUID.

$username : = null

Filter: Authenticated username.

$shaper : = null

Filter: Forward traffic shaper name.

$country : = null

Filter: Destination country name.

$owner : = null

Filter: Destination owner.

$natsourceaddress : = null

Filter: NAT source address.

$natsourceport : = null

Filter: NAT source port.

$filterCsf : = null

Filter: Include sessions from downstream fortigates.

$since : = null

Filter: Only return sessions generated since this Unix timestamp.

$seconds : = null

Filter: Only return sessions generated in the last N seconds.

$webDomain : = null

Filter: Web domain.

$webCategory : = null

Filter: Web category.

$fortiasic : = null

Filter: 1 to include NPU accelerated sessions, 0 to exclude.

$nturbo : = null

Filter: 1 to include nTurbo sessions, 0 to exclude.

Tags
route

GET /firewall/session

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallShaper()

List of statistics for configured firewall shared traffic shapers.

public getAllFirewallShaper() : stdClass

Access Group: fwgrp.others

Tags
route

GET /firewall/shaper

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallUuidList()

Retrieve a list of all UUIDs with their object type and VDOM.

public getAllFirewallUuidList() : stdClass

Access Group: fwgrp.address

Tags
route

GET /firewall/uuid-list

Return values
stdClass —

Return the firewall's response as an object.

getAllFirewallUuidTypeLookup()

Retrieve a mapping of UUIDs to their firewall object type for given UUIDs.

public getAllFirewallUuidTypeLookup([ $uuids = null ]) : stdClass

Access Group: fwgrp.address

Parameters
$uuids : = null

List of UUIDs to be resolved.

Tags
route

GET /firewall/uuid-type-lookup

Return values
stdClass —

Return the firewall's response as an object.

getAllFortiguardRedirectPortal()

Retrieve the FortiGuard redirect portal IP.

public getAllFortiguardRedirectPortal() : stdClass

Access Group: any

Tags
route

GET /fortiguard/redirect-portal

Return values
stdClass —

Return the firewall's response as an object.

getAllFortiguardServiceCommunicationStats()

Retrieve historical statistics for communication with FortiGuard services.

public getAllFortiguardServiceCommunicationStats([ $service_type = null ][,  $timeslot = null ]) : stdClass

Access Group: sysgrp.mnt

Parameters
$service_type : = null

To get stats for [forticare|fortiguard_download|fortiguard_query|forticloud_log|fortisandbox_cloud|fortiguard.com|ocvpn|sdns|fortitoken_registration|sms_service]. Defaults to all stats if not provided.

$timeslot : = null

History timeslot of stats [1_hour|24_hour|1_week]. Defaults to all timeslots if not provided.

Tags
route

GET /fortiguard/service-communication-stats

Return values
stdClass —

Return the firewall's response as an object.

getAllFortiviewSandboxFileDetails()

Retrieve FortiSandbox analysis details for a specific file checksum.

public getAllFortiviewSandboxFileDetails( $checksum) : stdClass

Access Group: sysgrp.cfg

Parameters
$checksum :

Checksum of a specific file that has been analyzed by the connected FortiSandbox.

Tags
route

GET /fortiview/sandbox-file-details

Return values
stdClass —

Return the firewall's response as an object.

getAllFortiviewSandboxFileList()

Retrieve list of available FortiSandbox analysis files.

public getAllFortiviewSandboxFileList() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /fortiview/sandbox-file-list

Return values
stdClass —

Return the firewall's response as an object.

getAllFortiviewStatistics()

Retrieve drill-down and summary data for FortiView (both realtime and historical).

public getAllFortiviewStatistics([ $realtime = null ][,  $filter = null ][,  $sessionid = null ][,  $count = null ][,  $device = null ][,  $report_by = null ][,  $sort_by = null ][,  $chart_only = null ][,  $start = null ][,  $end = null ][,  $ip_version = null ]) : stdClass

Access Group: ftviewgrp

Parameters
$realtime : = null

Set to true to retrieve realtime results (from kernel).

$filter : = null

A map of filter keys to arrays of values.

$sessionid : = null

FortiView request Session ID.

$count : = null

Maximum number of details to return.

$device : = null

FortiView source device [disk|fortianalyzer|forticloud].

$report_by : = null

Report by field.

$sort_by : = null

Sort by field.

$chart_only : = null

Only return graph values in results.

$start : = null

Start timestamp.

$end : = null

End timestamp.

$ip_version : = null

IP version [*ipv4 | ipv6 | ipboth].

Tags
route

GET /fortiview/statistics

Return values
stdClass —

Return the firewall's response as an object.

getAllIpsAnomaly()

Returns IPS anomaly list.

public getAllIpsAnomaly() : stdClass

Access Group: utmgrp.ips

Tags
route

GET /ips/anomaly

Return values
stdClass —

Return the firewall's response as an object.

getAllIpsExceedScanRange()

Returns a list of applications that exceed the scan range from a list of application IDs.

public getAllIpsExceedScanRange( $ids) : stdClass

Access Group: utmgrp.ips

Parameters
$ids :

List of application IDs.

Tags
route

GET /ips/exceed-scan-range

Return values
stdClass —

Return the firewall's response as an object.

getAllIpsMetadata()

Returns IPS meta data.

public getAllIpsMetadata() : stdClass

Access Group: utmgrp.ips

Tags
route

GET /ips/metadata

Return values
stdClass —

Return the firewall's response as an object.

getAllIpsRateBased()

Returns a list of rate-based signatures in IPS package.

public getAllIpsRateBased() : stdClass

Access Group: utmgrp.ips

Tags
route

GET /ips/rate-based

Return values
stdClass —

Return the firewall's response as an object.

getAllLicenseFortianalyzerStatus()

Get current license & registration status for the connected FortiAnalyzer.

public getAllLicenseFortianalyzerStatus() : stdClass

Access Group: secfabgrp

Tags
route

GET /license/fortianalyzer-status

Return values
stdClass —

Return the firewall's response as an object.

getAllLicenseForticareOrgList()

Get FortiCare organization size and industry lists.

public getAllLicenseForticareOrgList() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /license/forticare-org-list

Return values
stdClass —

Return the firewall's response as an object.

getAllLicenseForticareResellers()

Get current FortiCare resellers for the requested country.

public getAllLicenseForticareResellers([ $country_code = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$country_code : = null

FortiGuard country code

Tags
route

GET /license/forticare-resellers

Return values
stdClass —

Return the firewall's response as an object.

getAllLicenseStatus()

Get current license & registration status.

public getAllLicenseStatus() : stdClass

Access Group: any

Tags
route

GET /license/status

Return values
stdClass —

Return the firewall's response as an object.

getAllLogAvArchiveDownload()

Download file quarantined by AntiVirus.

public getAllLogAvArchiveDownload( $mkey) : stdClass

Access Group: loggrp.data-access

Parameters
$mkey :

Checksum for quarantined file.

Tags
route

GET /log/av-archive/download

Return values
stdClass —

Return the firewall's response as an object.

getAllLogCurrentDiskUsage()

Return current used, free and total disk bytes.

public getAllLogCurrentDiskUsage() : stdClass

Access Group: loggrp.data-access

Tags
route

GET /log/current-disk-usage

Return values
stdClass —

Return the firewall's response as an object.

getAllLogDeviceState()

Retrieve information on state of log devices.

public getAllLogDeviceState() : stdClass

Access Group: loggrp.data-access

Tags
route

GET /log/device/state

Return values
stdClass —

Return the firewall's response as an object.

getAllLogEvent()

List all event log descriptions. Deprecated in 6.2.3 replaced by /api/v2/static/logid_metadata.json.

public getAllLogEvent() : stdClass

Access Group: any

Tags
route

GET /log/event

Return values
stdClass —

Return the firewall's response as an object.

getAllLogFortianalyzer()

Return FortiAnalyzer/FortiManager log status.

public getAllLogFortianalyzer([ $scope = null ][,  $server = null ][,  $srcip = null ]) : stdClass

Access Group: loggrp.config

Parameters
$scope : = null

Scope from which to test the connectivity of the FortiAnalyzer address [vdom|global].

$server : = null

FortiAnalyzer/FortiManager address.

$srcip : = null

The IP to use to make the request to the FortiAnalyzer [|auto]. When set to "auto" it will use the FortiGate's routing table to determine the IP to make the request from.

Tags
route

GET /log/fortianalyzer

Return values
stdClass —

Return the firewall's response as an object.

getAllLogFortianalyzerQueue()

Retrieve information on FortiAnalyzer's queue state. Note:- FortiAnalyzer logs are queued only if upload-option is realtime.

public getAllLogFortianalyzerQueue([ $scope = null ]) : stdClass

Access Group: loggrp.config

Parameters
$scope : = null

Scope from which to retrieve FortiAnalyzer's queue state [vdom*|global].

Tags
route

GET /log/fortianalyzer-queue

Return values
stdClass —

Return the firewall's response as an object.

getAllLogForticloud()

Return FortiCloud log status.

public getAllLogForticloud() : stdClass

Access Group: loggrp.config

Tags
route

GET /log/forticloud

Return values
stdClass —

Return the firewall's response as an object.

getAllLogForticloudReportDownload()

Download PDF report from FortiCloud.

public getAllLogForticloudReportDownload( $mkey[,  $inline = null ]) : stdClass

Access Group: loggrp.data-access

Parameters
$mkey :

FortiCloud Report ID.

$inline : = null

Set to 1 to download the report inline.

Tags
route

GET /log/forticloud-report/download

Return values
stdClass —

Return the firewall's response as an object.

getAllLogForticloudReportList()

Get FortiCloud report list.

public getAllLogForticloudReportList() : stdClass

Access Group: loggrp.data-access

Tags
route

GET /log/forticloud-report-list

Return values
stdClass —

Return the firewall's response as an object.

getAllLogHistoricDailyRemoteLogs()

Returns the amount of logs in bytes sent daily to a remote logging service (FortiCloud or FortiAnalyzer).

public getAllLogHistoricDailyRemoteLogs( $server) : stdClass

Access Group: loggrp.data-access

Parameters
$server :

Service name [forticloud | fortianalyzer].

Tags
route

GET /log/historic-daily-remote-logs

Return values
stdClass —

Return the firewall's response as an object.

getAllLogHourlyDiskUsage()

Return historic hourly disk usage in bytes.

public getAllLogHourlyDiskUsage() : stdClass

Access Group: loggrp.data-access

Tags
route

GET /log/hourly-disk-usage

Return values
stdClass —

Return the firewall's response as an object.

getAllLogIpsArchiveDownload()

Download IPS/application control packet capture files. Uses configured log display device.

public getAllLogIpsArchiveDownload( $mkey[,  $pcap_no = null ][,  $pcap_category = null ]) : stdClass

Access Group: loggrp.data-access

Parameters
$mkey :

IPS archive ID.

$pcap_no : = null

Packet capture roll number (required when log device is 'disk')

$pcap_category : = null

Packet capture category (required when log device is 'disk')

Tags
route

GET /log/ips-archive/download

Return values
stdClass —

Return the firewall's response as an object.

getAllLogLocalReportDownload()

Download local report Access Group: loggrp.data-access

public getAllLogLocalReportDownload( $mkey) : stdClass
Parameters
$mkey :

Local Report Name.

Tags
route

GET /log/local-report/download

Return values
stdClass —

Return the firewall's response as an object.

getAllLogLocalReportList()

Get local reports list.

public getAllLogLocalReportList() : stdClass

Access Group: loggrp.report-access

Tags
route

GET /log/local-report-list

Return values
stdClass —

Return the firewall's response as an object.

getAllLogPolicyArchiveDownload()

Download policy-based packet capture archive.

public getAllLogPolicyArchiveDownload( $mkey,  $srcip,  $dstip) : stdClass

Access Group: loggrp.data-access

Parameters
$mkey :

Session ID (from traffic log).

$srcip :

Source IP.

$dstip :

Destination IP.

Tags
route

GET /log/policy-archive/download

Return values
stdClass —

Return the firewall's response as an object.

getAllLogStats()

Return number of logs sent by category per day for a specific log device.

public getAllLogStats([ $dev = null ]) : stdClass

Access Group: loggrp.data-access

Parameters
$dev : = null

Log device [*memory | disk | fortianalyzer | forticloud].

Tags
route

GET /log/stats

Return values
stdClass —

Return the firewall's response as an object.

getAllNetworkArp()

Get IPv4 ARP table.

public getAllNetworkArp() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /network/arp

Return values
stdClass —

Return the firewall's response as an object.

getAllNetworkDdnsLookup()

Check DDNS FQDN availability.

public getAllNetworkDdnsLookup( $domain) : stdClass

Access Group: sysgrp.cfg

Parameters
$domain :

Filter: domain to check.

Tags
route

GET /network/ddns/lookup

Return values
stdClass —

Return the firewall's response as an object.

getAllNetworkDdnsServers()

Get DDNS servers.

public getAllNetworkDdnsServers() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /network/ddns/servers

Return values
stdClass —

Return the firewall's response as an object.

getAllNetworkDnsLatency()

Get DNS latency.

public getAllNetworkDnsLatency() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /network/dns/latency

Return values
stdClass —

Return the firewall's response as an object.

getAllNetworkFortiguardLiveServicesLatency()

Get latency information for live FortiGuard services.

public getAllNetworkFortiguardLiveServicesLatency() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /network/fortiguard/live-services-latency

Return values
stdClass —

Return the firewall's response as an object.

getAllNetworkLldpNeighbors()

List all active LLDP neighbors.

public getAllNetworkLldpNeighbors() : stdClass

Access Group: netgrp

Tags
route

GET /network/lldp/neighbors

Return values
stdClass —

Return the firewall's response as an object.

getAllNetworkLldpPorts()

List all active LLDP ports.

public getAllNetworkLldpPorts([ $mkey = null ]) : stdClass

Access Group: netgrp

Parameters
$mkey : = null

Filter: specific port name.

Tags
route

GET /network/lldp/ports

Return values
stdClass —

Return the firewall's response as an object.

getAllNetworkReverseIpLookup()

Retrieve the resolved DNS domain name for a given IP address.

public getAllNetworkReverseIpLookup( $ip) : stdClass

Access Group: any

Parameters
$ip :

IP address (in dot-decimal notation).

Tags
route

GET /network/reverse-ip-lookup

Return values
stdClass —

Return the firewall's response as an object.

getAllNsxInstance()

List NSX instances and their resource statistics.

public getAllNsxInstance([ $mkey = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$mkey : = null

Filter: NSX SDN name.

Tags
route

GET /nsx/instance

Return values
stdClass —

Return the firewall's response as an object.

getAllNsxServiceStatus()

Retrieve NSX service status.

public getAllNsxServiceStatus([ $mkey = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$mkey : = null

Filter: NSX SDN name.

Tags
route

GET /nsx/service/status

Return values
stdClass —

Return the firewall's response as an object.

getAllRegistrationForticloudDeviceStatus()

Fetch device registration status from FortiCloud. Currently FortiSwitch and FortiAP are supported.

public getAllRegistrationForticloudDeviceStatus( $serials[,  $update_cache = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$serials :

Serials of FortiSwitch and FortiAP to fetch registration status.

$update_cache : = null

Clear cache and retrieve updated data.

Tags
route

GET /registration/forticloud/device-status

Return values
stdClass —

Return the firewall's response as an object.

getAllRegistrationForticloudDisclaimer()

Retrieve the FortiCloud disclaimer.

public getAllRegistrationForticloudDisclaimer() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /registration/forticloud/disclaimer

Return values
stdClass —

Return the firewall's response as an object.

getAllRegistrationForticloudDomains()

Retrieve a list of FortiCloud login domains.

public getAllRegistrationForticloudDomains() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /registration/forticloud/domains

Return values
stdClass —

Return the firewall's response as an object.

getAllRouterIpv4()

List all active IPv4 routing table entries.

public getAllRouterIpv4([ $start = null ][,  $count = null ][,  $ip_mask = null ][,  $gateway = null ][,  $type = null ][,  $interface = null ]) : stdClass

Access Group: netgrp.route-cfg

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return (Default for all routes).

$ip_mask : = null

Filter: IP/netmask.

$gateway : = null

Filter: gateway.

$type : = null

Filter: route type.

$interface : = null

Filter: interface name.

Tags
route

GET /router/ipv4

Return values
stdClass —

Return the firewall's response as an object.

getAllRouterIpv6()

List all active IPv6 routing table entries.

public getAllRouterIpv6([ $start = null ][,  $count = null ][,  $ip_mask = null ][,  $gateway = null ][,  $type = null ][,  $interface = null ]) : stdClass

Access Group: netgrp.route-cfg

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return (Default for all routes).

$ip_mask : = null

Filter: IP/netmask.

$gateway : = null

Filter: gateway.

$type : = null

Filter: route type.

$interface : = null

Filter: interface name.

Tags
route

GET /router/ipv6

Return values
stdClass —

Return the firewall's response as an object.

getAllRouterLookup()

Performs a route lookup by querying the routing table.

public getAllRouterLookup([ $ipv6 = null ],  $destination) : stdClass

Access Group: netgrp.route-cfg

Parameters
$ipv6 : = null

Perform an IPv6 lookup.

$destination :

Destination IP/FQDN.

Tags
route

GET /router/lookup

Return values
stdClass —

Return the firewall's response as an object.

getAllRouterLookupPolicy()

Performs a route lookup by querying the policy routing table.

public getAllRouterLookupPolicy([ $ipv6 = null ],  $destination[,  $source = null ][,  $destination_port = null ][,  $interface_name = null ][,  $protocol_number = null ]) : stdClass

Access Group: netgrp.route-cfg

Parameters
$ipv6 : = null

Perform an IPv6 lookup.

$destination :

Destination IP/FQDN.

$source : = null

Source IP/FQDN.

$destination_port : = null

Destination Port.

$interface_name : = null

Incoming Interface.

$protocol_number : = null

IP Protocol Number.

Tags
route

GET /router/lookup-policy

Return values
stdClass —

Return the firewall's response as an object.

getAllRouterPolicy()

Retrieve a list of active IPv4 policy routes.

public getAllRouterPolicy([ $start = null ][,  $count = null ][,  $count_only = null ]) : stdClass

Access Group: netgrp.route-cfg

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

$count_only : = null

Returns the number of IPv4 policy routes only.

Tags
route

GET /router/policy

Return values
stdClass —

Return the firewall's response as an object.

getAllRouterPolicy6()

Retrieve a list of active IPv6 policy routes.

public getAllRouterPolicy6([ $start = null ][,  $count = null ][,  $count_only = null ]) : stdClass

Access Group: netgrp.route-cfg

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

$count_only : = null

Returns the number of IPv6 policy routes only.

Tags
route

GET /router/policy6

Return values
stdClass —

Return the firewall's response as an object.

getAllRouterStatistics()

Retrieve routing table statistics, including number of matched routes.

public getAllRouterStatistics([ $ip_version = null ][,  $ip_mask = null ][,  $gateway = null ][,  $type = null ][,  $interface = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$ip_version : = null

IP version (4|6). If not present, IPv4 and IPv6 will be returned.

$ip_mask : = null

Filter: IP/netmask.

$gateway : = null

Filter: gateway.

$type : = null

Filter: route type.

$interface : = null

Filter: interface name.

Tags
route

GET /router/statistics

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerDetectedDevice()

Retrieve a list of devices detected on all switches.

public getAllSwitchControllerDetectedDevice() : stdClass

Access Group: wifi

Tags
route

GET /switch-controller/detected-device

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerFswFirmware()

Retrieve a list of recommended firmware for managed FortiSwitches.

public getAllSwitchControllerFswFirmware([ $mkey = null ][,  $timeout = null ]) : stdClass

Access Group: wifi

Parameters
$mkey : = null

Filter: FortiSwitch ID.

$timeout : = null

FortiGuard connection timeout (defaults to 3 seconds).

Tags
route

GET /switch-controller/fsw-firmware

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerManagedSwitch()

Retrieve statistics for configured FortiSwitches Access Group: wifi

public getAllSwitchControllerManagedSwitch([ $mkey = null ][,  $fsw_id = null ][,  $poe = null ][,  $port_stats = null ][,  $qos_stats = null ][,  $stp_status = null ][,  $igmp_snooping_group = null ][,  $transceiver = null ]) : stdClass
Parameters
$mkey : = null

Filter: FortiSwitch ID.

$fsw_id : = null

Filter: FortiSwitch ID. mkey should be used instead.

$poe : = null

Filter: Retrieve PoE statistics for ports of configured FortiSwitches. Port power usage is in Watt units.

$port_stats : = null

Filter: Retrieve tx/rx statistics for ports of configured FortiSwitches.

$qos_stats : = null

Filter: Retrieve QoS statistics for ports of configured FortiSwitches.

$stp_status : = null

Filter: Retrieve STP status for ports of configured FortiSwitches.

$igmp_snooping_group : = null

Filter: Retrieve IGMP Snooping group for configured FortiSwitches.

$transceiver : = null

Filter: Retrieve transceiver information for ports of configured FortiSwitches.

Tags
route

GET /switch-controller/managed-switch

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerManagedSwitchCableStatus()

Diagnose cable information for a port. Virtual FortiSwitches and FortiLink ports are not supported.

public getAllSwitchControllerManagedSwitchCableStatus( $mkey,  $port) : stdClass

Access Group: wifi

Parameters
$mkey :

Name of managed FortiSwitch.

$port :

Name of managed FortiSwitch port.

Tags
route

GET /switch-controller/managed-switch/cable-status

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerManagedSwitchDhcpSnooping()

Retrieve DHCP servers monitored by FortiSwitches.

public getAllSwitchControllerManagedSwitchDhcpSnooping() : stdClass

Access Group: wifi

Tags
route

GET /switch-controller/managed-switch/dhcp-snooping

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerManagedSwitchFaceplateXml()

Retrieve XML for rendering FortiSwitch faceplate widget.

public getAllSwitchControllerManagedSwitchFaceplateXml([ $mkey = null ]) : stdClass

Access Group: wifi

Parameters
$mkey : = null

Name of managed FortiSwitch.

Tags
route

GET /switch-controller/managed-switch/faceplate-xml

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerManagedSwitchHealth()

Retrieve health-check statistics for managed FortiSwitches.

public getAllSwitchControllerManagedSwitchHealth([ $mkey = null ]) : stdClass

Access Group: wifi

Parameters
$mkey : = null

Filter: FortiSwitch ID.

Tags
route

GET /switch-controller/managed-switch/health

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerManagedSwitchTransceivers()

Get a list of transceivers being used by managed FortiSwitches.

public getAllSwitchControllerManagedSwitchTransceivers() : stdClass

Access Group: any

Tags
route

GET /switch-controller/managed-switch/transceivers

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerMclagIclEligiblePeer()

Find a pair of FortiSwitches that are eligible to form a tier-1 MCLAG.

public getAllSwitchControllerMclagIclEligiblePeer( $fortilink) : stdClass

Access Group: wifi

Parameters
$fortilink :

FortiLink interface name.

Tags
route

GET /switch-controller/mclag-icl/eligible-peer

Return values
stdClass —

Return the firewall's response as an object.

getAllSwitchControllerValidateSwitchPrefix()

Validate a FortiSwitch serial number prefix.

public getAllSwitchControllerValidateSwitchPrefix([ $prefix = null ]) : stdClass

Access Group: wifi

Parameters
$prefix : = null

Prefix of FortiSwitch serial number.

Tags
route

GET /switch-controller/validate-switch-prefix

Return values
stdClass —

Return the firewall's response as an object.

getAllSystem3gModem()

List all 3G modems available via FortiGuard.

public getAllSystem3gModem() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/3g-modem

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemAcquiredDns()

Retrieve a list of interfaces and their acquired DNS servers.

public getAllSystemAcquiredDns() : stdClass

Access Group: any

Tags
route

GET /system/acquired-dns

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemAutomationStitchStats()

Stats for automation stitches.

public getAllSystemAutomationStitchStats([ $mkey = null ]) : stdClass

Access Group: secfabgrp

Parameters
$mkey : = null

Filter: Automation stitch name.

Tags
route

GET /system/automation-stitch/stats

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemAvailableCertificates()

Get available certificates.

public getAllSystemAvailableCertificates([ $scope = null ][,  $with_remote = null ][,  $with_ca = null ][,  $with_crl = null ]) : stdClass

Access Group: any

Parameters
$scope : = null

Scope of certificate [vdom*|global].

$with_remote : = null

Include remote certificates.

$with_ca : = null

Include certificate authorities.

$with_crl : = null

Include certificate revocation lists.

Tags
route

GET /system/available-certificates

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemAvailableInterfaces()

Retrieve a list of all interfaces along with some meta information regarding their availability.

public getAllSystemAvailableInterfaces([ $view_type = null ][,  $scope = null ]) : stdClass

Access Group: any

Parameters
$view_type : = null

Optionally include additional information for interfaces. This parameter can be repeated multiple times. 'poe': Includes PoE information for supported ports (DEPRECATED in 6.4). 'ha': Includes extra meta information useful when dealing with interfaces related to HA configuration. Interfaces that are used by an HA cluster as management interfaces are also included in this view. 'zone': Includes extra meta information for determining zone membership eligibility. 'vwp': Includes extra meta information for determining virtual wire pair eligibility. 'sdwan': Includes extra meta information for determining SD-WAN eligibility. 'switch': Includes extra meta information for determining switch eligibility. 'hard-switch': Includes extra meta information for determining hard-switch eligibility. 'limited': Includes limited information on parent interfaces that are in another VDOM. 'stat': Includes TX/RX statistics data.

$scope : = null

Scope of interface list [vdom|global]

Tags
route

GET /system/available-interfaces

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemBotnet()

List all known IP-based botnet entries in FortiGuard botnet database.

public getAllSystemBotnet([ $start = null ][,  $count = null ][,  $include_hit_only = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

$include_hit_only : = null

Include entries with hits only.

Tags
route

GET /system/botnet

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemBotnetDomains()

List all known domain-based botnet entries in FortiGuard botnet database.

public getAllSystemBotnetDomains([ $start = null ][,  $count = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

Tags
route

GET /system/botnet-domains

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemBotnetDomainsHits()

List hit botnet domains with hit count > 0.

public getAllSystemBotnetDomainsHits() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/botnet-domains/hits

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemBotnetDomainsStat()

List statistics on domain-based botnet entries in FortiGuard botnet database.

public getAllSystemBotnetDomainsStat() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/botnet-domains/stat

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemBotnetStat()

Retrieve statistics for FortiGuard botnet database.

public getAllSystemBotnetStat() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/botnet/stat

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemCertificateDownload()

Download certificate.

public getAllSystemCertificateDownload( $mkey,  $type[,  $scope = null ]) : stdClass

Access Group: vpngrp

Parameters
$mkey :

Name of certificate.

$type :

Type of certificate [local-cer|remote-cer|local-ca|remote-ca|local-csr|crl].

$scope : = null

Scope of certificate [vdom*|global].

Tags
route

GET /system/certificate/download

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemCheckPortAvailability()

Check whether a list of TCP port ranges is available for a certain service.

public getAllSystemCheckPortAvailability( $port_ranges[,  $service = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$port_ranges :

List of TCP port range objects to check against.

$service : = null

The service in which the ports could be available. 'service' options are [reserved | sysglobal | webproxy | ftpproxy | sslvpn | slaprobe | fsso | ftm_push]. If 'service' is not specified, the port ranges availability is checked against all services.

Tags
route

GET /system/check-port-availability

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemComLogDownload()

Download com-log file (after file dump is complete).

public getAllSystemComLogDownload() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/com-log/download

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemComLogUpdate()

Fetch system com-log file dump progress.

public getAllSystemComLogUpdate() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/com-log/update

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemConfigBackup()

Backup system config Access Group: sysgrp.mnt

public getAllSystemConfigBackup([ $destination = null ][,  $usb_filename = null ][,  $password = null ],  $scope[,  $vdom = null ]) : stdClass
Parameters
$destination : = null

Configuration file destination [file* | usb]

$usb_filename : = null

When using 'usb' destination: the filename to save to on the connected USB device

$password : = null

Password to encrypt configuration data.

$scope :

Specify global or VDOM only backup [global | vdom].

$vdom : = null

If 'vdom' scope specified, the name of the VDOM to backup configuration.

Tags
route

GET /system/config/backup

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemConfigErrorLogDownload()

Download the error log of the configuration management database.

public getAllSystemConfigErrorLogDownload() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/config-error-log/download

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemConfigRevision()

Returns a list of system configuration revisions.

public getAllSystemConfigRevision() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/config-revision

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemConfigRevisionFile()

Download a specific configuration revision.

public getAllSystemConfigRevisionFile([ $config_id = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$config_id : = null

Configuration id.

Tags
route

GET /system/config-revision/file

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemConfigRevisionInfo()

Retrieve meta information for a specific configuration revision.

public getAllSystemConfigRevisionInfo([ $config_id = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$config_id : = null

Configuration id.

Tags
route

GET /system/config-revision/info

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemConfigScript()

Retrieve the information about config scripts.

public getAllSystemConfigScript() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/config-script

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemConfigSyncStatus()

Get configuration sync status of SLBC cluster master and slave.

public getAllSystemConfigSyncStatus() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/config-sync/status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemConfigUsbFilelist()

List configuration files available on connected USB drive.

public getAllSystemConfigUsbFilelist() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/config/usb-filelist

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemCsf()

Retrieve a full tree of downstream FortiGates registered to the Security Fabric.

public getAllSystemCsf([ $scope = null ]) : stdClass

Access Group: secfabgrp

Parameters
$scope : = null

Scope from which to retrieve the Security Fabric tree [vdom*|global].

Tags
route

GET /system/csf

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemCsfPendingAuthorizations()

Retrieve fabric devices with pending authorizations for joining the Security Fabric. Note:- This list is currently available on Security Fabric root only.

public getAllSystemCsfPendingAuthorizations() : stdClass

Access Group: secfabgrp

Tags
route

GET /system/csf/pending-authorizations

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemCurrentAdmins()

Return a list of currently logged in administrators.

public getAllSystemCurrentAdmins() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/current-admins

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemDebugDownload()

Download debug report for technical support.

public getAllSystemDebugDownload() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/debug/download

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemDhcp()

List all DHCP and DHCPv6 leases.

public getAllSystemDhcp([ $scope = null ][,  $ipv6 = null ][,  $interface = null ]) : stdClass

Access Group: netgrp.cfg

Parameters
$scope : = null

Scope from which to retrieve DHCP leases [vdom*|global]. Global scope is only accessible for global administrators.

$ipv6 : = null

Include IPv6 addresses in the response.

$interface : = null

Filter: Retrieve DHCP leases for this interface only.

Tags
route

GET /system/dhcp

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemFirmware()

Retrieve a list of firmware images available to use for upgrade on this device.

public getAllSystemFirmware() : stdClass

Access Group: sysgrp.mnt

Tags
route

GET /system/firmware

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemFirmwareUpgradePaths()

Retrieve a list of supported firmware upgrade paths.

public getAllSystemFirmwareUpgradePaths() : stdClass

Access Group: sysgrp.mnt

Tags
route

GET /system/firmware/upgrade-paths

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemFortiguardServerInfo()

Get FortiGuard server list and information.

public getAllSystemFortiguardServerInfo() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/fortiguard/server-info

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemFortimanagerBackupDetails()

Get the properties of a FortiManager object.

public getAllSystemFortimanagerBackupDetails( $mkey,  $datasource) : stdClass

Access Group: fwgrp

Parameters
$mkey :

Object name.

$datasource :

Object datasource.

Tags
route

GET /system/fortimanager/backup-details

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemFortimanagerBackupSummary()

Get FortiManager backup summary.

public getAllSystemFortimanagerBackupSummary() : stdClass

Access Group: fwgrp

Tags
route

GET /system/fortimanager/backup-summary

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemFortimanagerStatus()

Get FortiManager status.

public getAllSystemFortimanagerStatus() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/fortimanager/status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemGlobalResources()

Retrieve current usage of global resources as well as both the default and user configured maximum values.

public getAllSystemGlobalResources() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/global-resources

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemHaChecksums()

List of checksums for members of HA cluster.

public getAllSystemHaChecksums() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/ha-checksums

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemHaHistory()

Get HA cluster historical logs.

public getAllSystemHaHistory() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/ha-history

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemHaPeer()

Get configuration of peer(s) in HA cluster. Uptime is expressed in seconds.

public getAllSystemHaPeer([ $serial_no = null ][,  $vcluster_id = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$serial_no : = null

Serial number of the HA member. If not specified, fetch information for all HA members

$vcluster_id : = null

Virtual cluster number. If not specified, fetch information for all active vclusters

Tags
route

GET /system/ha-peer

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemHaStatistics()

List of statistics for members of HA cluster.

public getAllSystemHaStatistics() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/ha-statistics

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemInterface()

Retrieve statistics for all system interfaces.

public getAllSystemInterface([ $interface_name = null ][,  $include_vlan = null ][,  $include_aggregate = null ][,  $scope = null ]) : stdClass

Access Group: netgrp.cfg

Parameters
$interface_name : = null

Filter: interface name.

$include_vlan : = null

Enable to include VLANs in result list.

$include_aggregate : = null

Enable to include Aggregate interfaces in result list.

$scope : = null

Scope from which to retrieve the interface stats from [vdom|global].

Tags
route

GET /system/interface

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemInterfaceConnectedAdminsInfo()

Return admins info that are connected to current interface.

public getAllSystemInterfaceConnectedAdminsInfo( $interface) : stdClass

Access Group: netgrp.cfg

Parameters
$interface :

Interface that admins is connected through.

Tags
route

GET /system/interface-connected-admins-info

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemInterfaceDhcpStatus()

Retrieve the DHCP client status of an interface.

public getAllSystemInterfaceDhcpStatus( $mkey) : stdClass

Access Group: netgrp.cfg

Parameters
$mkey :

Name of the interface.

Tags
route

GET /system/interface/dhcp-status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemInterfacePoe()

Retrieve PoE statistics for system interfaces.

public getAllSystemInterfacePoe([ $mkey = null ][,  $scope = null ]) : stdClass

Access Group: netgrp.cfg

Parameters
$mkey : = null

Filter: Name of the interface to fetch PoE statistics for.

$scope : = null

Scope from which to retrieve the interface stats from [vdom|global] (default=vdom).

Tags
route

GET /system/interface/poe

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemInterfaceSpeedTestStatus()

Retrieve the current status of a speed-test with the results if finished.

public getAllSystemInterfaceSpeedTestStatus( $id) : stdClass

Access Group: netgrp.cfg

Parameters
$id :

ID of the speed test.

Tags
route

GET /system/interface/speed-test-status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemInterfaceTransceivers()

Get a list of transceivers being used by the FortiGate.

public getAllSystemInterfaceTransceivers([ $scope = null ]) : stdClass

Access Group: any

Parameters
$scope : = null

Scope from which to retrieve the transceiver information from [vdom|global].

Tags
route

GET /system/interface/transceivers

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemIpconf()

Determine if there is an IP conflict for a specific IP using ARP.

public getAllSystemIpconf( $devs,  $ipaddr) : stdClass

Access Group: netgrp.cfg

Parameters
$devs :

List of interfaces to check for conflict.

$ipaddr :

IPv4 address to check for conflict.

Tags
route

GET /system/ipconf

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemLinkMonitor()

Retrieve per-interface statistics for active link monitors.

public getAllSystemLinkMonitor([ $mkey = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$mkey : = null

Name of link monitor.

Tags
route

GET /system/link-monitor

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemModem()

Retrieve statistics for internal/external configured modem.

public getAllSystemModem() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/modem

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemNat46Ippools()

Retrieve a list of all IPv6 IP pools that are valid for NAT 46 policies.

public getAllSystemNat46Ippools() : stdClass

Access Group: any

Tags
route

GET /system/nat46-ippools

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemNtpStatus()

List NTP servers status.

public getAllSystemNtpStatus() : stdClass

Access Group: netgrp.cfg

Tags
route

GET /system/ntp/status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemObjectUsage()

Retrieve all objects that are currently using as well as objects that can use the given object.

public getAllSystemObjectUsage([ $q_path = null ][,  $q_name = null ][,  $qtypes = null ][,  $scope = null ],  $mkey) : stdClass

Access Group: any

Parameters
$q_path : = null

The CMDB table's path

$q_name : = null

The CMDB table's name

$qtypes : = null

List of CMDB table qTypes

$scope : = null

Scope of resource [vdom|global].

$mkey :

The mkey for the object

Tags
route

GET /system/object/usage

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemResolveFqdn()

Resolves the provided FQDNs to FQDN -> IP mappings.

public getAllSystemResolveFqdn([ $ipv6 = null ][,  $fqdn = null ]) : stdClass

Access Group: any

Parameters
$ipv6 : = null

Resolve for the AAAA record?

$fqdn : = null

List of FQDNs to be resolved

Tags
route

GET /system/resolve-fqdn

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemResourceUsage()

Retreive current and historical usage data for a provided resource.

public getAllSystemResourceUsage([ $scope = null ][,  $resource = null ][,  $interval = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$scope : = null

Scope of resource [vdom|global]. This parameter is only applicable if the FGT is in VDOM mode.

$resource : = null

Resource to get usage data for [cpu|mem|disk|session|session6|setuprate|setuprate6|disk_lograte|faz_lograte|forticloud_lograte]. Defaults to all resources if not provided. Additionally, [npu_session|npu_session6] data is available for devices that have an NPU and [nturbo_session|nturbo_session6] data is available for NP6 devices that support NTurbo.

$interval : = null

Time interval of resource usage [1-min|10-min|30-min|1-hour|12-hour|24-hour]. Defaults to all intervals if not provided.

Tags
route

GET /system/resource/usage

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemRunningProcesses()

List of running processes and their resource usage.

public getAllSystemRunningProcesses() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/running-processes

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSandboxCloudRegions()

Retrieve a list of FortiSandbox cloud regions.

public getAllSystemSandboxCloudRegions() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/sandbox/cloud-regions

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSandboxStats()

Retrieve sandbox statistics.

public getAllSystemSandboxStats() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/sandbox/stats

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSandboxStatus()

Retrieve sandbox status.

public getAllSystemSandboxStatus() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/sandbox/status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSandboxTestConnect()

Test the connectivity of a given FortiSandbox IP.

public getAllSystemSandboxTestConnect( $server) : stdClass

Access Group: sysgrp.cfg

Parameters
$server :

IP/FQDN of the FortiSandbox to test.

Tags
route

GET /system/sandbox/test-connect

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSdnConnectorNsxSecurityTags()

Retrieve a list of NSX security tags for connected NSX servers.

public getAllSystemSdnConnectorNsxSecurityTags([ $mkey = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$mkey : = null

Filter: NSX SDN connector name.

Tags
route

GET /system/sdn-connector/nsx-security-tags

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSdnConnectorStatus()

Retrieve connection status for SDN connectors.

public getAllSystemSdnConnectorStatus([ $mkey = null ][,  $type = null ]) : stdClass

Access Group: sysgrp.cfg

Parameters
$mkey : = null

Filter: SDN connector name.

$type : = null

Filter: SDN connector type. Ignored if mkey is specified.

Tags
route

GET /system/sdn-connector/status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSecurityRating()

Retrieve a Security Rating report result. Without ID specified, returns the most recent result.

public getAllSystemSecurityRating([ $id = null ][,  $report_type = null ][,  $scope = null ]) : stdClass

Access Group: secfabgrp

Parameters
$id : = null

Report ID.

$report_type : = null

Report type to view, Security Report when unspecified.

$scope : = null

Scope of the report [vdom*|global]. Global scope is only accessible for global administrators.

Tags
route

GET /system/security-rating

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSecurityRatingHistory()

Retrieve Security Rating history.

public getAllSystemSecurityRatingHistory([ $report_type = null ]) : stdClass

Access Group: secfabgrp

Parameters
$report_type : = null

Security Rating report history to view, view Security Report when unspecified.

Tags
route

GET /system/security-rating/history

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSecurityRatingLang()

Returns the requested Security Rating language mapping.

public getAllSystemSecurityRatingLang([ $key = null ]) : stdClass

Access Group: secfabgrp

Parameters
$key : = null

Requested language mapping (en, fr, big5, euc-kr, GB2312, pg, sp, x-sjis).

Tags
route

GET /system/security-rating/lang

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSecurityRatingStatus()

Check if a Security Rating report is currently running.

public getAllSystemSecurityRatingStatus([ $id = null ][,  $report_type = null ][,  $progress = null ]) : stdClass

Access Group: secfabgrp

Parameters
$id : = null

Report ID.

$report_type : = null

Report type to view, Security Report when unspecified.

$progress : = null

Query report progress.

Tags
route

GET /system/security-rating/status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSecurityRatingSupportedReports()

Retrieve list of report types the Security Rating package supports.

public getAllSystemSecurityRatingSupportedReports() : stdClass

Access Group: secfabgrp

Tags
route

GET /system/security-rating/supported-reports

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSensorInfo()

Retrieve system sensor status.

public getAllSystemSensorInfo() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/sensor-info

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSniffer()

Return a list of all configured packet captures.

public getAllSystemSniffer() : stdClass

Access Group: netgrp.packet-capture

Tags
route

GET /system/sniffer

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemSnifferDownload()

Download a stored packet capture.

public getAllSystemSnifferDownload( $mkey) : stdClass

Access Group: netgrp.packet-capture

Parameters
$mkey :

ID of packet capture entry.

Tags
route

GET /system/sniffer/download

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemStatus()

Retrieve basic system status.

public getAllSystemStatus() : stdClass

Access Group: any

Tags
route

GET /system/status

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemStorage()

Retrieve information for the non-boot disk.

public getAllSystemStorage() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/storage

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemTime()

Gets current system time stamp.

public getAllSystemTime() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/time

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemTimezone()

Get world timezone and daylight saving time.

public getAllSystemTimezone() : stdClass

Access Group: any

Tags
route

GET /system/timezone

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemTrustedCertAuthorities()

Get trusted certifiate authorities.

public getAllSystemTrustedCertAuthorities([ $scope = null ]) : stdClass

Access Group: any

Parameters
$scope : = null

Scope of certificate [vdom*|global].

Tags
route

GET /system/trusted-cert-authorities

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemUsbLog()

Retrieve information about connected USB drives, including estimated log sizes.

public getAllSystemUsbLog() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/usb-log

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemVdomLink()

Gets a list of all NPU VDOM Links and VDOM Links.

public getAllSystemVdomLink([ $scope = null ]) : stdClass

Access Group: netgrp.cfg

Parameters
$scope : = null

Scope from which to retrieve the VDOM link informaton from [vdom|global].

Tags
route

GET /system/vdom-link

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemVdomResource()

Retrieve VDOM resource information, including CPU and memory usage.

public getAllSystemVdomResource() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/vdom-resource

Return values
stdClass —

Return the firewall's response as an object.

getAllSystemVmInformation()

Get VM information.

public getAllSystemVmInformation() : stdClass

Access Group: sysgrp.cfg

Tags
route

GET /system/vm-information

Return values
stdClass —

Return the firewall's response as an object.

getAllUserBanned()

Return a list of all banned users by IP.

public getAllUserBanned() : stdClass

Access Group: authgrp

Tags
route

GET /user/banned

Return values
stdClass —

Return the firewall's response as an object.

getAllUserCollectedEmail()

List email addresses collected from captive portal.

public getAllUserCollectedEmail([ $ipv6 = null ]) : stdClass

Access Group: authgrp

Parameters
$ipv6 : = null

Include collected email from IPv6 users.

Tags
route

GET /user/collected-email

Return values
stdClass —

Return the firewall's response as an object.

getAllUserDetectedDevice()

Retrieve a list of detected devices.

public getAllUserDetectedDevice([ $expand_child_macs = null ][,  $with_dhcp = null ][,  $with_endpoint = null ][,  $with_fortilink = null ][,  $with_fortiap = null ][,  $with_user = null ]) : stdClass

Access Group: authgrp

Parameters
$expand_child_macs : = null

Include child devices as separate entries in the list.

$with_dhcp : = null

Retrieve DHCP lease information.

$with_endpoint : = null

Retrieve FortiClient endpoint information.

$with_fortilink : = null

Retrieve FortiLink information.

$with_fortiap : = null

Retrieve FortiAP information.

$with_user : = null

Retrieve authenticated user information.

Tags
route

GET /user/detected-device

Return values
stdClass —

Return the firewall's response as an object.

getAllUserDevice()

Retrieve a list of detected devices.

public getAllUserDevice([ $master_only = null ][,  $master_mac = null ]) : stdClass

Access Group: authgrp

Parameters
$master_only : = null

List of master device only.

$master_mac : = null

Filter: Master MAC of a device. Multiple entries could be returned.

Tags
route

GET /user/device

Return values
stdClass —

Return the firewall's response as an object.

getAllUserDeviceQuery()

Retrieve user devices from user device store. List all the user devices if there is no filter set.

public getAllUserDeviceQuery([ $start = null ][,  $number = null ][,  $filters = null ]) : stdClass

Access Group: authgrp

Parameters
$start : = null

Number of entries to skip from the beginning.

$number : = null

Maximum number of entries to return.

$filters : = null

A map of filters. Type: {"key": "value"}

Tags
route

GET /user/device/query

Return values
stdClass —

Return the firewall's response as an object.

getAllUserFirewall()

List authenticated firewall users.

public getAllUserFirewall([ $start = null ][,  $count = null ][,  $ipv4 = null ][,  $ipv6 = null ]) : stdClass

Access Group: authgrp

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

$ipv4 : = null

Include IPv4 user (default=true).

$ipv6 : = null

Include IPv6 users.

Tags
route

GET /user/firewall

Return values
stdClass —

Return the firewall's response as an object.

getAllUserFortitoken()

Retrieve a map of FortiTokens and their status.

public getAllUserFortitoken() : stdClass

Access Group: authgrp

Tags
route

GET /user/fortitoken

Return values
stdClass —

Return the firewall's response as an object.

getAllUserFortitokenCloudStatus()

Retrieve FortiToken Cloud service status.

public getAllUserFortitokenCloudStatus() : stdClass

Access Group: authgrp

Tags
route

GET /user/fortitoken-cloud/status

Return values
stdClass —

Return the firewall's response as an object.

getAllUserFsso()

Get a list of fsso and fsso polling status.

public getAllUserFsso([ $mkey = null ][,  $type = null ]) : stdClass

Access Group: authgrp

Parameters
$mkey : = null

Filter: Get the status for a specific FSSO entry. type is required if this is set.

$type : = null

Filter: Get the status for this type of FSSO entry [fsso|fsso-polling].

Tags
route

GET /user/fsso

Return values
stdClass —

Return the firewall's response as an object.

getAllUserInfoQuery()

Query user info.

public getAllUserInfoQuery([ $start = null ][,  $number = null ],  $filters) : stdClass

Access Group: authgrp

Parameters
$start : = null

Number of entries to skip from the beginning.

$number : = null

Maximum number of entries to return.

$filters :

A list of filters. Type: {"type": string, "value": string}

Tags
route

GET /user/info/query

Return values
stdClass —

Return the firewall's response as an object.

getAllUserInfoThumbnail()

Get user info thumbnail. Returns the first match to the filter.

public getAllUserInfoThumbnail( $filters) : stdClass

Access Group: authgrp

Parameters
$filters :

A list of filters. Type: {"type": string, "value": string}

Tags
route

GET /user/info/thumbnail

Return values
stdClass —

Return the firewall's response as an object.

getAllUtmAntivirusStats()

Retrieve antivirus scanning statistics.

public getAllUtmAntivirusStats() : stdClass

Access Group: utmgrp.antivirus

Tags
route

GET /utm/antivirus/stats

Return values
stdClass —

Return the firewall's response as an object.

getAllUtmApplicationCategories()

Retrieve a list of application control categories.

public getAllUtmApplicationCategories() : stdClass

Access Group: any

Tags
route

GET /utm/application-categories

Return values
stdClass —

Return the firewall's response as an object.

getAllUtmAppLookup()

Query remote FortiFlow database to resolve hosts to application control entries.

public getAllUtmAppLookup([ $hosts = null ]) : stdClass

Access Group: any

Parameters
$hosts : = null

List of hosts to resolve.

Tags
route

GET /utm/app-lookup

Return values
stdClass —

Return the firewall's response as an object.

getAllUtmBlacklistedCertificates()

Retrieve a list of blacklisted SSL certificates.

public getAllUtmBlacklistedCertificates( $start,  $count) : stdClass

Access Group: fwgrp.others

Parameters
$start :

Starting entry index.

$count :

Maximum number of entries to return. Limit is set to 2000.

Tags
route

GET /utm/blacklisted-certificates

Return values
stdClass —

Return the firewall's response as an object.

getAllUtmBlacklistedCertificatesStatistics()

Retrieve blacklisted SSL certificates statistics.

public getAllUtmBlacklistedCertificatesStatistics() : stdClass

Access Group: fwgrp.others

Tags
route

GET /utm/blacklisted-certificates/statistics

Return values
stdClass —

Return the firewall's response as an object.

getAllVirtualWanHealthCheck()

Retrieve health-check statistics for each SD-WAN link.

public getAllVirtualWanHealthCheck() : stdClass

Access Group: netgrp.cfg

Tags
route

GET /virtual-wan/health-check

Return values
stdClass —

Return the firewall's response as an object.

getAllVirtualWanInterfaceLog()

Retrieve log of SD-WAN interface quality information.

public getAllVirtualWanInterfaceLog([ $interface = null ][,  $since = null ][,  $seconds = null ]) : stdClass

Access Group: netgrp.cfg

Parameters
$interface : = null

Filter: Interface name.

$since : = null

Filter: Only return SLA logs generated since this Unix timestamp.

$seconds : = null

Filter: Only return SLA logs generated in the last N seconds.

Tags
route

GET /virtual-wan/interface-log

Return values
stdClass —

Return the firewall's response as an object.

getAllVirtualWanMembers()

Retrieve interface statistics for each SD-WAN link.

public getAllVirtualWanMembers() : stdClass

Access Group: netgrp.cfg

Tags
route

GET /virtual-wan/members

Return values
stdClass —

Return the firewall's response as an object.

getAllVirtualWanSlaLog()

Retrieve log of SLA probe results for for each SD-WAN SLA rule.

public getAllVirtualWanSlaLog([ $sla = null ][,  $interface = null ][,  $since = null ][,  $seconds = null ]) : stdClass

Access Group: netgrp.cfg

Parameters
$sla : = null

Filter: SLA name.

$interface : = null

Filter: Interface name.

$since : = null

Filter: Only return SLA logs generated since this Unix timestamp.

$seconds : = null

Filter: Only return SLA logs generated in the last N seconds.

Tags
route

GET /virtual-wan/sla-log

Return values
stdClass —

Return the firewall's response as an object.

getAllVpnIpsec()

Return an array of active IPsec VPNs.

public getAllVpnIpsec([ $tunnel = null ][,  $start = null ][,  $count = null ]) : stdClass

Access Group: vpngrp

Parameters
$tunnel : = null

Filter for a specific IPsec tunnel name.

$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

Tags
route

GET /vpn/ipsec

Return values
stdClass —

Return the firewall's response as an object.

getAllVpnOcvpnMembers()

Get information on devices registered in the Overlay Controller VPN cloud assisted group.

public getAllVpnOcvpnMembers() : stdClass

Access Group: vpngrp

Tags
route

GET /vpn/ocvpn/members

Return values
stdClass —

Return the firewall's response as an object.

getAllVpnOcvpnMeta()

Get meta information (e.g. licenses and registered members) from Overlay Controller VPN cloud service.

public getAllVpnOcvpnMeta() : stdClass

Access Group: vpngrp

Tags
route

GET /vpn/ocvpn/meta

Return values
stdClass —

Return the firewall's response as an object.

getAllVpnOcvpnStatus()

Get the last status message from FortiCloud Overlay Controller VPN cloud service.

public getAllVpnOcvpnStatus() : stdClass

Access Group: vpngrp

Tags
route

GET /vpn/ocvpn/status

Return values
stdClass —

Return the firewall's response as an object.

getAllVpnSsl()

Retrieve a list of all SSL-VPN sessions and sub-sessions.

public getAllVpnSsl() : stdClass

Access Group: vpngrp

Tags
route

GET /vpn/ssl

Return values
stdClass —

Return the firewall's response as an object.

getAllVpnSslStats()

Return statistics about the SSL-VPN.

public getAllVpnSslStats() : stdClass

Access Group: vpngrp

Tags
route

GET /vpn/ssl/stats

Return values
stdClass —

Return the firewall's response as an object.

getAllWanoptHistory()

Retrieve WAN opt. statistics history.

public getAllWanoptHistory([ $period = null ]) : stdClass

Access Group: wanoptgrp

Parameters
$period : = null

Statistics period [10-min*|hour|day|week|30-day].

Tags
route

GET /wanopt/history

Return values
stdClass —

Return the firewall's response as an object.

getAllWanoptPeer_stats()

Retrieve a list of WAN opt peer statistics.

public getAllWanoptPeer_stats() : stdClass

Access Group: wanoptgrp

Tags
route

GET /wanopt/peer_stats

Return values
stdClass —

Return the firewall's response as an object.

getAllWanoptWebcache()

Retrieve webcache statistics history.

public getAllWanoptWebcache([ $period = null ]) : stdClass

Access Group: wanoptgrp

Parameters
$period : = null

Statistics period [10-min*|hour|day|week|30-day].

Tags
route

GET /wanopt/webcache

Return values
stdClass —

Return the firewall's response as an object.

getAllWebcacheStats()

Retrieve webcache statistics.

public getAllWebcacheStats([ $period = null ]) : stdClass

Access Group: wanoptgrp

Parameters
$period : = null

Statistics period [10min|hour|day|month].

Tags
route

GET /webcache/stats

Return values
stdClass —

Return the firewall's response as an object.

getAllWebfilterCategoryQuota()

Retrieve quota usage statistics for webfilter categories.

public getAllWebfilterCategoryQuota([ $profile = null ][,  $user = null ]) : stdClass

Access Group: utmgrp.webfilter

Parameters
$profile : = null

Webfilter profile.

$user : = null

User or IP (required if profile specified).

Tags
route

GET /webfilter/category-quota

Return values
stdClass —

Return the firewall's response as an object.

getAllWebfilterFortiguardCategories()

Return FortiGuard web filter categories.

public getAllWebfilterFortiguardCategories([ $include_unrated = null ][,  $convert_unrated_id = null ]) : stdClass

Access Group: any

Parameters
$include_unrated : = null

Include Unrated category in result list.

$convert_unrated_id : = null

Convert Unrated category id to the one for CLI use.

Tags
route

GET /webfilter/fortiguard-categories

Return values
stdClass —

Return the firewall's response as an object.

getAllWebfilterMaliciousUrls()

List all URLs in FortiSandbox malicious URL database.

public getAllWebfilterMaliciousUrls() : stdClass

Access Group: utmgrp.webfilter

Tags
route

GET /webfilter/malicious-urls

Return values
stdClass —

Return the firewall's response as an object.

getAllWebfilterMaliciousUrlsStat()

Retrieve statistics for the FortiSandbox malicious URL database.

public getAllWebfilterMaliciousUrlsStat() : stdClass

Access Group: utmgrp.webfilter

Tags
route

GET /webfilter/malicious-urls/stat

Return values
stdClass —

Return the firewall's response as an object.

getAllWebfilterOverride()

List all administrative and user initiated webfilter overrides.

public getAllWebfilterOverride() : stdClass

Access Group: utmgrp.webfilter

Tags
route

GET /webfilter/override

Return values
stdClass —

Return the firewall's response as an object.

getAllWebfilterTrustedUrls()

List all URLs in FortiGuard trusted URL database.

public getAllWebfilterTrustedUrls() : stdClass

Access Group: utmgrp.webfilter

Tags
route

GET /webfilter/trusted-urls

Return values
stdClass —

Return the firewall's response as an object.

getAllWebproxyPacfileDownload()

Download webproxy PAC file.

public getAllWebproxyPacfileDownload() : stdClass

Access Group: netgrp.cfg

Tags
route

GET /webproxy/pacfile/download

Return values
stdClass —

Return the firewall's response as an object.

getAllWebUiCustomLanguageDownload()

Download a custom language file.

public getAllWebUiCustomLanguageDownload( $filename) : stdClass

Access Group: sysgrp.mnt

Parameters
$filename :

Name of custom language entry.

Tags
route

GET /web-ui/custom-language/download

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiAp_status()

Retrieve statistics for all managed FortiAPs.

public getAllWifiAp_status() : stdClass

Access Group: wifi

Tags
route

GET /wifi/ap_status

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiClient()

Retrieve a list of connected WiFi clients.

public getAllWifiClient([ $start = null ][,  $count = null ][,  $type = null ]) : stdClass

Access Group: wifi

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

$type : = null

Request type [all*|fail-login].

Tags
route

GET /wifi/client

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiEuclid()

Retrieve presence analytics statistics.

public getAllWifiEuclid() : stdClass

Access Group: wifi

Tags
route

GET /wifi/euclid

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiFirmware()

Retrieve a list of current and recommended firmware for FortiAPs in use.

public getAllWifiFirmware([ $timeout = null ]) : stdClass

Access Group: wifi

Parameters
$timeout : = null

FortiGuard connection timeout (defaults to 2 seconds).

Tags
route

GET /wifi/firmware

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiInterfering_ap()

Retrieve a list of interfering APs for one FortiAP radio.

public getAllWifiInterfering_ap([ $wtp = null ][,  $radio = null ][,  $start = null ][,  $count = null ]) : stdClass

Access Group: wifi

Parameters
$wtp : = null

FortiAP ID to query.

$radio : = null

Radio ID.

$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

Tags
route

GET /wifi/interfering_ap

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiManaged_ap()

Retrieve a list of managed FortiAPs.

public getAllWifiManaged_ap([ $wtp_id = null ][,  $incl_local = null ]) : stdClass

Access Group: wifi

Parameters
$wtp_id : = null

Filter: single managed FortiAP by ID.

$incl_local : = null

Enable to include the local FortiWiFi device in the results.

Tags
route

GET /wifi/managed_ap

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiNetworkList()

When FortiWiFi is in client mode, retrieve list of local WiFi networks.

public getAllWifiNetworkList() : stdClass

Access Group: wifi

Tags
route

GET /wifi/network/list

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiNetworkStatus()

When FortiWiFi is in client mode, retrieve status of currently connected WiFi network, if any.

public getAllWifiNetworkStatus() : stdClass

Access Group: wifi

Tags
route

GET /wifi/network/status

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiRegionImage()

Retrieves a floorplan/region image from a configured FortiAP region.

public getAllWifiRegionImage( $region_name) : stdClass

Access Group: wifi

Parameters
$region_name :

Region name to retrieve image from.

Tags
route

GET /wifi/region-image

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiRogue_ap()

Retrieve a list of detected rogue APs.

public getAllWifiRogue_ap([ $start = null ][,  $count = null ]) : stdClass

Access Group: wifi

Parameters
$start : = null

Starting entry index.

$count : = null

Maximum number of entries to return.

Tags
route

GET /wifi/rogue_ap

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiSpectrum()

Retrieve spectrum analysis information for a specific FortiAP.

public getAllWifiSpectrum( $wtp_id) : stdClass

Access Group: wifi

Parameters
$wtp_id :

FortiAP ID to query.

Tags
route

GET /wifi/spectrum

Return values
stdClass —

Return the firewall's response as an object.

getAllWifiVlanProbe()

Retrieve the VLAN probe results.

public getAllWifiVlanProbe( $ap_interface,  $wtp) : stdClass

Access Group: wifi

Parameters
$ap_interface :

FortiAP interface to send the probe on.

$wtp :

FortiAP ID.

Tags
route

GET /wifi/vlan-probe

Return values
stdClass —

Return the firewall's response as an object.

listTransactions()

List all transactions.

public listTransactions([string $vdom = null ]) : bool
Parameters
$vdom : string = null
Return values
bool —

Return the firewall's response as an object. As of version 6.4.5, this method sometimes returns unparsable JSON.

startTransaction()

Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).

public startTransaction([int $timeout = null ][, string|null $vdom = null ]) : bool
Parameters
$timeout : int = null

Transaction's timeout.

$vdom : string|null = null

Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

Return values
bool —

Return TRUE on success and FALSE on failure.

curlRequest()

Method to request the firewall's API.

protected curlRequest(string $method, string $endpoint[, int|string $pathData = null ][, stdClass|array<string|int, mixed> $queryData = null ][, stdClass|array<string|int, mixed> $bodyData = null ][, int $timeout = null ]) : stdClass
Parameters
$method : string

HTTP method (e.g. 'GET', 'POST', 'PUT', 'DELETE' ...).

$endpoint : string

API endpoint without the 2 first element ('rest' and API version '/api/vX'), e.g. /cmdb/router/static.

$pathData : int|string = null

Data to be passed in the request path (only one).

$queryData : stdClass|array<string|int, mixed> = null

Data to be passed in the request query as GET arguments.

$bodyData : stdClass|array<string|int, mixed> = null

Data to be passed in the request body as a JSON object.

$timeout : int = null
Return values
stdClass —

Return firewall's response as a stdClass.

httpBuildCustomQuery()

Function used to build a query with params but following fortigate satndards.

private httpBuildCustomQuery(array<string|int, mixed> $data) : string
Parameters
$data : array<string|int, mixed>

Array of data.

Return values
string —

Return the data encoded in a string to be passed as an URL.

login()

Login in the firewall.

private login() : bool
Return values
bool —

Return TRUE if successful or throw Exception if fails.

logout()

Logout from the firewall.

private logout() : Return
Return values
Return —

TRUE if successful, FALSE if it failed.

Search results