1. REST API for Session Delivery Manager Release 9.0.1 and newer
  2. Tasks
  3. route sets management

Update SBC Devices with Route Set

post

/{versionId}/routeSets/{routeSetId}/devices/action

Update a subset of associated SBC devices with new route set. Users provide route set ID to be updated on devices as part of the URI and list of devices to be updated along with the type of action (Update) in request method body.

Request

Path Parameters
Back to Top

Response

200 Response

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a session cookie.

The following example shows how to update specified SBC devices with specified route set using curl.

curl -X POST \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    --header "Content-Type: application/xml" \
    "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}/devices/action"

The following example shows how to update specified SBC devices with specified route set using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}/devices/action"
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"?>
<routeUpdate>
  <deviceGroups>
    <deviceGroup>
      <deviceGroupId>ID5</deviceGroupId>
    </deviceGroup>
  </deviceGroups>
  <action>Update</action>
  <failureAction>rollback</failureAction>
</routeUpdate>

The following example shows the contents of the request body in JSON.

{
  "deviceGroups": {
    "deviceGroup": {
      "deviceGroupId": "ID13"
    }
  },
  "action": "Update",
  "failureAction": "rollback"
}

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"?>
<routeUpdateTask>
  <initiatedDate>2022-10-04T04:11:01</initiatedDate>
  <notes></notes>
  <devices>sd177</devices>
  <routeSets>COPY_TESTw2w2</routeSets>
  <rollbackStatus>Unknown</rollbackStatus>
  <updateStatus></updateStatus>
  <name>Update 2022-10-04 04:11:01</name>
  <failureAction>rollback</failureAction>
  <objectId>ID36</objectId>
  <initiatedBy>admin</initiatedBy>
</routeUpdateTask>

The following example shows the contents of the response body in JSON.

{
  "devices": "sd177",
  "failureAction": "rollback",
  "initiatedBy": "admin",
  "initiatedDate": "2022-10-04T04:11:01",
  "name": "Update 2022-10-04 04:11:01",
  "objectId": "ID36",
  "rollbackStatus": "Unknown",
  "routeSets": "COPY_TESTw2w2"
}
Back to Top