Fortinet white logo
Fortinet white logo

SysGlobal

SysGlobal

System-wide settings such as the authentication session idle timeout. For descriptions, see the FortiRecorder Administration Guide.

Permissions required include System access.

HTTP Methods
  • GET

  • PUT

URL
https://HOST_OR_IP/api/v1/SysGlobal/
Request JSON

For GET requests, leave the request body empty.

For PUT requests, configure only settings that you want to change. Omit others. For example:

{
    "admin_lockout_threshold": 5
}

For a list of available settings, use HTTP GET.

Response JSON

For PUT requests, responses vary by which settings you changed.

For GET requests, responses are like the following. (The list is not exhaustive.)

{
    "objectID": "SysGlobal:",
    "reqAction": 1,
    "nodePermission": 3,
    "default_certificate": "Factory",
    "hostname": "FK400D3016000001",
    "local_domain_name": "",
    "admin_timeout": 120,
    "pki_mode": true,
    "pki_certificate_req": 0,
    "lcd_protection": false,
    "lcd_pin": "******",
    "disk_monitor": false,
    "pre_login_banner": 0,
    "post_login_banner": 0,
    "ldap_sess_cache_enable": true,
    "ldap_worker_threads": 15,
    "set_strong_crypto": 1,
    "ssl_versions": 28,
    "port_http": 80,
    "port_https": 443,
    "port_ssh": 22,
    "port_telnet": 23,
    "admin_scp": true,
    "iscsi_initiator_name": "iqn.2011-08.com.fortirecorder:5a79d1157d",
    "ldap_server_sys_status": true,
    "dh_params": 1024,
    "tftp": true,
    "rest_api": true,
    "fabric_api_token": "6^7^5#I9ba83mD$my+VUMv3qQVX$j75!",
    "cloud_acct_id": "",
    "admin_lockout_threshold": 3,
    "admin_lockout_duration": 3,
    "admin_maintainer": true,
    "hsts_max_age": 365,
    "csrf_token": true,
    "public_address": "nvr.example.com",
    "public_https_port": 443,
    "public_http_port": 80,
    "public_rtsp_port": 554,
    "public_ftp_port": 21,
    "public_frc_central_port": 8550,
    "public_notify_tcp_port": 3010,
    "public_notify_http_port": 3011,
    "HLS_over_HTTP": 0,
    "port_frc_central": 8550,
    "frc_central_secure": false,
    "port_rtsp": 554,
    "automatic_camera_add": true,
    "cors_address": "",
    "chromecast_appid": "AD3B8D83",
    "chromecast_http": false,
    "chromecast_delay": 0,
    "show_topology": false,
    "clip_extraction_threads": 1,
    "face_recognition": true,
    "strong_crypto_notification": false,
    "override_cloud_status": false,
    "override_cloud_tunnel_address": "0.0.0.0",
    "override_cloud_signal_address": "0.0.0.0",
    "override_cloud_tunnel_port": 10000,
    "override_cloud_signal_port": 61614,
    "cloud_region": "",
    "fortirecorder_id": "9223653511831489586",
    "tags": ""
}

where attributes often self-explanatory, except:

  • set_strong_crypto — Whether or not strong encryption is required (this deprecates ciphers and older protocol versions with known weaknesses and vulnerabilities):

    • 0 — Disabled.

    • 1 — Enabled.

  • pre-login-banner — Whether or not to show the legal disclaimer before a user or administrator logs into the GUI:

    • 0 — Disabled.

    • 1 — Enabled.

Example: Get global settings for FortiRecorder

curl -X GET -H "Content-Type:application/json" -b cookie.txt https://HOST_OR_IP/api/v1/SysGlobal/

SysGlobal

SysGlobal

System-wide settings such as the authentication session idle timeout. For descriptions, see the FortiRecorder Administration Guide.

Permissions required include System access.

HTTP Methods
  • GET

  • PUT

URL
https://HOST_OR_IP/api/v1/SysGlobal/
Request JSON

For GET requests, leave the request body empty.

For PUT requests, configure only settings that you want to change. Omit others. For example:

{
    "admin_lockout_threshold": 5
}

For a list of available settings, use HTTP GET.

Response JSON

For PUT requests, responses vary by which settings you changed.

For GET requests, responses are like the following. (The list is not exhaustive.)

{
    "objectID": "SysGlobal:",
    "reqAction": 1,
    "nodePermission": 3,
    "default_certificate": "Factory",
    "hostname": "FK400D3016000001",
    "local_domain_name": "",
    "admin_timeout": 120,
    "pki_mode": true,
    "pki_certificate_req": 0,
    "lcd_protection": false,
    "lcd_pin": "******",
    "disk_monitor": false,
    "pre_login_banner": 0,
    "post_login_banner": 0,
    "ldap_sess_cache_enable": true,
    "ldap_worker_threads": 15,
    "set_strong_crypto": 1,
    "ssl_versions": 28,
    "port_http": 80,
    "port_https": 443,
    "port_ssh": 22,
    "port_telnet": 23,
    "admin_scp": true,
    "iscsi_initiator_name": "iqn.2011-08.com.fortirecorder:5a79d1157d",
    "ldap_server_sys_status": true,
    "dh_params": 1024,
    "tftp": true,
    "rest_api": true,
    "fabric_api_token": "6^7^5#I9ba83mD$my+VUMv3qQVX$j75!",
    "cloud_acct_id": "",
    "admin_lockout_threshold": 3,
    "admin_lockout_duration": 3,
    "admin_maintainer": true,
    "hsts_max_age": 365,
    "csrf_token": true,
    "public_address": "nvr.example.com",
    "public_https_port": 443,
    "public_http_port": 80,
    "public_rtsp_port": 554,
    "public_ftp_port": 21,
    "public_frc_central_port": 8550,
    "public_notify_tcp_port": 3010,
    "public_notify_http_port": 3011,
    "HLS_over_HTTP": 0,
    "port_frc_central": 8550,
    "frc_central_secure": false,
    "port_rtsp": 554,
    "automatic_camera_add": true,
    "cors_address": "",
    "chromecast_appid": "AD3B8D83",
    "chromecast_http": false,
    "chromecast_delay": 0,
    "show_topology": false,
    "clip_extraction_threads": 1,
    "face_recognition": true,
    "strong_crypto_notification": false,
    "override_cloud_status": false,
    "override_cloud_tunnel_address": "0.0.0.0",
    "override_cloud_signal_address": "0.0.0.0",
    "override_cloud_tunnel_port": 10000,
    "override_cloud_signal_port": 61614,
    "cloud_region": "",
    "fortirecorder_id": "9223653511831489586",
    "tags": ""
}

where attributes often self-explanatory, except:

  • set_strong_crypto — Whether or not strong encryption is required (this deprecates ciphers and older protocol versions with known weaknesses and vulnerabilities):

    • 0 — Disabled.

    • 1 — Enabled.

  • pre-login-banner — Whether or not to show the legal disclaimer before a user or administrator logs into the GUI:

    • 0 — Disabled.

    • 1 — Enabled.

Example: Get global settings for FortiRecorder

curl -X GET -H "Content-Type:application/json" -b cookie.txt https://HOST_OR_IP/api/v1/SysGlobal/