Get the last scan status for a 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

gets the scan command status for the device

Request URL

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

Scope

MDMInventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

device_idstringMandatory

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/devices/{device_id}/actions/scan \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
status_descriptionstring

Description of the last scan status

status_codeinteger

Scan status code: 0 - failed, 1 - Initiated, 2 - Success, 4 - In progress

kb_urlstring

KB article URL displayed in case of command failure

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Last scan status with KB URL for troubleshooting

Copied!
  {
    "status_description": "Command Success",
    "status_code": 2,
    "kb_url": "https://zylker.com/kb"
  }
                
Show full

Duration: 1 minute | Threshold: 250 | 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.