Get a Configuration Element Instance
post
/{versionId}/configuration/deviceConfigs/{deviceId}/configElements/retrieve
Target and retrieve a specific configuration element instance to modify and submit them. Refer to the Update an Element method for more information about updating this element that you modified and submitted.
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 configuration element instance using curl.
curl -X POST \
-b sessionid.txt \
-d@request.xml \
--header "Accept: application/xml" \
--header "Content-Type: application/xml" \
"https://example.com:8443/rest/v1.3/configuration/deviceConfigs/ID9/configElements/retrieve"The following example shows how to get a configuration element instance using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/ID9/configElements/retrieve"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)Example of the Request Body
The following example shows the contents of the request body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configElement>
<elementTypePath>realmConfig</elementTypePath>
<attributes>
<name>id</name>
<value>rcheck2</value>
</attributes>
</configElement>The following example shows the contents of the request body in JSON.
{
"attributes": [{
"name": "id",
"value": "realmconfig1"
}],
"childrenElements": [{
"attributes": [],
"elementTypePath": "realmConfig/networkInterfaceId"
}],
"elementTypePath": "realmConfig"
}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"?>
<configElement>
<attributes>
<name>tcpInitialGuardTimer</name>
<value>-1</value>
</attributes>
<attributes>
<name>parent</name>
<value></value>
</attributes>
<attributes>
<name>codecPolicyInNetwork</name>
<value>enabled</value>
</attributes>
<attributes>
<name>dtlsSrtpProfile</name>
<value></value>
</attributes>
<attributes>
<name>trunkContext</name>
<value></value>
</attributes>
<attributes>
<name>qosConstraintName</name>
<value></value>
</attributes>
<attributes>
<name>stunEnable</name>
<value>disabled</value>
</attributes>
<attributes>
<name>deviceId</name>
<value></value>
</attributes>
<attributes>
<name>symmetricLatching</name>
<value>disabled</value>
</attributes>
<attributes>
<name>maxPacketLoss</name>
<value>0</value>
</attributes>
<attributes>
<name>windowSize</name>
<value>0</value>
</attributes>
<attributes>
<name>smIcsiMatchForInvite</name>
<value></value>
</attributes>
<attributes>
<name>hmrString</name>
<value></value>
</attributes>
<attributes>
<name>rtcpPolicy</name>
<value></value>
</attributes>
<attributes>
<name>subsqGuardTimer</name>
<value>-1</value>
</attributes>
<attributes>
<name>fallbackBandwidth</name>
<value>0</value>
</attributes>
<attributes>
<name>options</name>
<value></value>
</attributes>
<attributes>
<name>delayedMediaUpdate</name>
<value>disabled</value>
</attributes>
<attributes>
<name>id</name>
<value>rcheck2</value>
</attributes>
<attributes>
<name>monthlyMinutes</name>
<value>0</value>
</attributes>
<attributes>
<name>natTrustThreshold</name>
<value>0</value>
</attributes>
<attributes>
<name>icmpDetectMultip</name>
<value>0</value>
</attributes>
<attributes>
<name>dnsRealm</name>
<value></value>
</attributes>
<attributes>
<name>stiAttest</name>
<value>C</value>
</attributes>
<attributes>
<name>sipProfile</name>
<value></value>
</attributes>
<attributes>
<name>smIcsiMatchForMessage</name>
<value></value>
</attributes>
<attributes>
<name>inManipulationId</name>
<value></value>
</attributes>
<attributes>
<name>rtcpMux</name>
<value>disabled</value>
</attributes>
<attributes>
<name>userCacBandwidth</name>
<value>0</value>
</attributes>
<attributes>
<name>splOptions</name>
<value></value>
</attributes>
<attributes>
<name>intranslationId</name>
<value></value>
</attributes>
<attributes>
<name>preferredNetworkAddrType</name>
<value>none</value>
</attributes>
<attributes>
<name>tcpSubsqGuardTimer</name>
<value>-1</value>
</attributes>
<attributes>
<name>defaultLocationString</name>
<value></value>
</attributes>
<attributes>
<name>mediaPolicy</name>
<value></value>
</attributes>
<attributes>
<name>outManipulationId</name>
<value></value>
</attributes>
<attributes>
<name>mergeEarlyDialogs</name>
<value>disabled</value>
</attributes>
<attributes>
<name>earlyMediaAllow</name>
<value></value>
</attributes>
<attributes>
<name>maxBandwidth</name>
<value>0</value>
</attributes>
<attributes>
<name>denyTimer</name>
<value>30</value>
</attributes>
<attributes>
<name>srvccTrfo</name>
<value></value>
</attributes>
<attributes>
<name>untrustedCacFailThreshold</name>
<value>0</value>
</attributes>
<attributes>
<name>errMsgThreshold</name>
<value>0</value>
</attributes>
<attributes>
<name>subscriptionInfo</name>
<value>END_USER_NONE</value>
</attributes>
<attributes>
<name>mrInNetwork</name>
<value>enabled</value>
</attributes>
<attributes>
<name>mediaSecPolicy</name>
<value></value>
</attributes>
<attributes>
<name>initialGuardTimer</name>
<value>-1</value>
</attributes>
<attributes>
<name>featureTrfo</name>
<value></value>
</attributes>
<attributes>
<name>codecPolicy</name>
<value></value>
</attributes>
<attributes>
<name>holdReferReinvite</name>
<value>disabled</value>
</attributes>
<attributes>
<name>tcpFlowTimeLimit</name>
<value>-1</value>
</attributes>
<attributes>
<name>rateLimit</name>
<value>0</value>
</attributes>
<attributes>
<name>flowTimeLimit</name>
<value>-1</value>
</attributes>
<attributes>
<name>dataVersion</name>
<value></value>
</attributes>
<attributes>
<name>srtpMsmPassthrough</name>
<value>disabled</value>
</attributes>
<attributes>
<name>noRtcp</name>
<value>disabled</value>
</attributes>
<attributes>
<name>trustLevel</name>
<value>none</value>
</attributes>
<attributes>
<name>constraintName</name>
<value></value>
</attributes>
<attributes>
<name>diamE2AddrRealm</name>
<value></value>
</attributes>
<attributes>
<name>stunChangedPort</name>
<value>3479</value>
</attributes>
<attributes>
<name>stiVstarget</name>
<value>sticheck1</value>
</attributes>
<attributes>
<name>icmpAdvInterval</name>
<value>0</value>
</attributes>
<attributes>
<name>bwManager</name>
<value></value>
</attributes>
<attributes>
<name>mmInSystem</name>
<value>enabled</value>
</attributes>
<attributes>
<name>nodeFunctionality</name>
<value></value>
</attributes>
<attributes>
<name>referNotifyProvisional</name>
<value>none</value>
</attributes>
<attributes>
<name>mrInRealm</name>
<value>disabled</value>
</attributes>
<attributes>
<name>waitTimeForInvalidRegister</name>
<value>0</value>
</attributes>
<attributes>
<name>outtranslationId</name>
<value></value>
</attributes>
<attributes>
<name>maxMsgThreshold</name>
<value>0</value>
</attributes>
<attributes>
<name>hideEgressMediaUpdate</name>
<value>disabled</value>
</attributes>
<attributes>
<name>maxPriorityBandwidth</name>
<value>0</value>
</attributes>
<attributes>
<name>teamsFqdnInUri</name>
<value>disabled</value>
</attributes>
<attributes>
<name>codecPolicyInRealm</name>
<value>disabled</value>
</attributes>
<attributes>
<name>sessionRecordingServerTarget</name>
<value></value>
</attributes>
<attributes>
<name>maxEndPointsPerNat</name>
<value>0</value>
</attributes>
<attributes>
<name>userCacMode</name>
<value>none</value>
</attributes>
<attributes>
<name>isMSMRelease</name>
<value>disabled</value>
</attributes>
<attributes>
<name>callRecordingServerId</name>
<value></value>
</attributes>
<attributes>
<name>referCallTransfer</name>
<value>disabled</value>
</attributes>
<attributes>
<name>stiAstarget</name>
<value>sticheck1</value>
</attributes>
<attributes>
<name>maxMsgThresholdUntrusted</name>
<value>0</value>
</attributes>
<attributes>
<name>netMgmtCtrl</name>
<value>disabled</value>
</attributes>
<attributes>
<name>enforcementProfile</name>
<value></value>
</attributes>
<attributes>
<name>iceProfile</name>
<value></value>
</attributes>
<attributes>
<name>tcpMediaProfile</name>
<value></value>
</attributes>
<attributes>
<name>sipIsupProfile</name>
<value></value>
</attributes>
<attributes>
<name>cacFailThreshold</name>
<value>0</value>
</attributes>
<attributes>
<name>usersite</name>
<value></value>
</attributes>
<attributes>
<name>sessionRecordingRequired</name>
<value>disabled</value>
</attributes>
<attributes>
<name>restrictedLatching</name>
<value>none</value>
</attributes>
<attributes>
<name>classProfile</name>
<value></value>
</attributes>
<attributes>
<name>userCacSessions</name>
<value>0</value>
</attributes>
<attributes>
<name>dynReferTerm</name>
<value>disabled</value>
</attributes>
<attributes>
<name>qosEnable</name>
<value>disabled</value>
</attributes>
<attributes>
<name>maxLatency</name>
<value>0</value>
</attributes>
<attributes>
<name>description</name>
<value></value>
</attributes>
<attributes>
<name>restrictionMask</name>
<value>32</value>
</attributes>
<attributes>
<name>stunServerPort</name>
<value>3478</value>
</attributes>
<attributes>
<name>stiSignalingAttest</name>
<value>disabled</value>
</attributes>
<attributes>
<name>manipPattern</name>
<value></value>
</attributes>
<attributes>
<name>stunServerIp</name>
<value>0.0.0.0</value>
</attributes>
<attributes>
<name>sdpInactiveOnly</name>
<value>disabled</value>
</attributes>
<attributes>
<name>maxJitter</name>
<value>0</value>
</attributes>
<attributes>
<name>paiStrip</name>
<value>disabled</value>
</attributes>
<attributes>
<name>sessionMaxLifeLimit</name>
<value>0</value>
</attributes>
<attributes>
<name>acctEnable</name>
<value>enabled</value>
</attributes>
<attributes>
<name>nsepMediaPolicy</name>
<value></value>
</attributes>
<attributes>
<name>altFamilyRealm</name>
<value></value>
</attributes>
<attributes>
<name>teamsFqdn</name>
<value></value>
</attributes>
<attributes>
<name>lastModifiedDate</name>
<value>2022-04-14 17:22:37</value>
</attributes>
<attributes>
<name>addrPrefix</name>
<value></value>
</attributes>
<attributes>
<name>lastModifiedBy</name>
<value>NNC_admin_10.0.16.84</value>
</attributes>
<attributes>
<name>icmpTargetIp</name>
<value></value>
</attributes>
<attributes>
<name>nonMmBwCAC</name>
<value>disabled</value>
</attributes>
<attributes>
<name>natInvalidMsgThreshold</name>
<value>0</value>
</attributes>
<attributes>
<name>mmSameIp</name>
<value>enabled</value>
</attributes>
<attributes>
<name>stunChangedIp</name>
<value>0.0.0.0</value>
</attributes>
<attributes>
<name>stiOrigId</name>
<value></value>
</attributes>
<childrenElements>
<attributes>
<name>subPortId</name>
<value>0</value>
</attributes>
<attributes>
<name>name</name>
<value>M01</value>
</attributes>
<attributes>
<name>family</name>
<value>4</value>
</attributes>
<elementTypePath>realmConfig/networkInterfaceId</elementTypePath>
</childrenElements>
<elementTypePath>realmConfig</elementTypePath>
</configElement>The following example shows the contents of the response body in JSON.
{
"attributes": [{
"name": "tcpInitialGuardTimer",
"value": "-1"
},{
"name": "parent",
"value": ""
},{
"name": "codecPolicyInNetwork",
"value": "enabled"
},{
"name": "dtlsSrtpProfile",
"value": ""
},{
"name": "trunkContext",
"value": ""
},{
"name": "qosConstraintName",
"value": ""
},{
"name": "stunEnable",
"value": "disabled"
},{
"name": "deviceId",
"value": ""
},{
"name": "symmetricLatching",
"value": "disabled"
},{
"name": "maxPacketLoss",
"value": "0"
},{
"name": "windowSize",
"value": "0"
},{
"name": "smIcsiMatchForInvite",
"value": ""
},{
"name": "hmrString",
"value": ""
},{
"name": "rtcpPolicy",
"value": ""
},{
"name": "subsqGuardTimer",
"value": "-1"
},{
"name": "fallbackBandwidth",
"value": "0"
},{
"name": "options",
"value": ""
},{
"name": "delayedMediaUpdate",
"value": "disabled"
},{
"name": "id",
"value": "realmconfig1"
},{
"name": "monthlyMinutes",
"value": "0"
},{
"name": "natTrustThreshold",
"value": "0"
},{
"name": "icmpDetectMultip",
"value": "0"
},{
"name": "rbtTrigger",
"value": "none"
},{
"name": "dnsRealm",
"value": ""
},{
"name": "stiAttest",
"value": ""
},{
"name": "sipProfile",
"value": ""
},{
"name": "smIcsiMatchForMessage",
"value": ""
},{
"name": "inManipulationId",
"value": ""
},{
"name": "stiAsTarget",
"value": ""
},{
"name": "rtcpMux",
"value": "disabled"
},{
"name": "userCacBandwidth",
"value": "0"
},{
"name": "splOptions",
"value": ""
},{
"name": "intranslationId",
"value": ""
},{
"name": "preferredNetworkAddrType",
"value": "none"
},{
"name": "tcpSubsqGuardTimer",
"value": "-1"
},{
"name": "defaultLocationString",
"value": ""
},{
"name": "mediaPolicy",
"value": ""
},{
"name": "outManipulationId",
"value": ""
},{
"name": "mergeEarlyDialogs",
"value": "disabled"
},{
"name": "earlyMediaAllow",
"value": ""
},{
"name": "maxBandwidth",
"value": "0"
},{
"name": "denyTimer",
"value": "30"
},{
"name": "srvccTrfo",
"value": ""
},{
"name": "untrustedCacFailThreshold",
"value": "0"
},{
"name": "errMsgThreshold",
"value": "0"
},{
"name": "subscriptionInfo",
"value": "END_USER_NONE"
},{
"name": "mrInNetwork",
"value": "enabled"
},{
"name": "mediaSecPolicy",
"value": ""
},{
"name": "initialGuardTimer",
"value": "-1"
},{
"name": "ringbackFile",
"value": ""
},{
"name": "featureTrfo",
"value": ""
},{
"name": "codecPolicy",
"value": ""
},{
"name": "holdReferReinvite",
"value": "disabled"
},{
"name": "tcpFlowTimeLimit",
"value": "-1"
},{
"name": "rateLimit",
"value": "0"
},{
"name": "flowTimeLimit",
"value": "-1"
},{
"name": "dataVersion",
"value": ""
},{
"name": "srtpMsmPassthrough",
"value": "disabled"
},{
"name": "noRtcp",
"value": "disabled"
},{
"name": "trustLevel",
"value": "none"
},{
"name": "constraintName",
"value": ""
},{
"name": "diamE2AddrRealm",
"value": ""
},{
"name": "stunChangedPort",
"value": "3479"
},{
"name": "icmpAdvInterval",
"value": "0"
},{
"name": "bwManager",
"value": ""
},{
"name": "mmInSystem",
"value": "enabled"
},{
"name": "nodeFunctionality",
"value": ""
},{
"name": "referNotifyProvisional",
"value": "none"
},{
"name": "mrInRealm",
"value": "disabled"
},{
"name": "waitTimeForInvalidRegister",
"value": "0"
},{
"name": "outtranslationId",
"value": ""
},{
"name": "maxMsgThreshold",
"value": "0"
},{
"name": "hideEgressMediaUpdate",
"value": "disabled"
},{
"name": "maxPriorityBandwidth",
"value": "0"
},{
"name": "teamsFqdnInUri",
"value": "disabled"
},{
"name": "codecPolicyInRealm",
"value": "disabled"
},{
"name": "sessionRecordingServerTarget",
"value": ""
},{
"name": "maxEndPointsPerNat",
"value": "0"
},{
"name": "userCacMode",
"value": "none"
},{
"name": "isMSMRelease",
"value": "disabled"
},{
"name": "callRecordingServerId",
"value": ""
},{
"name": "referCallTransfer",
"value": "disabled"
},{
"name": "maxMsgThresholdUntrusted",
"value": "0"
},{
"name": "netMgmtCtrl",
"value": "disabled"
},{
"name": "enforcementProfile",
"value": ""
},{
"name": "iceProfile",
"value": ""
},{
"name": "tcpMediaProfile",
"value": ""
},{
"name": "sipIsupProfile",
"value": ""
},{
"name": "cacFailThreshold",
"value": "0"
},{
"name": "usersite",
"value": ""
},{
"name": "sessionRecordingRequired",
"value": "disabled"
},{
"name": "restrictedLatching",
"value": "none"
},{
"name": "classProfile",
"value": ""
},{
"name": "userCacSessions",
"value": "0"
},{
"name": "dynReferTerm",
"value": "disabled"
},{
"name": "qosEnable",
"value": "disabled"
},{
"name": "maxLatency",
"value": "0"
},{
"name": "description",
"value": ""
},{
"name": "restrictionMask",
"value": "32"
},{
"name": "stunServerPort",
"value": "3478"
},{
"name": "stiSignalingAttest",
"value": "disabled"
},{
"name": "manipPattern",
"value": ""
},{
"name": "stunServerIp",
"value": "0.0.0.0"
},{
"name": "sdpInactiveOnly",
"value": "disabled"
},{
"name": "maxJitter",
"value": "0"
},{
"name": "paiStrip",
"value": "disabled"
},{
"name": "sessionMaxLifeLimit",
"value": "0"
},{
"name": "acctEnable",
"value": "enabled"
},{
"name": "altFamilyRealm",
"value": ""
},{
"name": "teamsFqdn",
"value": ""
},{
"name": "lastModifiedDate",
"value": "2022-10-03 06:57:06"
},{
"name": "addrPrefix",
"value": ""
},{
"name": "lastModifiedBy",
"value": "NNC_admin_10.4.4.102"
},{
"name": "icmpTargetIp",
"value": ""
},{
"name": "nonMmBwCAC",
"value": "disabled"
},{
"name": "natInvalidMsgThreshold",
"value": "0"
},{
"name": "stiVsTarget",
"value": ""
},{
"name": "mmSameIp",
"value": "enabled"
},{
"name": "stunChangedIp",
"value": "0.0.0.0"
},{
"name": "stiOrigId",
"value": ""
}],
"childrenElements": [{
"attributes": [{
"name": "subPortId",
"value": "0"
},{
"name": "name",
"value": "lo0"
},{
"name": "family",
"value": "4"
}],
"elementTypePath": "realmConfig/networkInterfaceId"
}],
"elementTypePath": "realmConfig"
}