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