Initiate a remote debug session on the 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 remote debug command to device

Request URL

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

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
retrybooleanOptional

Whether to retry the remote debug if it fails

email_address_liststringOptional

Comma-separated email addresses to send debug logs to

ticket_idstringOptional

Associated ticket ID for the action

descriptionstringOptional

Description or reason for the action

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/v1/mdm/devices/{device_id}/actions/remote_debug \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"description":"To Remote Debug the device","ticket_id":"9007199254741089","retry":false,"email_address_list":"admin@zylker.com"}'

Sample Request Body

Initiate remote debug with retry and email options

Copied!
  {
    "description": "To Remote Debug the device",
    "ticket_id": "9007199254741089",
    "retry": false,
    "email_address_list": "admin@zylker.com"
  }
                
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.