Retrieve applicable actions 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 list of applicablr actions for the device

Request URL

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

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 \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
knox_actionsJSON Array

Array of Knox-specific actions applicable to the device

Show Sub-Attributes
JSON Object
Show Sub-Attributes
is_enabledboolean

Whether the Knox action is enabled

localized_namestring

Localized display name of the Knox action

namestring

Internal Knox action name (e.g., create_container)

localized_action_infostring

Localized action information

action_infostring

Additional Knox action information

actionsJSON Array

Array of standard device actions with their current status

Show Sub-Attributes
JSON Object
Show Sub-Attributes
is_enabledboolean

Whether the action is currently enabled for the device

localized_namestring

Localized display name of the action

namestring

Internal action name (e.g., scan, lock)

localized_action_infostring

Localized action information text

status_codeinteger

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

action_infostring

Additional action information

localized_status_descriptionstring

Localized description of the action status

status_descriptionstring

Description of the current action status

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Available standard and Knox actions with their status

Copied!
  {
    "knox_actions": [
      {
        "is_enabled": true,
        "action_info": "--",
        "name": "create_container",
        "localized_action_info": "--",
        "localized_name": "Create container"
      }
    ],
    "actions": [
      {
        "is_enabled": true,
        "status_description": "Command Success",
        "status_code": 2,
        "localized_status_description": "Command Success",
        "action_info": "--",
        "name": "scan",
        "localized_action_info": "--",
        "localized_name": "Scan"
      },
      {
        "is_enabled": true,
        "status_description": "Command Initiated",
        "status_code": 1,
        "localized_status_description": "Command Initiated",
        "action_info": "--",
        "name": "lock",
        "localized_action_info": "--",
        "localized_name": "Lock"
      }
    ]
  }
                
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.