REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 10.0.0

Get system status information

get

/rest/{version}/system/status

Retrieves the system uptime, system health, and HA/redundancy information (if configured as an HA system).

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.

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.

curl
Python

The following example shows how to get system status information using curl.

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

The following example shows how to get system status information using Python.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.1/system/status"
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>
    <uptimeSeconds>146091</uptimeSeconds>
    <hostName>PRIMARY</hostName>
    <systemState>online</systemState>
    <role>standalone</role>
    <healthScorePercent>100</healthScorePercent>
  </data>
  <messages/>
  <links/>
</response>