1. REST API for Session Delivery Manager Release 9.0.1 and newer
  2. Tasks
  3. inventory
  4. device

Lock or Unlock a Device

post

/{versionId}/inventory/deviceMgmt/devices/{deviceId}/action

Apply a device lock on specific devices or unlock a device previously locked by the same user. A lock on a device ensures only the user that applied the lock can run operations on the device. All other users (that is REST, SOAP or GUI) cannot run operations. Locking a device is recommended when clients are starting provisioning sessions and locking ensures that other clients do not compromise the current provisioning. When the provisioning is completed, the client must unlock the device and make it available for all other SDM users. The lock and unlock functions are only applied to the SDM server and not the device itself.

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 request is not authorized.

404 Response

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

Examples

Examples of Accessing the API

See Authenticate for how to acquire a session cookie.

The following example shows how to lock or unlock a device using curl.

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

The following example shows how to lock or unlock a device using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/inventory/deviceMgmt/devices/{deviceId}/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"?>
<deviceAction>
  <type>Lock</type>
</deviceAction>

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

{
  "type": "Lock"
}

Example of the Response Body

This endpoint does not return a response body.

Back to Top