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

Get a list of all supported configuration element types

get

/rest/{version}/configuration/elementTypes

Retrieves a list of all the configuration element types supported by the target system. The name string returned for each type is the string the client must use in all other REST requests where element type must be supplied. The platform and entitlements affect some of the configuration element types that are available, so the response from one system may not be identical to the response received from a different system.

Request

Path Parameters

version:

REST API version string.
Available values: v1.2

Header Parameters

Authorization:

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

The name and description of each configuration element type supported by the target system is returned in the data section of the response. The string returned as the "name" value must be used by the client in all requests where element type must be supplied. Configuration element types that are singletons are indicated by the elementType attribute single="true".

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

Unsupported versionId in URI.

Examples

Example of Accessing the API with cURL

The following example shows how to get a list of all supported configuration element types 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://${SBCIP}/rest/v1.1/configuration/elementTypes"

Example of Accessing the API with Python

The following example shows how to get a list of all supported configuration element types 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://" + sbcip + "/rest/v1.1/configuration/elementTypes"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200
Server: nginx/1.14.1
Date: Wed, 01 Apr 2020 14:04:09 GMT
Content-Type: application/xml
Transfer-Encoding: chunked
Connection: keep-alive

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>
  <elementType configCount="0" runningConfigCount="0">
    <name>access-control</name>
    <description>configure a static or dynamic access control list</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>account-config</name>
    <description>configure Quality of Service accounting</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>account-group</name>
    <description>configure accounting group</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>allowed-elements-profile</name>
    <description>configure allowed elements profiles</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>audit-logging</name>
    <description>configure audit-logging parameters</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>auth-params</name>
    <description>configure authentication parameters</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>authentication</name>
    <description>configure authentication</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>capture-receiver</name>
    <description>configure packet tracing</description>
  </elementType>
  <elementType configCount="3" runningConfigCount="3">
    <name>certificate-record</name>
    <description>create, generate, and import a certificate</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>class-policy</name>
    <description>configure classification profile policies</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>codec-policy</name>
    <description>create and apply a codec policy to a realm and an agent</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>diameter-manipulation</name>
    <description>configure diameter manipulations</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>dns-alg-constraints</name>
    <description>configure DNS ALG constraints</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>dns-config</name>
    <description>configure DNS</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>dtls-srtp-profile</name>
    <description>configure the parameters for running SRTP over DTLS </description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>enforcement-profile</name>
    <description>configure enforcement profiles </description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>enum-config</name>
    <description>configure enum servers</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>filter-config</name>
    <description>create a custom filter for SIP monitor and trace</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>fraud-protection</name>
    <description>configure fraud protection</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>h323-config</name>
    <description>configure H323 protocol</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>h323-stack</name>
    <description>Configure H.323 stacks</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>home-subscriber-server</name>
    <description>configure home subscriber server</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>host-route</name>
    <description>insert entries into the routing table</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>http-alg</name>
    <description>configure http proxy</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>ice-profile</name>
    <description>configure ICE profile</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>ike-accounting-param</name>
    <description>configure ike accounting param</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>iwf-config</name>
    <description>configure Interworking</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>ldap-config</name>
    <description>configure an LDAP server, filter, and policy</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>local-policy</name>
    <description>configure a session request routing policy</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>local-response-map</name>
    <description>configure Local SIP response maps</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>local-routing-config</name>
    <description>configure local routing servers </description>
  </elementType>
  <elementType single="true" configCount="1" runningConfigCount="1">
    <name>media-manager</name>
    <description>configure media policy, attributes, and settings</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>media-policy</name>
    <description>configure a media profile and apply it to a realm</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>media-profile</name>
    <description>configure a media profile and apply it to a media type</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>msrp-config</name>
    <description>configure MSRP</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>net-management-control</name>
    <description>configure network management controls</description>
  </elementType>
  <elementType configCount="2" runningConfigCount="2">
    <name>network-interface</name>
    <description>configure layer3 network interfaces</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>network-parameters</name>
    <description>configure networking parameters</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>ntp-config</name>
    <description>synchronize the Network Time Protocol among servers and clients</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>password-policy</name>
    <description>configure password policy</description>
  </elementType>
  <elementType configCount="2" runningConfigCount="2">
    <name>phy-interface</name>
    <description>configure physical interfaces</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>playback-config</name>
    <description>configure media playback</description>
  </elementType>
  <elementType configCount="1" runningConfigCount="1">
    <name>public-key</name>
    <description>configure public-key parameters</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>qos-constraints</name>
    <description>configure qos constraints</description>
  </elementType>
  <elementType configCount="2" runningConfigCount="2">
    <name>realm-config</name>
    <description>configure a realm for media management</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>realm-group</name>
    <description>configure realm groups</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>redundancy-config</name>
    <description>configure a routing policy for SIP server failover</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>response-map</name>
    <description>configure SIP response maps</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>rtcp-policy</name>
    <description>configure rtcp policy</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>service-health</name>
    <description>configure Service Health</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>session-agent</name>
    <description>configure session agents</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>session-agent-id-rule</name>
    <description>configure alternative session-agent identification rules</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>session-constraints</name>
    <description>configure session constraints</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>session-group</name>
    <description>configure session agent groups</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>session-recording-group</name>
    <description>configure high availability for third-party call recorders</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>session-recording-server</name>
    <description>enable and disable a session recording server</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>session-timer-profile</name>
    <description>configure session timer profile</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>session-translation</name>
    <description>configure translation rules for calling and called numbers</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>sip-advanced-logging</name>
    <description>Configure logging of specific SIP requests/session by criteria</description>
  </elementType>
  <elementType single="true" configCount="1" runningConfigCount="1">
    <name>sip-config</name>
    <description>configure signaling and session management</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>sip-feature</name>
    <description>configure SIP option tag parameters</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>sip-feature-caps</name>
    <description>configure sip feature-caps</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>sip-interface</name>
    <description>configure sip interfaces</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>sip-manipulation</name>
    <description>configure sip manipulations</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>sip-monitoring</name>
    <description>configure SIP monitor and trace features</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>sip-recursion-policy</name>
    <description>configure sip recursion policy</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>snmp-address-entry</name>
    <description>configure snmp address entries</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>snmp-community</name>
    <description>configure snmp communities</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>snmp-group-entry</name>
    <description>configure snmp group entries</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>snmp-user-entry</name>
    <description>configure snmp user entries</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>snmp-view-entry</name>
    <description>configure snmp view entries</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>spl-config</name>
    <description>add or modify an SPL plug-in</description>
  </elementType>
  <elementType single="true" configCount="1" runningConfigCount="1">
    <name>ssh-config</name>
    <description>configure ssh-config parameters</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>static-flow</name>
    <description>configure static flows</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>steering-pool</name>
    <description>specify one or more ports for steering media flows</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>surrogate-agent</name>
    <description>configure surrogate agents</description>
  </elementType>
  <elementType single="true" configCount="0" runningConfigCount="0">
    <name>survivability</name>
    <description>configure survivability</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>system-access-list</name>
    <description>configure system access control</description>
  </elementType>
  <elementType single="true" configCount="1" runningConfigCount="1">
    <name>system-config</name>
    <description>configure parameters for system-level configuration elements</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>tcp-media-profile</name>
    <description>configure TCP media profile</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>threshold-crossing-alert-group</name>
    <description>configure threshold crossing alert groups</description>
  </elementType>
  <elementType single="true" configCount="1" runningConfigCount="1">
    <name>tls-global</name>
    <description>configure session caching for all TLS functions</description>
  </elementType>
  <elementType configCount="1" runningConfigCount="1">
    <name>tls-profile</name>
    <description>configure the parameters for running SIP over TLS</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>translation-rules</name>
    <description>configure and apply session translation rules to agents and realms</description>
  </elementType>
  <elementType configCount="0" runningConfigCount="0">
    <name>trap-receiver</name>
    <description>configure receiving, logging, and viewing SNMP notifications</description>
  </elementType>
  <elementType single="true" configCount="1" runningConfigCount="1">
    <name>web-server-config</name>
    <description>enable the Web GUI</description>
  </elementType>
 </data>
 <messages/>
 <links/>
</response>