Perform an action on a device

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

SecurityJWT
Request
path Parameters
enrollmentCode
required
string
header Parameters
Workspace
required
string

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

Example: corodevonmicrosoftcom_TX7T_u
Request Body schema: application/json
action
required
string (SupportedDeviceAction)

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

Enum: "tamperProtection" "deviceProtection" "malwareScan" "dataGovernanceScan" "updateAgent" "driveEncryption" "deviceState"
value
required
string

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

object

Additional data required for drive encryption.

Responses
200

Success

400

Bad request, validation error

401

Unauthorized request

403

Access forbidden

429

Too Many Requests

500

Internal server error

post/v1/devices/{enrollmentCode}/actions
Request samples
application/json
{
  • "action": { },
  • "value": "enable",
  • "metadata": {
    }
}
Response samples
application/json
{
  • "deviceStatus": { }
}