1. REST API for Session Delivery Manager Release 9.0
  2. Tasks
  3. device configuration

Add a configuration element

post

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

Use this (POST) method to add a configuration element to a targeted device configuration. The element is added to the SDM database and is not pushed to the device until a device action is initiated. Refer to the Perform a Device Action (POST) method for more information.

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.
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to add 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 \
    -d@request.xml \
    --header "Accept: application/xml" \
    --header "Content-Type: application/xml" \
    "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/ID9/configElements/add"

The following shows an example of the contents of the request.json file sent as the request body. 

<?xml version="1.0" encoding="UTF-8"?>
<configElement>
  <elementTypePath>sessionAgentGroup/sipDest</elementTypePath>
  <attributes>
    <attribute>
      <name>name</name>
      <value>session-agent3</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-agent3</value>
          </attribute>
        </attributes>
      </childrenElement>
    </childrenElements>
  </parentElement>
</configElement>

Example of Accessing the API with Python

The following example shows how to add 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
from lxml import etree
url = "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/ID9/configElements/add"
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 Response Body

The following example shows the contents of the response body in XML format.

<configElement>
  <attributes>
    <attribute>
      <name>sagRecurse</name>
      <value>disabled</value>
    </attribute>
    <attribute>
      <name>protocol</name>
      <value>SIP</value>
    </attribute>
    <attribute>
      <name>lastModifiedDate</name>
      <value>2021-02-04&#xA0;18:07:16</value>
    </attribute>
    <attribute>
      <name>dataVersion</name>
      <value/>
    </attribute>
    <attribute>
      <name>lastModifiedBy</name>
      <value>NNC_admin_10.0.0.19</value>
    </attribute>
    <attribute>
      <name>stopRecurse</name>
      <value>401,407</value>
    </attribute>
    <attribute>
      <name>name</name>
      <value>mysessionagentgroup</value>
    </attribute>
    <attribute>
      <name>description</name>
      <value/>
    </attribute>
    <attribute>
      <name>state</name>
      <value>enabled</value>
    </attribute>
    <attribute>
      <name>strategy</name>
      <value>hunt</value>
    </attribute>
  </attributes>
  <childrenElements>
    <childrenElement>
      <attributes>
        <attribute>
          <name>name</name>
          <value>session-agent3</value>
        </attribute>
      </attributes>
      <elementTypePath>sessionAgentGroup/sipDest</elementTypePath>
    </childrenElement>
  </childrenElements>
  <elementTypePath>sessionAgentGroup</elementTypePath>
</configElement>
Back to Top