Fortinet white logo
Fortinet white logo

CLI Reference

system web-service

system web-service

Use this command to configure the rate limit for REST APIs, including the maximum concurrent REST API requests (overall and for individual IP addresses), and how fast the system should perform, in terms of how many requests and responses are processed per second. It also configures connections for FortiMail webmail and per-user quarantines.

Valid value ranges for certain commands vary by FortiMail model.

Syntax

config system web-service

config exempt-list

edit <list_index>

set<client_ipv4mask>

next

end

set https-redirect-status {enable | disable}

set https-redirect-host <fortimail_fqdn>

set max-active-session-admin <limit_int>

set max-active-session-restful <limit_int>

set max-concurrent-request-admin <limit_int>

set max-concurrent-request-all <limit_int>

set max-concurrent-request-ms365 <limit_int>

set max-concurrent-request-per-ip <limit_int

set max-concurrent-request-restful <limit_int>

set max-concurrent-request-webmail <limit_int>

set max-request-rate-admin <limit_int>

set max-request-rate-ms365 <limit_int>

set max-request-rate-restful <limit_int>

set max-request-rate-webmail <limit_int>

set rest-api-status {enable | disable}

end

Variable

Description

Default

<list_index>

Configure exempt lists of IP addresses that you want to exempt from rate limits.

<client_ipv4mask>

Enter an IP address and netmask that you want to exempt from rate limits.

https-redirect-status {enable | disable}

Enable to redirect insecure HTTP requests to secure access using HTTPS.

This setting affects all FortiMail URLs: REST APIs, administrator GUI, FortiMail webmail, and per-user quarantines.

Note: For this setting to take effect, you must also enable both HTTP and HTTPS access protocols on the network interface(s) that receive these connections. FortiMail cannot redirect HTTP if it is not listening for it.

enable

https-redirect-host <fortimail_fqdn>

Enter the fully qualified domain name (FQDN) to use in HTTPS redirects.

max-active-session-admin <limit_int>

Enter the maximum number of active administrator sessions.

200

max-active-session-restful <limit_int>

Enter the maximum number of active RESTful sessions.

10

max-concurrent-request-admin <limit_int>

Enter the maximum number of concurrent admin portal requests.

50

max-concurrent-request-all <limit_int>

Enter the maximum number of concurrent HTTP requests from all clients.

0

max-concurrent-request-ms365 <limit_int>

Enter the maximum number of concurrent Microsoft Office 365 requests permitted.

100

max-concurrent-request-per-ip <limit_int

Enter the maximum number of concurrent HTTP requests for a single IP address.

0

max-concurrent-request-restful <limit_int>

Enter the maximum number of concurrent RESTful requests.

20

max-concurrent-request-webmail <limit_int>

Enter the maximum number of concurrent webmail portal requests.

200

max-request-rate-admin <limit_int>

Enter the maximum request rate (per second) for administrators.

0

max-request-rate-ms365 <limit_int>

Enter the maximum request rate (per second) for Microsoft Office 365.

100

max-request-rate-restful <limit_int>

Enter the maximum request rate (per second) for the REST API.

50

max-request-rate-webmail <limit_int>

Enter the maximum request rate (per second) for webmail.

0

rest-api-status {enable | disable} Enable or disable REST API access. disable

Related topics

system interface

system web-service

system web-service

Use this command to configure the rate limit for REST APIs, including the maximum concurrent REST API requests (overall and for individual IP addresses), and how fast the system should perform, in terms of how many requests and responses are processed per second. It also configures connections for FortiMail webmail and per-user quarantines.

Valid value ranges for certain commands vary by FortiMail model.

Syntax

config system web-service

config exempt-list

edit <list_index>

set<client_ipv4mask>

next

end

set https-redirect-status {enable | disable}

set https-redirect-host <fortimail_fqdn>

set max-active-session-admin <limit_int>

set max-active-session-restful <limit_int>

set max-concurrent-request-admin <limit_int>

set max-concurrent-request-all <limit_int>

set max-concurrent-request-ms365 <limit_int>

set max-concurrent-request-per-ip <limit_int

set max-concurrent-request-restful <limit_int>

set max-concurrent-request-webmail <limit_int>

set max-request-rate-admin <limit_int>

set max-request-rate-ms365 <limit_int>

set max-request-rate-restful <limit_int>

set max-request-rate-webmail <limit_int>

set rest-api-status {enable | disable}

end

Variable

Description

Default

<list_index>

Configure exempt lists of IP addresses that you want to exempt from rate limits.

<client_ipv4mask>

Enter an IP address and netmask that you want to exempt from rate limits.

https-redirect-status {enable | disable}

Enable to redirect insecure HTTP requests to secure access using HTTPS.

This setting affects all FortiMail URLs: REST APIs, administrator GUI, FortiMail webmail, and per-user quarantines.

Note: For this setting to take effect, you must also enable both HTTP and HTTPS access protocols on the network interface(s) that receive these connections. FortiMail cannot redirect HTTP if it is not listening for it.

enable

https-redirect-host <fortimail_fqdn>

Enter the fully qualified domain name (FQDN) to use in HTTPS redirects.

max-active-session-admin <limit_int>

Enter the maximum number of active administrator sessions.

200

max-active-session-restful <limit_int>

Enter the maximum number of active RESTful sessions.

10

max-concurrent-request-admin <limit_int>

Enter the maximum number of concurrent admin portal requests.

50

max-concurrent-request-all <limit_int>

Enter the maximum number of concurrent HTTP requests from all clients.

0

max-concurrent-request-ms365 <limit_int>

Enter the maximum number of concurrent Microsoft Office 365 requests permitted.

100

max-concurrent-request-per-ip <limit_int

Enter the maximum number of concurrent HTTP requests for a single IP address.

0

max-concurrent-request-restful <limit_int>

Enter the maximum number of concurrent RESTful requests.

20

max-concurrent-request-webmail <limit_int>

Enter the maximum number of concurrent webmail portal requests.

200

max-request-rate-admin <limit_int>

Enter the maximum request rate (per second) for administrators.

0

max-request-rate-ms365 <limit_int>

Enter the maximum request rate (per second) for Microsoft Office 365.

100

max-request-rate-restful <limit_int>

Enter the maximum request rate (per second) for the REST API.

50

max-request-rate-webmail <limit_int>

Enter the maximum request rate (per second) for webmail.

0

rest-api-status {enable | disable} Enable or disable REST API access. disable

Related topics

system interface