Lock or Unlock a Device
post
/{versionId}/inventory/deviceMgmt/devices/{deviceId}/action
Use this (POST) method to 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.
Examples
Example of Accessing the API with cURL
The following example shows how to lock or unlock a device 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/inventory/deviceMgmt/devices/{deviceId}/action"Example of Accessing the API with Python
The following example shows how to lock or unlock a device 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/inventory/deviceMgmt/devices/{deviceId}/action"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.post(url, headers=headers)Example of the Response Body
This endpoint does not return a response body.