Get system information
get
/rest/{version}/system/information
Retrieves various system information such as product name, build version, system uptime, serial number and other system-related information.
Request
Path Parameters
-
version(required):
REST API version string.
Available values: v1.2
Header Parameters
-
Authorization(required):
The value in the Authorization header must be the string "
Bearer {access token}", where{access token}is a valid, unexpired token received in response to a prior/rest/{version}/auth/tokenrequest.
Response
200 Response
OK - Requested data is returned in response body
400 Response
The request is malformed in some way or is missing required information and therefore cannot be processed.
401 Response
Unauthorized - Request lacks valid authentication credentials.
404 Response
Resource not found
Examples
Examples of Accessing the API
See Authenticate for how to acquire a token.
The following example shows how to get system information using curl.
curl -X GET \
--header "Accept: application/xml" \
--header "Authorization: Bearer $TOKEN" \
"https://${SBCIP}/rest/v1.1/system/information"The following example shows how to get system information using Python.
import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url = "https://" + sbcip + "/rest/v1.1/system/information"
resp = requests.get(url, headers=headers)Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<data>
<systemInformation>
<hostName>PRIMARY</hostName>
<productName>Acme Packet OS VM</productName>
<buildVersion>SCZ8.3.0 GA (Build 41)</buildVersion>
<upTimeSeconds>145636</upTimeSeconds>
<contact/>
<location/>
<name/>
<serialNum>1111111111111111</serialNum>
</systemInformation>
</data>
<messages/>
<links/>
</response>