Device Action v3.0

API version3.0
Last Update06/28/2017
AuthenticationYES
HTTP MethodPOST
Content Typeapplication/json
Rate limitedYES
Requests per rate limit10/min
Response FormatJSON
Change History04/10/2018: fixed a bug that the API returns HTTP 400 when group id doesn't exist on an account with assign to group action 05/23/2017: added one more action type (types parameter in request), re-identify 06/28/2017: added one more action type (types parameter in request), assign_to_group

Use to do an action on multiple devices on your account

API URL

Copy

Request Parameters

KeyDatatypeParameter TypeRequiredDescriptionDefault
access_tokenstringURLYesaccess token which archived from OAuth authentication step
typesstringBodyYes

Action Type:

  • exempt: exempt a device completely.

    • Apply: all devices exclude Unknown, Ignored, Out-of-license-usage devices

  • unexempt: unexempt device

    • Apply: all devices exclude Unknown, Ignored, Out-of-license-usage devices

  • ignore: ignore an unknown device

    • Apply: unknown devices only

  • unignore: undo ignore action.

    • Apply: ignored devices only

  • delete: delete devices

    • Apply: all devices

  • dhcprenew: force ME call a DHCP request

    • Apply: devices which installed a persistent agent only

  • re-identify: force ME re-identify the device

    • Apply: all devices exclude Unknown, Ignored, Out-of-license-usage devices

  • assign_to_group: assign devices to a group

    • Apply: all devices exclude devices with domain controller agent installed
idsarray<string>BodyOptionalHWIDs of devices to be applied the action. The request body must have ids parameter or macs parameter, but not both.
macsarray<string>BodyOptionalMAC addresses of devices to be applied the action The request body must have ids parameter or macs parameter, but not both.
paramsobjectBodyOptionalRequired parameters for a specific action.
params.exempt_timeintBodyOptionalSpecify how long you want to exempt devices in hour. Value should be less than 65000 if this parameter equals 0, we will do exempt devices forever0
params.group_idstringBodyOptionalSpecify which group (group id) you want to assign devices to This parameter should be specified when action type is assign_to_groupdefault

Response HTTP Code

See APIs

Response Parameters

KeyDataTypeDescription
<hwid> or <mac address>intResult for a device which has the given HWID/MAC address -1: not support 0: apply action failed 1: apply action successfully

Example

Example Request: using Device ID

Copy

Example Response

Copy

History

ActionVersionURL
Delete2.0Delete Devices v2.0
Renew IP Exempt Unexempt2.0Devices Action v2.0
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Device Action v3.1
On This Page
Device Action v3.0API URLRequest ParametersResponse HTTP CodeResponse ParametersExampleHistory