Fos Rest API Change Log

FortiOS REST API Change Log
This document identifies the changes for FortiOS REST API releases.
FortiOS 6.0.6
No major changes
FortiOS 6.0.5
Updated APIs
Method URI Description Change Summary
POST api/v2/monitor/registration/forticare Create a new FortiCare Removed the fax parameter.

account.
FortiOS 6.0.4
l Added support for testing the connectivity of a given Sandbox IP

l Added support for retrieving the list of device types
l Updated the access groups for the endpoints
l Updated a few parameters including change in types and description
Below is a summary of new, updated, and removed Monitor APIs.
New APIs
GET /system/sandbox/test-connect/ Test the connectivity of a given New API

FortiSandbox IP
GET /user/device-type/select/ Retrieve a list of device types. New API
FortiOS 000 REST API Change Log 01-000-000000-20191212

Fortinet Technologies Inc. 1
Updated APIs
GET /firewall/session/select List all active firewall sessions Added a new parameter
(optionally filtered). "policytype" of type string Filter:
Policy type [policy6].
GET /firewall/session/select List all active firewall sessions Updated protocol parameter type
(optionally filtered). from integer to string.
GET /router/policy/select Retrieve a list of active IPv4 Added new parameters : start,
policy routes. count, count_only
GET /router/policy6/select Retrieve a list of active IPv6 Added new parameters : start,
policy routes. count, count_only
GET /vpn/one-click/members Get information on devices Updated summary to use the new
registered in the Overlay name overlay controller VPN
Controller VPN cloud assisted
group.
GET /vpn/one-click/status Get the last status message Updated summary to use the new
from FortiCloud? Overlay name overlay controller VPN
Controller VPN cloud service.
Removed APIs
GET /firewall/session-top/select/ List of top sessions by specified Removed API

grouping criteria.
FortiOS 6.0.3
l Added support for logging into and logging out of FortiCloud and creating new accounts
l Added support for logging into and creating new accounts for FortiCare
l Added support for adding licenses to FortiCare
l Added support for initializing and importing FortiTokens
l Added support for testing the connectivity of the given TACACS+ server
l Updated a few parameters, including change in types and description
FortiOS 000 REST API Change Log 2

Fortinet Technologies Inc.
New APIs
POST /registration/forticloud/login/ Log into FortiCloud New API
POST /registration/forticloud/create/ Create a FortiCloud account New API
POST /registration/forticloud/logout/ Log out from FortiCloud New API
GET /registration/forticloud/disclaimer/ Retrieve the FortiCloud disclaimer New API
GET /registration/forticloud/domains/ Retrieve a list of FortiCloud login New API

domains
POST /registration/forticare/login/ Log into FortiCare New API
POST /registration/forticare/create/ Create a new FortiCare account New API
POST /registration/forticare/add- Add a FortiCare license New API

license/
GET /system/security-rating/lang/ Return the requested Security Rating New API

language mapping
GET /user/detected-device/ Retrieve a list of detected devices New API
POST /user/fortitoken/import-trial/ Import trial mobile FortiTokens New API
POST /user/fortitoken/import-mobile/ Import a list of tokens from FortiGuard New API

to the FortiGate unit
POST /user/fortitoken/import-seed/ Import a FortiToken seed file New API
POST /user/tacacs-plus/test/ Test the connectivity of the given New API

TACACS+ server
Updated APIs
GET /firewall/policy-lookup/ Perform a policy lookup by Updated the destport parameter so

creating a dummy packet and that it is not a required parameter
asking the kernel which policy anymore
would be hit
GET /system/available- Retrieve a list of all interfaces Updated the description for the
interfaces/ along with some meta view_type parameter
information regarding their
availability
GET /system/debug/download/ Download debug report for Updated the access group to
technical support sysgrp.cfg

GET /system/security-rating/ Retrieve a Security Rating Updated the parameter from file to
result. Without file specified, id and type from string to int
return the most recent result.
GET /user/device/ Retrieve a list of detected Updated the access group to

devices authgrp
POST /user/fortitoken/send- Send a FortiToken activation Updated summary of the method

activation/ code to a user via SMS or Email parameter and it is not a required
parameter
GET /virtual-wan/health-check/ Retrieve health-check statistics Updated the access group to

for each SD-WAN link netgrp.cfg
GET /virtual-wan/members/ Retrieve interface statistics for Updated the access group to
each SD-WAN link netgrp.cfg
FortiOS 6.0.2
l Added support for testing automation stitch

l Added support for getting connection status for SDN connectors for Google Cloud platform
l Updated a few parameters including change in types and description
New APIs
POST /system/automation-stitch/test/ Triggers an automation stitch for New API

testing purposes.
POST /system/sdn-connector/validate- Validate a string representing a private New API

gcp-key/ key from GCP in PEM format.
Updated APIs
POST /switch-controller/fsw- Upload FortiSwitch firmware to Updated description

firmware/upload/ the management FortiGate and
then push to target
FortiSwitches.

POST /system/fortiguard/clear- Immediately clear all Updated URL

statistics/ FortiGuard statistics.
GET /firewall/health/ List all active firewall sessions Updated the access_group from
(optionally filtered). sysgrp to sysgrp.cfg and
updated the description for
count parameter
POST /firewall/session/clear_all/ Immediately clear all active Updated the access_group from
IPv4 and IPv6 sessions and IPS sysgrp to sysgrp.cfg
sessions of current VDOM.
POST /firewall/session/close/ Close a specific firewall session Updated the access_group from
that matches all provided sysgrp to sysgrp.cfg Updated
criteria. parameter types from string to
int for sport and dport
GET /firewall/session-top/ List of top sessions by specified Updated the access_group from
grouping criteria. sysgrp to sysgrp.cfg and
updated the description for
count parameter
GET /fortiguard/app-information/ Retrieve application information Updated the access_group from

for a given ID from FortiGuard. sysgrp to any
GET /fortiguard/wf-categories/ Retrieve web filter categories Updated the access_group from
from FortiGuard. sysgrp to any
GET /fortiguard/app-categories/ Retrieve application categories Updated the access_group from

from FortiGuard. sysgrp to any
GET /fortiguard/ips-information/ Retrieve IPS information for a Updated the access_group from
given ID from FortiGuard. sysgrp to any
POST /fortiview/session/cancel/ Cancel a FortiView request Updated the access_group from

session. sysgrp to sysgrp.cfg
GET /fortiview/sandbox-file- Retrieve FortiSandbox analysis Updated the access_group from

details/ details for a specific file sysgrp to sysgrp.cfg
checksum.
GET /geoip/geoip-query/ Retrieve location details for IPs Updated the access_group from
queried against FortiGuard 's sysgrp to sysgrp.cfg
geoip service.
GET /license/status/ Get current license & Updated the access_group from
registration status. sysgrp to sysgrp.cfg
GET /license/forticare-resellers/ Get current FortiCare resellers Updated the access_group from
for the requested country. sysgrp to sysgrp.cfg
GET /license/forticare-org-list/ Get FortiCare organization size Updated the access_group from
and industry lists. sysgrp to sysgrp.cfg

GET /router/statistics/ Retrieve routing table statistics, Updated the access_group from
including number of matched sysgrp to sysgrp.cfg
routes.
POST /system/admin/toggle-vdom- Toggles VDOM mode on/off. Updated the access_group from
mode/ Enables or disables VDOM sysgrp to sysgrp.cfg
mode if it is disabled or enabled
respectively.
GET /system/config-revision/ Returns a list of system Updated the access_group from

configuration revisions. sysgrp to sysgrp.cfg
POST /system/config- Updates comments for a Updated the access_group from

revision/update-comments/ system configuration file. sysgrp to sysgrp.cfg
POST /system/config- Deletes one or more system Updated the access_group from
revision/delete/ configuration revisions. sysgrp to sysgrp.cfg
GET /system/config-revision/file/ Download a specific Updated the access_group from

configuration revision. sysgrp to sysgrp.cfg
GET /system/config-revision/info/ Retrieve meta information for a Updated the access_group from
specific configuration revision. sysgrp to sysgrp.cfg
POST /system/config- Create a new config revision Updated the access_group from
revision/save/ checkpoint. sysgrp to sysgrp.cfg
GET /system/current-admins/ Return a list of currently logged Updated the access_group from
in administrators. sysgrp to sysgrp.cfg
POST /system/disconnect-admins/ Disconnects logged in Updated the access_group from

administrators. sysgrp to sysgrp.cfg
POST /system/time/set/ Sets current system time Updated the access_group from
stamp. sysgrp to sysgrp.cfg
GET /system/time/ Gets current system time Updated the access_group from
stamp. sysgrp to sysgrp.cfg
POST /system/os/reboot/ Immediately reboot this device. Updated the access_group from
sysgrp to sysgrp.cfg
POST /system/os/shutdown/ Immediately shutdown this Updated the access_group from

device. sysgrp to sysgrp.cfg
GET /system/global-resources/ Retrieve current usage of global Updated the access_group from
resources as well as both the sysgrp to sysgrp.cfg
default and user configured
maximum values.
GET /system/vdom-resource/ Retrieve VDOM resource Updated the access_group from

information, including CPU and sysgrp to sysgrp.cfg
memory usage.

GET /system/dhcp/ Returns a list of all DHCP IPv4 Updated the access_group from
and IPv6 DHCP leases. netgrp to netgrp.cfg
POST /system/dhcp/revoke/ Revoke IPv4 DHCP leases. Updated the access_group from
netgrp to netgrp.cfg
POST /system/dhcp6/revoke/ Revoke IPv6 DHCP leases. Updated the access_group from
netgrp to netgrp.cfg
POST /system/fsck/start/ Set file system check flag so Updated the access_group from
that it will be executed on next sysgrp to sysgrp.cfg
device reboot.
GET /system/storage/ Retrieve information for the Updated the access_group from
non-boot disk. sysgrp to sysgrp.cfg
GET /system/modem/ Retrieve statistics for Updated the access_group from

internal/external configured sysgrp to sysgrp.cfg
modem.
POST /system/modem/reset/ Reset statistics for Updated the access_group from

internal/external configured sysgrp to sysgrp.cfg
modem.
POST /system/modem/connect/ Trigger a connect for the Updated the access_group from
configured modem. sysgrp to sysgrp.cfg
POST /system/modem/disconnect/ Trigger a disconnect for the Updated the access_group from
configured modem. sysgrp to sysgrp.cfg
POST /system/modem/update/ Update supported modem list Updated the access_group from
from FortiGuard. sysgrp to sysgrp.cfg
GET /system/3g-modem/ List all 3G modems available Updated the access_group from
via FortiGuard. sysgrp to sysgrp.cfg
GET /system/resource/usage/ Retreive current and historical Updated the access_group from
usage data for a provided sysgrp to sysgrp.cfg
resource.
GET /system/interface/ Retrieve statistics for all system Updated the access_group from
interfaces. netgrp to netgrp.cfg
GET /system/interface/dhcp- Retrieve the DHCP client status Updated the access_group from
status/ of an interface. netgrp to netgrp.cfg
POST /system/interface/dhcp- Renew DHCP lease of an Updated the access_group from

renew/ interface. netgrp to netgrp.cfg
GET /system/usb-log/ Retrieve information about Updated the access_group from

connected USB drives, including sysgrp to sysgrp.cfg
estimated log sizes.

POST /system/usb-log/start/ Start backup of logs from Updated the access_group from
current VDOM to USB drive. sysgrp to sysgrp.cfg
POST /system/usb-log/stop/ Stop backup of logs to USB Updated the access_group from
drive. sysgrp to sysgrp.cfg
POST /system/usb-device/eject/ Eject USB drives for safe Updated the access_group from
removal. sysgrp to sysgrp.cfg
GET /system/ipconf/ Determine if there is an IP Updated the access_group from

conflict for a specific IP using netgrp to netgrp.cfg
ARP.
POST /system/fortiguard/update/ Immediately update status for Updated the access_group from
FortiGuard services. sysgrp to sysgrp.cfg
POST /system/fortiguard/test- Test availability of FortiGuard Updated the access_group from

availability/ services. sysgrp to sysgrp.cfg
GET /system/fortiguard/server- Get FortiGuard server list and Updated the access_group from
info/ information. sysgrp to sysgrp.cfg
GET /system/fortimanager/status/ Get FortiManager status. Updated the access_group from

POST /system/fortimanager/config/ Configure FortiManager IP. Updated the access_group from

Register FortiManager if sysgrp to sysgrp.cfg
'fortimanager_ip' is provided.
Unregister FortiManager if only
'unregister' parameter is
specified and set to true.
POST /system/com-log/dump/ Dump system com-log to file. Updated the access_group from
GET /system/com-log/update/ Fetch system com-log file dump Updated the access_group from
progress. sysgrp to sysgrp.cfg
GET /system/com-log/download/ Download com-log file (after file Updated the access_group from
dump is complete). sysgrp to sysgrp.cfg
GET /system/botnet/stat/ Retrieve statistics for Updated the access_group from

FortiGuard botnet database. sysgrp to sysgrp.cfg
GET /system/botnet/ List all known IP-based botnet Updated the access_group from
entries in FortiGuard botnet sysgrp to sysgrp.cfg
database.
GET /system/botnet-domains/ List all known domain-based Updated the access_group from
botnet entries in FortiGuard sysgrp to sysgrp.cfg
botnet database.

GET /system/botnet- List statistics on domain-based Updated the access_group from

domains/stat/ botnet entries in FortiGuard sysgrp to sysgrp.cfg
botnet database.
GET /system/botnet- List hit botnet domains with hit Updated the access_group from
domains/hits/ count > 0. sysgrp to sysgrp.cfg
GET /system/ha-statistics/ List of statistics for members of Updated the access_group from
HA cluster. sysgrp to sysgrp.cfg
GET /system/ha-history/ Get HA cluster historical logs. Updated the access_group from
GET /system/ha-checksums/ List of checksums for members Updated the access_group from
of HA cluster. sysgrp to sysgrp.cfg
GET /system/ha-peer/ Get configuration of peer(s) in Updated the access_group from

HA cluster. Uptime is expressed sysgrp to sysgrp.cfg
in seconds.
POST /system/ha-peer/update/ Update configuration of peer in Updated the access_group from

POST /system/ha-peer/disconnect/ Update configuration of peer in Updated the access_group from

GET /system/link-monitor/ Retrieve per-interface statistics Updated the access_group from

for active link monitors. sysgrp to sysgrp.cfg
POST /system/compliance/run/ Immediately run compliance Updated the access_group from

checks for the selected VDOM. sysgrp to sysgrp.cfg
GET /system/config/usb-filelist/ List configuration files available Updated the access_group from
on connected USB drive. sysgrp to sysgrp.cfg
GET /system/sandbox/status/ Retrieve sandbox status. Updated the access_group from

GET /system/sandbox/stats/ Retrieve sandbox stats. Updated the access_group from

GET /system/object/usage/ Retrieve all objects that are Updated the name for extra
currently using as well as parameters to use q_path and
objects that can use the given q_name
object.
POST /system/vmlicense/upload/ Update VM license using Updated the access_group from

uploaded file. Reboots sysgrp to sysgrp.cfg
immediately if successful.
GET /system/sensor-info/ Retrieve system sensor status. Updated the access_group from

GET /system/fortiguard-blacklist/ Retrieve blacklist information Updated the access_group from

for a specified IP. sysgrp to sysgrp.cfg
GET /system/check-port- Check whether a list of TCP port Updated the access_group from
availability/ ranges is available for a certain sysgrp to sysgrp.cfg
service.
GET /system/external- Retrieve resource file status Updated the access_group from
resource/entry-list/ with a list of valid/invalid entries sysgrp to sysgrp.cfg
(skip empty and comment lines)
for the specific external
resource.
GET /extender- Retrieve statistics for specific Updated the access_group from
controller/extender/ configured FortiExtender units. netgrp to netgrp.cfg
POST /extender- Reset a specific FortiExtender Updated the access_group from

controller/extender/reset/ unit. netgrp to netgrp.cfg
GET /system/sdn- Retrieve connection status for Updated the access_group from
connector/status/ SDN connectors. sysgrp to sysgrp.cfg
GET /user/device/ Retrieve a list of detected Updated the access_group from

devices. sysgrp to sysgrp.cfg
GET /virtual-wan/health-check/ Retrieve health-check statistics Updated the access_group from

for each SD-WAN link. sysgrp to sysgrp.cfg
GET /virtual-wan/members/ Retrieve interface statistics for Updated the access_group from
each SD-WAN link. sysgrp to sysgrp.cfg
GET /webproxy/pacfile/download/ Download webproxy PAC file. Updated the access_group from
FortiOS 6.0.1
l Added support for getting stats on the automation stitches

l Added support for getting all event log descriptions
l Added support for backing up FortiManager objects and get the details regarding backed up objects
l Added support for getting status on the external resource
l Added support for getting connection status for SDN connectors
l Updated the access for restoring the system configuration
l Updated a few parameters including change in types and required status

New APIs
GET /log/event/ List all event log descriptions. New API
GET /system/automation-stitch/stats Stats for automation stitches. New API
GET /system/fortimanager/backup- Get FortiManager backup summary. New API

summary/
POST /system/fortimanager/backup- Import or update from FortiManager New API

action/ objects.
GET /system/fortimanager/backup- Get the properties of a FortiManager New API

details/ object.
GET /system/sdn-connector/status Retrieve connection status for SDN New API

connectors.
GET /system/external-resource/entry- Retrieve resource file status with a list New API
list of valid\/invalid entries (skip empty and
comment lines) for the specific external
resource.
Updated APIs
GET /firewall/session/ List all active firewall sessions Added a new parameter
(optionally filtered). "application", Type: string,
Summary: Filter: Application
PROTO\/PORT. (e.g.
\"TCP\/443\")
POST /license/database/upgrade Upgrade a license database on Updated description and updated

this device using uploaded file. the required status of parameter
"db_name"
POST /system/config/restore Restore system configuration Updated access group from

from uploaded file or from USB. sysgrp to sysgrp.mnt
POST /vpn/ipsec/tunnel_up Bring up a specific IPsec VPN Updated the type for the
tunnel. parameter p2serial to take
integer.
POST /vpn/ipsec/tunnel_down Bring down a specific IPsec VPN Updated the type for the
tunnel. parameter p2serial to take
integer.

FortiOS 6.0.0
l Added support for multi-VDOM request via VDOM parameter (global flag is deprecated)
l Disallowed user to change admin password via CMDB API (need to perform via Monitor API)
l Added revision stats for CMDB resource (for caching usage)
New APIs
GET /firewall/internet-service-details/ List all details for a given Internet New API
Service ID.
GET /firewall/per-ip-shaper/ List of statistics for configured firewall New API

per-IP traffic shapers.
POST /firewall/per-ip-shaper/reset/ Reset statistics for all configured New API

firewall per-IP traffic shapers.
GET /firewall/address-fqdns6/ List of IPv6 FQDN address objects and New API
the IPs they resolved to.
GET /fortiguard/app-information/ Retrieve application information for a New API

given ID from FortiGuard.
GET /fortiguard/wf-categories/ Retrieve web filter categories from New API

FortiGuard.
GET /fortiguard/app-categories/ Retrieve application categories from New API

FortiGuard.
GET /fortiguard/ips-information/ Retrieve IPS information for a given ID New API

from FortiGuard.
GET /fortiguard/help-topics/ Retrieve help topics from FortiGuard. New API
GET /fortiguard/prefix-links/ Retrieve prefix links from FortiGuard. New API
GET /fortiguard/static-links/ Retrieve static links from FortiGuard. New API
GET /system/csf/pending- Retrieve FortiGates with pending New API

authorizations/ authorizations for joining the Security
Fabric. Note:- This list is currently
available on Security Fabric root only.
POST /switch-controller/managed- Send 'Factory Reset' command to a New API

switch/factory-reset/ given FortiSwitch.
POST /switch-controller/fsw- Download FortiSwitch firmware from New API

firmware/download/ FortiGuard to the FortiGate according
to FortiSwitch image ID.

POST /switch-controller/fsw- Push FortiSwitch firmware to the given New API

firmware/push/ device.
POST /switch-controller/fsw- Upload FortiSwitch firmware to the New API

firmware/upload/ management FortiGate and then push
to target FortiAPs.
GET /switch-controller/detected- Retrieve a list of devices detected on New API

device/ all switches.
GET /system/interface/dhcp-status/ Retrieve the DHCP client status of an New API

interface.
POST /system/interface/dhcp-renew/ Renew DHCP lease of an interface. New API
GET /system/nat46-ippools/ Retrieve a list of all IPv6 IP pools that New API
are valid for NAT 46 policies.
POST /system/usb-device/eject/ Eject USB drives for safe removal. New API
GET /system/botnet-domains/hits/ List hit botnet domains with hit count > New API
0.
GET /system/object-tagging/usage/ Retrieve usage count for tags in all tag New API
categories.
GET /system/status/ Retrieve basic system status. New API
GET /system/security-rating/history/ Retrieve Security Rating history. New API
POST /system/security-rating/trigger/ Trigger a Security Rating. New API
GET /system/security-rating/status/ Check if a Security Rating is currently New API

running.
POST /user/radius/test-connect/ Test the connectivity of the given New API

RADIUS server and, optionally, the
validity of a username & password.
GET /vpn/one-click/members/ Get information on devices registered New API

in the One-Click VPN cloud assisted
group.
GET /vpn/one-click/status/ Get the last status message from New API
FortiCloud One-Click VPN cloud
service.
POST /wifi/firmware/download/ Download FortiAP firmware from New API

FortiGuard to the FortiGate according
to FortiAP image ID.
POST /wifi/firmware/push/ Push FortiAP firmware to the given New API

device.

POST /wifi/firmware/upload/ Upload FortiAP firmware to the New API

management FortiGate and then push
to target FortiAPs.
Updated APIs
GET /firewall/internet-service- List internet services that exist Updated access permission to
match/ at a given IP or Subnet. firewall address group instead of
firewall policy
GET /firewall/policy/ List traffic statistics for IPv4 Added filter for policy ID.
policies.
GET /firewall/policy6/ List traffic statistics for IPv6 Added filter for policy ID.
policies.
GET /firewall/shaper/ List of statistics for configured Updated description to indicate

firewall shared traffic shapers. the API is for shared traffic
shappers.
GET /firewall/address-fqdns/ List of FQDN address objects Updated access permission to

and the IPs they resolved to. firewall address group instead of
firewall policy
GET /firewall/address-dynamic/ List of Fabric Connector Updated description

address objects and the IPs
they resolve to.
GET /firewall/address6-dynamic/ List of IPv6 Fabric Connector Updated description

address objects and the IPs
they resolve to.
GET /fortiview/statistics/ Retrieve drill-down and Updated permission to fortiview

summary data for FortiView group
(both realtime and historical).
GET /log/historic-daily-remote- Returns the amount of logs in Added documentation for server
logs/ bytes sent daily to a remote parameter
logging service (FortiCloud or
FortiAnalyzer).
GET /router/ipv4/ List all active IPv4 routing table Updated permission to router
entries. group instead of system group
GET /router/ipv6/ List all active IPv6 routing table Updated permission to router
entries. group instead of system group
POST /system/change-password/ Save admin and guest-admin Added documentation for

passwords. parameters.

POST /system/password-policy- Check whether password Added documentation for

conform/ conforms to the password parameters.
policy.
GET /system/csf/ Retrieve a full tree of Updated permission to security

downstream FortiGates fabric group instead of system
registered to the Security group
Fabric.
POST /system/fortimanager/config/ Configure FortiManager IP. Updated description and added

Register FortiManager if information on parameters.
'fortimanager_ip' is provided.
Unregister FortiManager if only
'unregister' parameter is
specified and set to true.
GET /system/botnet/ List all known IP-based botnet Added option to filter for hit
entries in FortiGuard botnet entries
database.
GET /user/device/ Retrieve a list of detected Removed fortilink_visibility

devices. option
Renamed APIs
GET /system/security-rating/ Retrieve a Security Rating result. Renamed from /system/audit/

Without file specified, returns the
most recent result.
GET /switch- Retrieve statistics for configured Renamed from /system/fsw/.

controller/managed-switch/ FortiSwitches. Updated permission to WiFi
group instead of system group.
Renamed parameter fsw_id to
mkey
POST /switch- Update administrative state for a Renamed from

controller/managed- given FortiSwitch (enable or /system/fsw/update. Updated
switch/update/ disable authorization). permission to WiFi group instead
of system group. Renamed
parameter fswname to mkey
POST /switch- Restart a given FortiSwitch. Renamed from

controller/managed- /system/fsw/restart. Updated
switch/restart/ permission to WiFi group instead
of system group.

POST /switch- Reset PoE on a given Renamed from /system/fsw/poe-

controller/managed- FortiSwitch's port. reset. Updated permission to
switch/poe-reset/ WiFi group instead of system
group.
GET /switch-controller/fsw- Retrieve a list of recommended Renamed from /system/fsw-

firmware/ firmware for managed firmware. Updated permission to
FortiSwitches. WiFi group instead of system
group.
Removed APIs
Method URI Description Change

Summary
POST /system/fsw/upgrade/ Upgrade firmware image on the given Removed API

FortiSwitch using uploaded file.
POST /system/debug/ Log debug messages to the console (if Removed API
enabled).
POST /wifi/managed_ap/upgrade/ Upgrade firmware image on the given Removed API

FortiAP using uploaded file.
FortiOS 5.6.12
No major changes
FortiOS 5.6.11
No major changes
FortiOS 5.6.10
No major changes

FortiOS 5.6.9
No major changes
FortiOS 5.6.8
No major changes
FortiOS 5.6.7
No major changes
FortiOS 5.6.6
No major changes
FortiOS 5.6.5
No major changes
FortiOS 5.6.4
No major changes
FortiOS 5.6.3
Below is a summary of changes to the Monitor APIs. Please check each API documentation for more details.
Status URI Method Description
Updated /firewall/session/clear_all/ POST Immediately clear all active IPv4 and IPv6
sessions and IPS sessions of current VDOM.

Status URI Method Description
Added /firewall/address-dynamic/ GET List of Dynamic SDN address objects and the
IPs they resolve to.
Added /firewall/address6-dynamic/ GET List of IPv6 Dynamic SDN address objects and
the IPs they resolve to.
Added /fortiview/session/cancel/ POST Cancel a FortiView request session.
Added /system/global-resources/ GET Retrieve current usage of global resources as

well as both the default and user configured
maximum values.
Updated /system/fsck/start/ POST Set file system check flag so that it will be
executed on next device reboot.
Added /switch-controller/managed-switch/dhcp- GET Retrieve DHCP servers monitored by

snooping/ FortiSwitches.
Added /vpn-certificate/ca/import/ POST Import CA certificate.
Added /vpn-certificate/crl/import/ POST Import certificate revocation lists (CRL) from

file content.
Added /vpn-certificate/local/import/ POST Import local certificate.
Added /vpn-certificate/remote/import/ POST Import remote certificate.
Added /vpn-certificate/csr/generate/ POST Generate a certificate signing request (CSR)

and a private key. The CSR can be retrieved /
downloaded from CLI, GUI and REST API.
Added /system/check-port-availability/ GET Check whether a list of TCP port ranges is

available for a certain service.
Updated /user/fortitoken/ GET Retrieve a map of FortiTokens and their status.
Updated /virtual-wan/health-check/ GET Retrieve health-check statistics for each SD-

WAN link.
Added /virtual-wan/members/ GET Retrieve interface statistics for each SD-WAN

link.
FortiOS 5.6.2
l Updated GET /api/v2/monitor/endpoint-control/avatar/download/ to support large default avatar

FortiOS 5.6.1
l Added support for token-based authentication

l Added support for the following APIs
l |GET|/firewall/internet-service-match/|List internet services that exist at a given IP or Subnet.|
l |GET|/firewall/ippool/|List IPv4 pool statistics.|
l |GET|/router/policy/|Retrieve a list of active IPv4 policy routes.|
l |GET|/router/policy6/|Retrieve a list of active IPv6 policy routes.|
l |POST|/system/api-user/generate-key/|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.|
l |GET|/system/firmware/upgrade-paths/|Retrieve a list of supported firmware upgrade paths.|
l |POST|/system/modem/update/|Update supported modem list from FortiGuard.|
l |POST|/system/fsw/poe-reset/|Reset PoE on a given FortiSwitch 's port.|
l |GET|/switch-controller/validate-switch-prefix/|Validate a FortiSwitch serial number prefix.|
l |GET|/system/available-interfaces/|Retrieve a list of all interfaces along with some meta information regarding
their availability.|
l |GET|/system/ha-history/|Get HA cluster historical logs.|
l Removed the following APIs
l |GET|/system/available-interfaces/ha/|Retrieve a list of all interfaces along with some meta information
regarding their availability. 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|
l |GET|/system/interface-bandwidth/|Retrieve bandwidth of all interfaces.|
l Fixed bugs
FortiOS 5.6.0
l Added support for various Monitor APIs

l Fixed bugs
FortiOS 5.4.13
No major changes
FortiOS 5.4.12
No major changes

FortiOS 5.4.11
No major changes
FortiOS 5.4.10
No major changes
FortiOS 5.4.9
No major changes
FortiOS 5.4.8
No major changes
FortiOS 5.4.7
No major changes
FortiOS 5.4.6
l Updated POST /api/v2/monitor/firewall/session/clear_all API to clear all IPS sessions as well.

l Updated POST /api/v2/monitor/user/fortitoken/send-activation API usage to not require user name, email, or sms
number for mobile token activation.
FortiOS 5.4.5
New:
l Added support for /api/v2/monitor/system/firmware/upgrade-paths - Retrieve a list of supported firmware upgrade
paths.
l Added support for /api/v2/monitor/webfilter/fortiguard-categories - Return FortiGuard web filter categories.

FortiOS 5.4.4
Bug fixes:
l #0378665 - CMDB POST/PUT request does not work with reserved keywords in body data
FortiOS 5.4.3
Updates:
l /api/v2/monitor/user/firewall/deauth can now deauthorize specific user(s) or all users
FortiOS 5.4.2
Updates:
l /api/v2/monitor/system/config/backup now uses "scope" and "vdom" parameters for specifying config scope and
vdom
l /api/v2/monitor/system/config/restore now uses "scope" and "vdom" parameters for specifying config scope and
vdom
FortiOS 5.4.1
New:
l Added support for various Monitor APIs (see the FortiOS 5.4.1 Release Notes for details)
l Added support for retrieving configuration objects from all VDOMs in one request via "global" flag
l Enhanced filtering support for configuration objects
l Simplified support for modifying nested configuration objects
Updates:
l Simplified HTTP body data requirements for configuration object changes
FortiOS 5.4.0
No major changes

FortiOS 5.2.15
No major changes
FortiOS 5.2.14
No major changes
FortiOS 5.2.13
No major changes
FortiOS 5.2.12
No major changes
FortiOS 5.2.11
New:
l Added support for /api/v2/monitor/system/vdom-resource
l Added support for retrieving configuration objects from all VDOMs in one request via "global" flag
FortiOS 5.2.10
No major changes
FortiOS 5.2.9
No major changes

FortiOS 5.2.8
New:
l Added support for /api/v2/monitor/wifi/firmware - Retrieve a list of current and recommended firmware for FortiAPs
in use.
l Added support for /api/v2/monitor/wifi/meta - Retrieve WiFi related meta data.
FortiOS 5.2.7
No major changes
FortiOS 5.2.6
No major changes
FortiOS 5.2.5
New:
l Added support for /api/v2/monitor/firewall/anomaly - List active IPv4 DoS anomaly meters.
l Added support for /api/v2/monitor/firewall/anomaly6 - List active IPv6 DoS anomaly meters.
FortiOS 5.2.4
No major changes
FortiOS 5.2.3
No major changes


Fos Rest API Change Log

Загружено:

Сведения о документе

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Fos Rest API Change Log

Загружено:

Авторское право:

Доступные форматы

FortiOS REST API Change Log

This document identifies the changes for FortiOS REST API releases.

Method URI Description Change Summary

POST api/v2/monitor/registration/forticare Create a new FortiCare Removed the fax parameter.

l Added support for testing the connectivity of a given Sandbox IP

Method URI Description Change Summary

GET /system/sandbox/test-connect/ Test the connectivity of a given New API

GET /user/device-type/select/ Retrieve a list of device types. New API

FortiOS 000 REST API Change Log 01-000-000000-20191212

Method URI Description Change Summary

Method URI Description Change Summary

GET /firewall/session-top/select/ List of top sessions by specified Removed API

FortiOS 000 REST API Change Log 2

Method URI Description Change Summary

POST /registration/forticloud/login/ Log into FortiCloud New API

POST /registration/forticloud/create/ Create a FortiCloud account New API

POST /registration/forticloud/logout/ Log out from FortiCloud New API

GET /registration/forticloud/disclaimer/ Retrieve the FortiCloud disclaimer New API

GET /registration/forticloud/domains/ Retrieve a list of FortiCloud login New API

POST /registration/forticare/login/ Log into FortiCare New API

POST /registration/forticare/create/ Create a new FortiCare account New API

POST /registration/forticare/add- Add a FortiCare license New API

GET /system/security-rating/lang/ Return the requested Security Rating New API

GET /user/detected-device/ Retrieve a list of detected devices New API

POST /user/fortitoken/import-trial/ Import trial mobile FortiTokens New API

POST /user/fortitoken/import-mobile/ Import a list of tokens from FortiGuard New API

POST /user/fortitoken/import-seed/ Import a FortiToken seed file New API

POST /user/tacacs-plus/test/ Test the connectivity of the given New API

Method URI Description Change Summary

GET /firewall/policy-lookup/ Perform a policy lookup by Updated the destport parameter so

FortiOS 000 REST API Change Log 3

Method URI Description Change Summary

GET /user/device/ Retrieve a list of detected Updated the access group to

POST /user/fortitoken/send- Send a FortiToken activation Updated summary of the method

GET /virtual-wan/health-check/ Retrieve health-check statistics Updated the access group to

l Added support for testing automation stitch

Method URI Description Change Summary

POST /system/automation-stitch/test/ Triggers an automation stitch for New API

POST /system/sdn-connector/validate- Validate a string representing a private New API

Method URI Description Change Summary

POST /switch-controller/fsw- Upload FortiSwitch firmware to Updated description

FortiOS 000 REST API Change Log 4

Method URI Description Change Summary

POST /system/fortiguard/clear- Immediately clear all Updated URL

GET /fortiguard/app-information/ Retrieve application information Updated the access_group from

GET /fortiguard/app-categories/ Retrieve application categories Updated the access_group from

POST /fortiview/session/cancel/ Cancel a FortiView request Updated the access_group from

GET /fortiview/sandbox-file- Retrieve FortiSandbox analysis Updated the access_group from

FortiOS 000 REST API Change Log 5

Method URI Description Change Summary

GET /system/config-revision/ Returns a list of system Updated the access_group from

POST /system/config- Updates comments for a Updated the access_group from

GET /system/config-revision/file/ Download a specific Updated the access_group from

POST /system/disconnect-admins/ Disconnects logged in Updated the access_group from

POST /system/os/shutdown/ Immediately shutdown this Updated the access_group from

GET /system/vdom-resource/ Retrieve VDOM resource Updated the access_group from

FortiOS 000 REST API Change Log 6

Method URI Description Change Summary

GET /system/modem/ Retrieve statistics for Updated the access_group from

POST /system/modem/reset/ Reset statistics for Updated the access_group from

POST /system/interface/dhcp- Renew DHCP lease of an Updated the access_group from

GET /system/usb-log/ Retrieve information about Updated the access_group from

FortiOS 000 REST API Change Log 7

Method URI Description Change Summary