System resource list and URLs
|
Resources marked with * also apply to domain level REST APIs. |
|
URL |
HTTP method |
Summary |
|---|---|---|
|
/AddressBook/ * |
GET, POST, PUT, DELETE |
Contacts |
|
/AddressbookGroup/ * |
GET, POST, PUT, DELETE |
Contact groups |
|
/ArchAccount/ |
GET, POST, PUT, DELETE |
Archive accounts |
|
/ArchExempt/ |
GET, POST, PUT, DELETE |
Archive exempt policy |
|
/ArchJournalSource/ |
GET, POST, PUT, DELETE |
Archive journaling source |
|
/ArchPolicy/ |
GET, POST, PUT, DELETE |
Archive policy |
|
/AsBounceverifyKey/ |
GET, POST, PUT, DELETE |
Bounce verification keys |
|
/AsDeepheader/ |
GET, PUT |
Deep header analysis settings |
|
/AsGreylist/ |
GET |
Greylist |
|
/AsGreylisyAutoexempt/ |
GET |
Auto exempt greylist |
|
/AsMsisdnReputationAuto_blocklist/ |
GET |
Endpoint reputation auto blocklist |
|
/AsMsisdnReputationblocklist/ |
GET, DELETE |
Endpoint reputation blocklist |
|
/AsMsisdnReputationExempt/ |
GET, DELETE |
Endpoint reputation exempt list |
|
/AsSenderReputation/ |
GET |
Sender reputation list |
|
/AsSpamreport/ |
GET, PUT |
Quarantine / spam report settings |
|
/AsUrl_fgas_exempt_list/ |
GET, POST, PUT, DELETE |
URL exempt list |
|
/CalResource/ * |
GET, POST, PUT, DELETE |
|
|
/CalendarServer/ |
GET, PUT |
Calendar server settings |
|
/CentralBackupConfig/ |
GET, PUT |
Central backup configuration |
|
/CentralConfigList/ |
GET, DELETE |
Central backup list |
|
/ContentScanRules/ |
GET, POST, PUT, DELETE |
DLP content scan rules |
|
/ContentScanRulesConditions/ |
GET, POST, PUT, DELETE |
DLP content scan rule conditions |
|
/ContentScanRulesExceptions/ |
GET, POST, PUT, DELETE |
DLP content scan rule exceptions |
|
/domain/ |
GET, POST, PUT, DELETE |
Protected domain settings |
|
/DomainSettingSenderAddrRateCtrlExempt/ |
GET, POST, PUT, DELETE |
Sender rate control exempt list for specified domain settings |
|
/DomainSpamReportRcpt/ |
GET, PUT |
Domain level quarantine / spam report settings |
|
/FilePattern/ * |
GET, POST, PUT, DELETE |
File patterns / filters |
|
/FileSignature/ |
GET, POST, PUT, DELETE |
File signatures for AV scan |
|
/Fingerprint_doc/ |
GET, DELETE |
Fingerprint document list |
|
/LogAltMMailto/ |
GET, POST, DELETE |
Alert email accounts |
|
/LogAltMSetting/ |
GET, PUT |
Alert email settings |
|
/LogReport_config/ |
GET, POST, PUT, DELETE |
Log report configurations |
|
/LogReportFile/ |
GET, DELETE |
Log report files |
|
/LogSetLocal/ |
GET, PUT |
Local log settings |
|
/MailSetStrgNfs/ |
GET, PUT |
Mail storage settings |
|
/MailSetStrgRemote_storage_ibe/ |
GET, PUT |
Centralized IBE storage settings |
|
/MailSetStrgServer/ |
GET, PUT |
Centralized quarantine storage settings |
|
/MailSetSystemquarantine/ |
GET, PUT |
System quarantine settings |
|
/MailSetSystemquarantineFolder/ |
GET, POST, PUT, DELETE |
System quarantine folders |
|
/PolicyIp/ |
GET, POST, PUT, DELETE |
IP policies |
|
/PolicyRecipient/ * |
GET, POST, PUT, DELETE |
Recipient policies |
|
/ProfAntispam/ * |
GET, POST, PUT, DELETE |
AntiSpam profiles |
|
/ProfAntispam_action/ * |
GET, POST, PUT, DELETE |
AntiSpam action profiles |
|
/ProfAntispamBannedwords/ * |
GET, POST, PUT, DELETE |
AntiSpam profile banned words |
|
/ProfAntispamDnsblServer/ * |
GET, POST, PUT, DELETE |
AntiSpam profile DNSBL servers |
|
/ProfAntispamSurblServer/ * |
GET, POST, PUT, DELETE |
AntiSpam profile SURBL servers |
|
/ProfAntispamWhitelistwords/ * |
GET, POST, PUT, DELETE |
AntiSpam profile safelist words |
|
/ProfAntivirus/ * |
GET, POST, PUT, DELETE |
AntiVirus profiles |
|
/ProfAntivirus_action/ * |
GET, POST, PUT, DELETE |
AntiVirus action profiles |
|
/ProfAuthImap/ * |
GET, POST, PUT, DELETE |
IMAP authentication profiles |
|
/ProfAuthPop3/ * |
GET, POST, PUT, DELETE |
POP3 authentication profiles |
|
/ProfAuthRadius/ * |
GET, POST, PUT, DELETE |
RADIUS authentication profiles |
|
/ProfAuthSmtp/ * |
GET, POST, PUT, DELETE |
SMTP authentication profiles |
|
/ProfCertificate_binding/ |
GET, POST, PUT, DELETE |
Certificate binding profiles |
|
/ProfContent/ * |
GET, POST, PUT, DELETE |
Content profiles |
|
/ProfContent_action/ * |
GET, POST, PUT, DELETE |
Content action profiles |
|
/ProfContentAttachment/ * |
GET, POST, PUT, DELETE |
Content profile attachment scan rules |
|
/ProfContentMonitor/ * |
GET, POST, PUT, DELETE |
Content monitor profile |
|
/ProfDictionary/ |
GET, POST, PUT, DELETE |
Dictionary profiles |
|
/ProfDictionary_group/ |
GET, POST, PUT, DELETE |
Dictionary group |
|
/ProfDictionaryDictionaryItem/ |
GET, POST, PUT, DELETE |
Dictionary profile dictionary entries |
|
/ProfDlp/ |
GET, POST, PUT, DELETE |
DLP profiles |
|
/ProfDlpContentScan/ |
GET, POST, PUT, DELETE |
DLP profile content scan settings |
|
/ProfEmail_address_group/ |
GET, POST, PUT, DELETE |
Email address groups |
|
/ProfEncryption/ |
GET, POST, PUT, DELETE |
Encryption profiles |
|
/ProfIp_address_group/ |
GET, POST, PUT, DELETE |
IP address groups |
|
/ProfIp_pool/ |
GET, POST, PUT, DELETE |
IP pools |
|
/ProfLdap/ |
GET, POST, PUT, DELETE |
LDAP profiles |
|
/ProfMisc/ * |
GET, POST, PUT, DELETE |
Resource profiles |
|
/ProfNotification/ |
GET, POST, PUT, DELETE |
Notification profiles |
|
/ProfSessionRecipientWhitelist/ |
GET, POST, PUT, DELETE |
Session profile recipient safelist |
|
/ProfSessionRemovedHeader/ |
GET, POST, PUT, DELETE |
Session profile removed headers |
|
/ProfSessionSenderBlacklist/ |
GET, POST, PUT, DELETE |
Session profile sender blocklist |
|
/ProfSessionSenderWhitelist/ |
GET, POST, PUT, DELETE |
Session profile sender safelist |
|
/ProfTls/ |
GET, POST, PUT, DELETE |
TLS profiles |
|
/ProfUri_filter/ |
GET, POST, PUT, DELETE |
URI filter profiles |
|
/RaidSystem/ |
GET |
Raid system status |
|
/RaidSystemArray/ |
GET |
Raid array information |
|
/RaidSystemDisk/ |
GET |
Raid disk information |
|
/SemailDbDomain/ |
GET, DELETE |
IBE domains |
|
/SemailDbUser/ |
GET, DELETE |
IBE users |
|
/Sensitive_dataCompliance/ |
GET |
DLP standard compliance data |
|
/Sensitive_dataFingerprint/ |
GET, POST, PUT, DELETE |
DLP fingerprint data |
|
/Sensitive_dataFingerprint_source/ |
GET, POST, PUT, DELETE |
DLP fingerprint source |
|
/Sensitive_dataFingerprintDocument/ |
GET, DELETE |
DLP fingerprint documents |
|
/SysAccprofile/ |
GET, POST, PUT, DELETE |
Admin access profiles |
|
/SysAdmin/ |
GET, POST, PUT, DELETE |
System administrators |
|
/SysAntispam/ |
GET, PUT |
System AntiSpam settings |
|
/SysAppearance/ |
GET, PUT |
System appearance settings |
|
/SysAutoupdate/ |
GET, PUT |
FortiGuard AntiVirus auto update settings |
|
/SysBackup_restore/ |
GET, PUT |
Mail data auto backup settings |
|
/SysBurstRestore/ |
PUT |
Restore mail data from backup |
|
/SysDateSetting/ |
GET, PUT |
System date |
|
/SysDdns/ |
GET, POST, PUT, DELETE |
DDNS servers |
|
/SysDisclaimer/ |
GET, PUT |
System disclaimer settings |
|
/SysDisclaimer_exclude/ |
GET, POST, PUT, DELETE |
Disclaimer exclusion list |
|
/SysDns/ |
GET, PUT |
System DNS server settings |
|
/SysEncryptionIbe/ |
GET, PUT |
IBE encryption settings |
|
/SysEncryptionIbe_auth/ |
GET, POST, PUT, DELETE |
IBE user authentication list |
|
/SysFortiguard/ |
GET, PUT |
FortiGuard AntiSpam settings |
|
/SysFortisandbox/ |
GET, PUT |
FortiSandbox settings |
|
/SysGlobal/ |
GET, PUT |
System global settings |
|
/SysHa/ |
GET, PUT |
HA settings |
|
/SysHaInterface/ |
GET, PUT |
HA interface settings |
|
/SysHaService/ |
GET, PUT |
HA service monitor settings |
|
/SysHaStatus/ |
GET |
HA status |
|
/SysInterface/ |
GET, POST, PUT, DELETE |
Network interface list |
|
/SysLink_monitor/ |
GET, PUT |
Link monitor settings |
|
/SysLink_monitorInterface/ |
GET, PUT |
Link monitor interface settings |
|
/SysMailserver/ |
GET, PUT |
Mail server settings |
|
/SysRemote_mail_server/ |
GET, POST, PUT, DELETE |
Remote email servers |
|
/SysRoute/ |
GET, POST, PUT, DELETE |
Network routing list |
|
/SysSched_backup/ |
GET, PUT |
System configuration scheduled backup settings |
|
/SysScheduledLocalBackup/ |
GET, PUT |
Scheduled local backup list |
|
/SysSnmpCommunity/ |
GET, POST, PUT, DELETE |
SNMP communities |
|
/SysSnmpCommunityHost/ |
GET, POST, PUT, DELETE |
Hosts for a SNMP community |
|
/SysSnmpSnmpv3_user/ |
GET, POST, PUT, DELETE |
SNMP users |
|
/SysSnmpSnmpv3_userHost/ |
GET, POST, PUT, DELETE |
Notification hosts for a SNMP user |
|
/SysSnmpSysinfo/ |
GET, PUT |
SNMP system information settngs |
|
/SysSnmpThreshold/ |
GET, PUT |
SNMP threshold settings |
|
/SysStatisticSummary/ |
GET |
Mail statistics summary |
|
/SysStatusCommand/ |
POST |
Restart / Shut donw / Reload system command |
|
/SysStatusLicinfo/ |
GET |
System AS / AV license status |
|
/SysStatusLicinfoLicenses/ |
GET |
Feature license list |
|
/SysStatusSysinfo/ |
GET |
System status information |
|
/SysStatusUsage/ |
GET |
System resource usage |
|
/SysTimeManual/ |
GET, PUT |
System time & zone settings |
|
/SysTimeNtp/ |
GET, PUT |
System NTP server settings |
|
/SysWccpSettings/ |
GET, PUT |
FortiGate WCCP settings |
|
/UserAlias/ * |
GET, POST, PUT, DELETE |
User aliases |
|
/UserMail/ * |
GET, POST, PUT, DELETE |
Mail users |
|
/UserMap/ * |
GET, POST, PUT, DELETE |
Address maps |
|
/UserPki/ |
GET, POST, PUT, DELETE |
PKI users |
|
/UserUser_group/ * |
GET, POST, PUT, DELETE |
User groups |