1. REST API for Session Border Controller Release 8.3
  2. Tasks
  3. system

Get features, licenses and product information

get

https://{managementIp}/rest/{version}/system/features

Retrieves the list of enabled features, entitlements (provisioned and licensed) information, added licenses, and product type for this instance of software and hardware combination. The currently enabled features are based on added licenses.

Request

Path Parameters
Query Parameters
  • In addition to feature information, also retrieve platform access flags information. Platform access flag information is data that is internal to the product and not required by customers.
    Available values: true, false
    Allowed Values: [ true, false ]
Header Parameters
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

401 Response

Unauthorized - Request lacks valid authentication credentials.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

404 Response

Resource not found
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get features, licenses and product 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://10.0.0.2/rest/v1.1/system/features"

Example of Accessing the API with Python

The following example shows how to get features, licenses and product 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://10.0.0.2/rest/v1.1/system/features"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 16 Jan 2019 15:36:06 GMT
Cache-Control: no-cache
Content-Length: 2340
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Wed, 16 Jan 2019 15:36:06 GMT
X-Appweb-Seq: 23

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>
    <sysFeatures>
      <productName>Enterprise Session Border Controller</productName>
      <entitlements>
        <entitlement>
          <name>Advanced</name>
          <value>enabled</value>
        </entitlement>
        <entitlement>
          <name>Admin Security</name>
          <value>disabled</value>
        </entitlement>
        <entitlement>
          <name>Data Integrity (FIPS 140-2)</name>
          <value>disabled</value>
        </entitlement>
        <entitlement>
          <name>Transcode Codec AMR</name>
          <value>enabled</value>
        </entitlement>
        <entitlement>
          <name>Transcode Codec AMRWB</name>
          <value>enabled</value>
        </entitlement>
        <entitlement>
          <name>Transcode Codec EVS</name>
          <value>disabled</value>
        </entitlement>
        <entitlement>
          <name>Session Capacity</name>
          <value>512000</value>
        </entitlement>
        <entitlement>
          <name>Transcode Codec AMR Capacity</name>
          <value>102375</value>
        </entitlement>
        <entitlement>
          <name>Transcode Codec AMRWB Capacity</name>
          <value>102375</value>
        </entitlement>
        <entitlement>
          <name>Transcode Codec EVS Capacity</name>
          <value>0</value>
        </entitlement>
        <entitlement>
          <name>Transcode Codec OPUS Capacity</name>
          <value>0</value>
        </entitlement>
        <entitlement>
          <name>Transcode Codec SILK Capacity</name>
          <value>0</value>
        </entitlement>
      </entitlements>
      <licenses/>
      <features>
        <feature>512000 sessions</feature>
        <feature>SIP</feature>
        <feature>H323</feature>
        <feature>IWF</feature>
        <feature>QOS</feature>
        <feature>ACP</feature>
        <feature>Routing</feature>
        <feature>Load Balancing</feature>
        <feature>Accounting</feature>
        <feature>High Availability</feature>
        <feature>ENUM</feature>
        <feature>NSEP RPH</feature>
        <feature>Transcode Codec AMR (102375 AMR transcoding sessions)</feature>
        <feature>DoS</feature>
        <feature>IPSEC</feature>
        <feature>IPv4-v6 Interworking</feature>
        <feature>IDS</feature>
        <feature>IDS Advanced</feature>
        <feature>Session Recording</feature>
        <feature>Transcode Codec AMR-WB (102375 AMRWB transcoding sessions)</feature>
        <feature>Fraud Protection</feature>
      </features>
    </sysFeatures>
  </data>
  <messages/>
  <links/>
</response>
Back to Top