Delete a Configuration Element
post
/{versionId}/configuration/deviceConfigs/{deviceId}/configElements/delete
Delete the complete targeted configuration element instance. If the configuration element instance has sub-element children, they are also deleted from the targeted device configuration. This deletion is only done on the SDM database and is not pushed to the device. The deletion is not applied to the device until an action method is initiated. Refer to the Perform a Device Action (POST) method for more information.
Request
Path Parameters
Back to Top
Response
200 Response
204 Response
Successfully processed the request with no content.
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 delete a configuration element using curl.
curl -X POST \
-b sessionid.txt \
--header "Accept: application/xml" \
--header "Content-Type: application/xml" \
"https://example.com:8443/rest/v1.3/configuration/deviceConfigs/{deviceId}/configElements/delete"The following example shows how to delete a configuration element using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/{deviceId}/configElements/delete"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.post(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"?>
<configElement>
<elementTypePath>realmConfig</elementTypePath>
<attributes>
<name>id</name>
<value>test</value>
</attributes>
<childrenElements>
<elementTypePath>realmConfig/networkInterfaceId</elementTypePath>
<attributes>
<name>name</name>
<value>M00</value>
</attributes>
<attributes>
<name>subPortId</name>
<value>0</value>
</attributes>
<attributes>
<name>family</name>
<value>4</value>
</attributes>
</childrenElements>
</configElement>The following example shows the contents of the response body in JSON.
{
"elementTypePath": "realmConfig",
"attributes": {
"name": "id",
"value": "testSubelement2"
},
"childrenElements": {
"elementTypePath": "realmConfig/networkInterfaceId",
"attributes": [
{
"name": "name",
"value": "lo0"
},
{
"name": "subPortId",
"value": "0"
},
{
"name": "family",
"value": "4"
}
]
}
}