Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

System Information (/systeminfo/)

URL:  https://[server_name]/api/v1/systeminfo/

This REST API queries the FortiAuthenticator system information.

 

Supported fields

Field Display name Type Required Other restrictions
sn Serial number string Yes Read-only field returned by the GET method.
ha_sn Serial number of other member in redundant HA cluster pair string No

Read-only field returned by the GET method. Only available in HA cluster member mode.

firmware Current firmware version string Yes Read-only field returned by the GET method. e.g. "FACVM v6.4.0-build0888 (GA)"
cpu Current CPU usage percentage (0-100) interger Yes Read-only field returned by the GET method.
memory Current memory usage percentage (0-100) interger Yes Read-only field returned by the GET method.
memory_usage_detail Current memory usage details (total, used) in KB interger Yes Read-only field returned by the GET method.
disk Current disk usage percentage (0-100) interger Yes Read-only field returned by the GET method.
disk_usage_detail Current disk usage details (total, used) in KB interger Yes Read-only field returned by the GET method.

Allowed methods

HTTP method Resource URI Action
GET /api/v1/systeminfo/ Get system information

System Information (/systeminfo/)

URL:  https://[server_name]/api/v1/systeminfo/

This REST API queries the FortiAuthenticator system information.

 

Supported fields

Field Display name Type Required Other restrictions
sn Serial number string Yes Read-only field returned by the GET method.
ha_sn Serial number of other member in redundant HA cluster pair string No

Read-only field returned by the GET method. Only available in HA cluster member mode.

firmware Current firmware version string Yes Read-only field returned by the GET method. e.g. "FACVM v6.4.0-build0888 (GA)"
cpu Current CPU usage percentage (0-100) interger Yes Read-only field returned by the GET method.
memory Current memory usage percentage (0-100) interger Yes Read-only field returned by the GET method.
memory_usage_detail Current memory usage details (total, used) in KB interger Yes Read-only field returned by the GET method.
disk Current disk usage percentage (0-100) interger Yes Read-only field returned by the GET method.
disk_usage_detail Current disk usage details (total, used) in KB interger Yes Read-only field returned by the GET method.

Allowed methods

HTTP method Resource URI Action
GET /api/v1/systeminfo/ Get system information