Device Actions

POST {{cb_url}}/appservices/v6/orgs/{{cb_org_key}}/device_actions

The device actions endpoint allows you to create and execute an action on devices.

API request is common for all device actions. POST request body will change for each device action.

RBAC Permissions Required

Permission (.notation name)	Operation(s)	Action Type
device.quarantine	EXECUTE	QUARANTINE
device.bypass	EXECUTE	BYPASS
device.bg-scan	EXECUTE	BACKGROUND_SCAN
device.policy	UPDATE	UPDATE_POLICY
org.kits	EXECUTE	UPDATESENSORVERSION
device.deregistered	DELETE	DEREGISTER_SENSOR
device.uninstall	EXECUTE	DELETE_SENSOR

The device actions endpoint allows you to create and execute an action on devices. - API request is common for all device actions. - POST request body will change for each device action.

Request Body Schema

Field	Description	Default	Required
`action_type`	Action to perform on selected devices. Allowed values: `BACKGROUND_SCAN`, `BYPASS`, `UNINSTALL_SENSOR`, `DELETE_SENSOR`, `QUARANTINE`, `UPDATE_POLICY`, `UPDATE_SENSOR_VERSION`	N/A	Yes
`device_id`	List of devices to perform action on	N/A	Yes - either `device_id` or `search`
`search`	A device search. Device actions will be performed on the result set of this search	N/A	Yes - either `device_id` or `search`
`options.policy_id`	Devices will be updated to this policy ID	N/A	Required if actiontype is set to `UPDATEPOLICY`
`options.sensor_version`	Devices will be updated to this sensor version	N/A	Required if actiontype is set to `UPDATESENSOR_VERSION`
`options.toggle`	Determines whether to toggle action `ON` or `OFF`. Allowed values: `ON`, `OFF`	N/A	Required if actiontype is set to `QUARANTINE`, `BYPASS`, or `BACKGROUNDSCAN`.

See Documentation

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string