Jump to

• Request
• Response
• Examples

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/token request.

Back to Top

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

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get system information by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${HOSTNAME}/rest/v1.1/system/information"

Example of Accessing the API with Python

The following example shows how to get system information by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + hostname + "/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 format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <systemInformation>
      <hostName>PRIMARY</hostName>
      <productName>Acme Packet OS VM</productName>
      <buildVersion>PCZ4.1.0 GA (Build 114)</buildVersion>
      <upTimeSeconds>145636</upTimeSeconds>
      <contact/>
      <location/>
      <name/>
      <serialNum>1111111111111111</serialNum>
    </systemInformation>
  </data>
  <messages/>
  <links/>
</response>

Back to Top