Remotely lock the managed device

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

sends device lock command to device

Request URL

https://{server-hostname}:8383/api/v1/mdm/devices/{device_id}/actions/lock

Scope

MDMInventory.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

device_idstringMandatory

Unique identifier of the device. Obtain from the Get Device List response

- Request Body

application/json
JSON Object
Hide Sub-Attributes
lock_messagestringOptional

Message displayed on the device lock screen

phone_numberstringOptional

Phone number to display on the device during lock

unlock_pinstringOptional

Unlock PIN for the device

email_sent_to_userbooleanOptional

Whether email is sent to the user

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/v1/mdm/devices/{device_id}/actions/lock \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"unlock_pin":"1234.","lock_message":"This device has been locked by the administrator.","email_sent_to_user":"true.","phone_number":"000000000000."}'

Sample Request Body

Lock device with a lock screen message

Copied!
  {
    "unlock_pin": "1234.",
    "lock_message": "This device has been locked by the administrator.",
    "email_sent_to_user": "true.",
    "phone_number": "000000000000."
  }
                
Show full

Possible Response Codes

202HTTP code

Sample Response: HTTP 202

Copied!
202 Accepted
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.