1. REST API for Session Delivery Manager Release 8.2.5p1
  2. Tasks
  3. device configuration

Get a List of Top-level Configuration Element Types

get

/{versionId}/configuration/deviceConfigs/{deviceId}/elementTypes

Use this (GET) method to retrieve a list of top-level configuration element types that the targeted device release supports. A top-level element can contain several layers of sub-element children but has no parent configuration element. The top level element types can then be used to construct any configuration element that the targeted device release supports by invoking the Add an Element Type (POST) method.

Request

Path Parameters
Back to Top

Response

200 Response

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get a list of top-level 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 \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/ID9/elementTypes"

Example of Accessing the API with Python

The following example shows how to get a list of top-level configuration element types by submitting a GET request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate. 

import requests
url = "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/ID9/elementTypes"
headers = { "Accept":"application/xml", "Cookie":cookie }
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"?>
<elementTypes>
    <types>
        <cliName>security-&gt;media-security-&gt;dtls-srtp-profile</cliName>
        <name>dtlsSrtpProfile</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-q850-map</cliName>
        <name>sipQ850Map</name>
    </types>
    <types>
        <cliName>security-&gt;authentication</cliName>
        <name>authConfig</name>
    </types>
    <types>
        <cliName>media-manager-&gt;dns-config</cliName>
        <name>dnsConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-feature</cliName>
        <name>sipFeature</name>
    </types>
    <types>
        <cliName>security-&gt;auth-params</cliName>
        <name>authParamsConfig</name>
    </types>
    <types>
        <cliName>system-&gt;snmp-community</cliName>
        <name>snmpCommunity</name>
    </types>
    <types>
        <cliName>media-manager-&gt;realm-group</cliName>
        <name>realmGroup</name>
    </types>
    <types>
        <cliName>security-&gt;password-policy</cliName>
        <name>passwordPolicy</name>
    </types>
    <types>
        <cliName>session-router-&gt;sti-server</cliName>
        <name>stiServer</name>
    </types>
    <types>
        <cliName>security-&gt;authentication-profile</cliName>
        <name>authenticationProfile</name>
    </types>
    <types>
        <cliName>system-&gt;spl-config</cliName>
        <name>splConfig</name>
    </types>
    <types>
        <cliName>security-&gt;cert-status-profile</cliName>
        <name>certStatusProfile</name>
    </types>
    <types>
        <cliName>session-router-&gt;session-router</cliName>
        <name>sessionRouter</name>
    </types>
    <types>
        <cliName>session-router-&gt;sti-server-group</cliName>
        <name>stiServerGroup</name>
    </types>
    <types>
        <cliName>media-manager-&gt;steering-pool</cliName>
        <name>steeringPool</name>
    </types>
    <types>
        <cliName>media-manager-&gt;media-policy</cliName>
        <name>mediaPolicy</name>
    </types>
    <types>
        <cliName>session-router-&gt;service-health</cliName>
        <name>serviceHealth</name>
    </types>
    <types>
        <cliName>session-router-&gt;account-config</cliName>
        <name>acctConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;allowed-elements-profile</cliName>
        <name>allowedElementsProfile</name>
    </types>
    <types>
        <cliName>security-&gt;security-config</cliName>
        <name>securityConfig</name>
    </types>
    <types>
        <cliName>security-&gt;tls-profile</cliName>
        <name>tlsProfile</name>
    </types>
    <types>
        <cliName>session-router-&gt;rph-profile</cliName>
        <name>rphProfile</name>
    </types>
    <types>
        <cliName>system-&gt;snmp-address-entry</cliName>
        <name>snmpAddressEntry</name>
    </types>
    <types>
        <cliName>session-router-&gt;session-group</cliName>
        <name>sessionAgentGroup</name>
    </types>
    <types>
        <cliName>session-router-&gt;enum-config</cliName>
        <name>EnumConfig</name>
    </types>
    <types>
        <cliName>media-manager-&gt;static-flow</cliName>
        <name>staticFlow</name>
    </types>
    <types>
        <cliName>system-&gt;http-server</cliName>
        <name>httpServer</name>
    </types>
    <types>
        <cliName>system-&gt;system-config</cliName>
        <name>systemConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-manipulation</cliName>
        <name>sipManipulation</name>
    </types>
    <types>
        <cliName>session-router-&gt;home-subscriber-server</cliName>
        <name>extHssManager</name>
    </types>
    <types>
        <cliName>system-&gt;trap-receiver</cliName>
        <name>trapReceiver</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-profile</cliName>
        <name>sipProfile</name>
    </types>
    <types>
        <cliName>session-router-&gt;q850-sip-map</cliName>
        <name>q850SipMap</name>
    </types>
    <types>
        <cliName>session-router-&gt;translation-rules</cliName>
        <name>translationRules</name>
    </types>
    <types>
        <cliName>session-router-&gt;session-agent</cliName>
        <name>sessionAgent</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-interface</cliName>
        <name>sipInterface</name>
    </types>
    <types>
        <cliName>session-router-&gt;qos-constraints</cliName>
        <name>qosConstraints</name>
    </types>
    <types>
        <cliName>media-manager-&gt;rtcp-policy</cliName>
        <name>rtcpPolicy</name>
    </types>
    <types>
        <cliName>session-router-&gt;session-agent-id-rule</cliName>
        <name>sessionAgentIdentifierRule</name>
    </types>
    <types>
        <cliName>session-router-&gt;iwf-config</cliName>
        <name>IwfStackConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;session-translation</cliName>
        <name>sessionTranslation</name>
    </types>
    <types>
        <cliName>security-&gt;local-accounts</cliName>
        <name>localAccounts</name>
    </types>
    <types>
        <cliName>session-router-&gt;local-routing-config</cliName>
        <name>LocalRoutingConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-recursion-policy</cliName>
        <name>sipRecursionPolicy</name>
    </types>
    <types>
        <cliName>system-&gt;network-parameters</cliName>
        <name>NetworkParameters</name>
    </types>
    <types>
        <cliName>security-&gt;ike-&gt;ike-accounting-param</cliName>
        <name>ikeAcctParam</name>
    </types>
    <types>
        <cliName>media-manager-&gt;tcp-media-profile</cliName>
        <name>tcpMediaProfile</name>
    </types>
    <types>
        <cliName>system-&gt;snmp-user-entry</cliName>
        <name>snmpUserEntry</name>
    </types>
    <types>
        <cliName>media-manager-&gt;codec-policy</cliName>
        <name>codecPolicy</name>
    </types>
    <types>
        <cliName>session-router-&gt;diameter-manipulation</cliName>
        <name>diameterManipulation</name>
    </types>
    <types>
        <cliName>session-router-&gt;local-response-map</cliName>
        <name>sipLocalMap</name>
    </types>
    <types>
        <cliName>system-&gt;phy-interface</cliName>
        <name>phyInterfaceConfig</name>
    </types>
    <types>
        <cliName>system-&gt;network-interface</cliName>
        <name>networkInterface</name>
    </types>
    <types>
        <cliName>session-router-&gt;surrogate-agent</cliName>
        <name>surrogateAgent</name>
    </types>
    <types>
        <cliName>session-router-&gt;lawful-intercept</cliName>
        <name>LiConfig</name>
    </types>
    <types>
        <cliName>system-&gt;ipt-config</cliName>
        <name>iptConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;account-group</cliName>
        <name>acctGroup</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-advanced-logging</cliName>
        <name>sipAdvancedLogging</name>
    </types>
    <types>
        <cliName>session-router-&gt;h323-&gt;h323-config</cliName>
        <name>H323Config</name>
    </types>
    <types>
        <cliName>system-&gt;fraud-protection</cliName>
        <name>fraudProtection</name>
    </types>
    <types>
        <cliName>session-router-&gt;enforcement-profile</cliName>
        <name>enforcementProfile</name>
    </types>
    <types>
        <cliName>security-&gt;ssh-key</cliName>
        <name>sshPubKeyRecord</name>
    </types>
    <types>
        <cliName>security-&gt;certificate-record</cliName>
        <name>certRecord</name>
    </types>
    <types>
        <cliName>session-router-&gt;h323-&gt;h323-stacks</cliName>
        <name>H323StackConfig</name>
    </types>
    <types>
        <cliName>system-&gt;http-client</cliName>
        <name>httpClientConfig</name>
    </types>
    <types>
        <cliName>system-&gt;snmp-group-entry</cliName>
        <name>snmpGroupEntry</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-config</cliName>
        <name>sipConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-nat</cliName>
        <name>sipNatConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;class-profile-&gt;policy</cliName>
        <name>classPolicy</name>
    </types>
    <types>
        <cliName>security-&gt;factory-accounts</cliName>
        <name>factoryAccounts</name>
    </types>
    <types>
        <cliName>media-manager-&gt;dnsalg-constraints</cliName>
        <name>dnsAlgConstraints</name>
    </types>
    <types>
        <cliName>security-&gt;ssh-config</cliName>
        <name>sshConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-feature-caps</cliName>
        <name>sipFeatureCaps</name>
    </types>
    <types>
        <cliName>security-&gt;tls-global</cliName>
        <name>tlsGlobal</name>
    </types>
    <types>
        <cliName>session-router-&gt;survivability</cliName>
        <name>survivability</name>
    </types>
    <types>
        <cliName>session-router-&gt;rph-policy</cliName>
        <name>rphPolicy</name>
    </types>
    <types>
        <cliName>media-manager-&gt;realm-config</cliName>
        <name>realmConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;sti-config</cliName>
        <name>stiConfig</name>
    </types>
    <types>
        <cliName>system-&gt;capture-receiver</cliName>
        <name>captureReceiver</name>
    </types>
    <types>
        <cliName>media-manager-&gt;policy-group</cliName>
        <name>policyGroup</name>
    </types>
    <types>
        <cliName>session-router-&gt;access-control</cliName>
        <name>accessControl</name>
    </types>
    <types>
        <cliName>session-router-&gt;filter-config</cliName>
        <name>filterConfig</name>
    </types>
    <types>
        <cliName>system-&gt;redundancy</cliName>
        <name>RedundancyConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;media-profile</cliName>
        <name>mediaProfile</name>
    </types>
    <types>
        <cliName>media-manager-&gt;ice-profile</cliName>
        <name>iceProfile</name>
    </types>
    <types>
        <cliName>session-router-&gt;ldap-config</cliName>
        <name>ldapConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;s8hr-profile</cliName>
        <name>s8HrProfile</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-response-map</cliName>
        <name>responseMap</name>
    </types>
    <types>
        <cliName>system-&gt;threshold-crossing-alert-group</cliName>
        <name>thresholdCrossingAlertGroup</name>
    </types>
    <types>
        <cliName>system-&gt;system-access-list</cliName>
        <name>sysACL</name>
    </types>
    <types>
        <cliName>session-router-&gt;session-constraints</cliName>
        <name>sessionConstraints</name>
    </types>
    <types>
        <cliName>media-manager-&gt;playback-config</cliName>
        <name>playbackConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;net-management-control</cliName>
        <name>netMgmtCtrl</name>
    </types>
    <types>
        <cliName>session-router-&gt;session-timer-profile</cliName>
        <name>sessionTimerProfile</name>
    </types>
    <types>
        <cliName>system-&gt;host-route</cliName>
        <name>ipRoute</name>
    </types>
    <types>
        <cliName>session-router-&gt;sip-isup-profile</cliName>
        <name>sipIsupProfile</name>
    </types>
    <types>
        <cliName>security-&gt;admin-security-&gt;audit-logging</cliName>
        <name>auditLogging</name>
    </types>
    <types>
        <cliName>system-&gt;snmp-view-entry</cliName>
        <name>snmpViewEntry</name>
    </types>
    <types>
        <cliName>media-manager-&gt;msrp-config</cliName>
        <name>msrpConfig</name>
    </types>
    <types>
        <cliName>session-router-&gt;npli-profile</cliName>
        <name>npliProfile</name>
    </types>
    <types>
        <cliName>session-router-&gt;call-recording-server</cliName>
        <name>callRecordingServer</name>
    </types>
    <types>
        <cliName>session-router-&gt;local-policy</cliName>
        <name>localPolicy</name>
    </types>
    <types>
        <cliName>ntp-sync</cliName>
        <name>ntpConfig</name>
    </types>
    <types>
        <cliName>media-manager-&gt;media-manager</cliName>
        <name>mediaRouter</name>
    </types>
    <types>
        <cliName>session-router-&gt;http-alg</cliName>
        <name>httpAlg</name>
    </types>
</elementTypes>
Back to Top