System Information

get

/v1/admin/system/system_info

This API gets the Site's System Information like software version, mode, siteName, etc.

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

Result OK

401 Response

Unauthorized - Request lacks valid authentication credentials.

403 Response

This request requires the client credentials to have administrator privileges.

405 Response

Invalid request method
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to gets the Site's system information like software version, mode, siteName, etc. by submitting a GET request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X GET \
    -b cookies.txt \
    "https://$IPADDR/v1/admin/system/system_info"

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 16 Dec 2020 22:43:55 GMT
Server: Apache/2.4.6 () OpenSSL/1.0.2k-fips mod_fcgid/2.3.9 PHP/5.4.40
Vary: Accept-Encoding
X-UA-Compatible: IE=Edge,chrome=1
Transfer-Encoding: chunked
Content-Type: application/json; charset=ISO-8859-1

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "status": "success",
  "data": [
    [
      {
        "systemInfo": [
          [
            {
              "isDisabled": 1
            },
            {
              "mode": "Client"
            },
            {
              "siteName": "Client-1"
            },
            {
              "SD-WAN Edge Mode": "Client"
            },
            {
              "ManagementIP": "10.0.0.170"
            },
            {
              "Hardware Model": "E1000"
            },
            {
              "Software Version": "9.1.0.0.0"
            },
            {
              "Software Build Label": "R9_0_1_0_0_QA_BUGFIX_09042020"
            },
            {
              "OS Partition Version": "7.0.0.0.0"
            },
            {
              "OS Build Label": "OS_7_0_0_0_0_GA_09132019"
            },
            {
              "Serial Number": "E20109170040"
            },
            {
              "BIOS version": "2.0b"
            }
          ]
        ]
      }
    ]
  ]
}
Back to Top