REST API for Session Delivery Manager Release 8.2.5p1

Delete a Configuration Element

post

/{versionId}/configuration/deviceConfigs/{deviceId}/configElements/delete

Use this (POST) method to 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

deviceId:
versionId:

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

Example of Accessing the API with cURL

The following example shows how to delete a configuration element by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use 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"

Example of Accessing the API with Python

The following example shows how to delete a configuration element by submitting a POST 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/{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 format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configElement>
    <elementTypePath>sessionAgentGroup/sipDest</elementTypePath>
    <attributes>
        <attribute>
            <name>name</name>
            <value>session-agent1</value>
        </attribute>
    </attributes>
    <parentElement>
        <elementTypePath>sessionAgentGroup</elementTypePath>
        <attributes>
            <attribute>
                <name>name</name>
                <value>mysessionagentgroup</value>
            </attribute>
        </attributes>
        <childrenElements>
            <childrenElement>
                <elementTypePath>sessionAgentGroup/sipDest</elementTypePath>
                <attributes>
                    <attribute>
                        <name>name</name>
                        <value>session-agent1</value>
                    </attribute>
                </attributes>    
            </childrenElement>  
        </childrenElements>
    </parentElement>
</configElement>