Sign in

v1

latestOpenAPI 3.0.12026-08-064278250.7 KB
devices

Perform an action on a device

Perform a supported action on a device through its enrollment code.

post/v1/devices/{enrollmentCode}/actions

Path parameters

enrollmentCodestring required

Headers

Workspacestring required

The workspace identifier, which isolates API requests inside the provided workspace scope.

Request body

action'tamperProtection' | 'deviceProtection' | 'license' | 'malwareScan' | 'dataGovernanceScan' | 'updateAgent' | 'driveEncryption' | 'deviceState' required

The supported device actions. These include:<br>tamperProtection - Tamper protection prevents users and certain types of malware from tampering with important security features or disabling protection.<br>deviceProtection - Remove a device from protection.<br>malwareScan - Malware scans conduct a thorough scan of specified drives, detecting malware.<br>dataGovernanceScan - Data governance scans conduct a thorough scan of specified drives for sensitive data.<br>updateAgent - Update the device’s Coro Agent to the latest version.<br>driveEncryption - Drive encryption protects the data on that drive from unauthorized access.<br>deviceState - The state of the device, which can be shut down or restarted.

valuestring required

The values of the device actions. These include, for the different actions:<br>tamperProtection - enable, disable<br>deviceProtection - remove<br>malwareScan - start, stop<br>dataGovernanceScan - startFullScan, startPartialScan, stop. Full scans can take a long time. A partial scan ends if a significant amount of sensitive data is found.<br>updateAgent - updateToLatest<br>driveEncryption - encrypt<br>deviceState - shutdown, restart

metadataobject

Additional data required for drive encryption.

Example request

{
  "value": "enable",
  "metadata": {
    "driveLetter": "C://"
  }
}

Response

Success

deviceStatus'OK' | 'ERROR' | 'UNABLE_TO_PERFORM_ACTION'

The status of the device action.