Get a List of Configuration Element Instances
get
/{versionId}/configuration/deviceConfigs/{deviceId}/configElements
Retrieve a list of configuration element instances for a specific element type (refer to Get an Element by Its Type). For example, requesting configuration element instances for NetworkInterface returns all the network-interface instances currently existing in the targeted device configuration.
Request
Path Parameters
Query 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 configuration element instances using curl.
curl -X GET \
-b sessionid.txt \
--header "Accept: application/xml" \
"https://example.com:8443/rest/v1.3/configuration/deviceConfigs/{deviceId}/configElements?elementTypePath=surrogateAgent&limitation=1"The following example shows how to get a list of configuration element instances using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/{deviceId}/configElements?elementTypePath=surrogateAgent&limitation=1"
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"?>
<configElements>
<configElements>
<attributes>
<name>id</name>
<value>rcheck1</value>
</attributes>
<childrenElements>
<attributes>
<name>subPortId</name>
<value>0</value>
</attributes>
<attributes>
<name>name</name>
<value>M00</value>
</attributes>
<attributes>
<name>family</name>
<value>4</value>
</attributes>
<elementTypePath>realmConfig/networkInterfaceId</elementTypePath>
</childrenElements>
<elementTypePath>realmConfig</elementTypePath>
</configElements>
<configElements>
<attributes>
<name>id</name>
<value>rcheck2</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>
</configElements>
<pageInfo>
<limitation>50</limitation>
<numberOfElements>2</numberOfElements>
<offset>1</offset>
</pageInfo>
</configElements>The following example shows the contents of the response body in JSON.
{
"configElements": [
{
"attributes": [
{
"name": "contactHost",
"value": "contact-host"
},
{
"name": "realmID",
"value": "access1"
},
{
"name": "customerRoute",
"value": "next"
},
{
"name": "registerHost",
"value": "host"
},
{
"name": "registerUser",
"value": "user"
},
{
"name": "contactUser",
"value": "contact-user"
}
],
"elementTypePath": "surrogateAgent"
}
],
"pageInfo": {
"limitation": 1,
"numberOfElements": 1,
"offset": 1
}
}