Skip to content

Remediate Device

Request

Performs a remediation action on a managed device from the token-linked endpoint management source.

Operation ID: endpointmanagement_remediate_device

Security
BearerAuth
Query
metaArray of strings

Add metadata to the response by invoking meta functions. Documentation for meta functions is available. Not all meta functions are available at every endpoint.

Bodyapplication/jsonrequired
actionstring or null

Synqly-unified action name. Portable across providers -- Synqly maps it to the vendor-specific call. Use the capabilities API to discover which actions each provider supports. Mutually exclusive with vendor_action.

vendor_actionstring or null

Provider-specific action name, passed through to the vendor API without mapping. Use when the vendor supports actions not yet covered by Synqly-unified names. Mutually exclusive with action.

device_idstring or null

Target device ID. Required for most actions.

policy_idstring or null

Target policy ID. Required for policy-scoped actions.

commentstring or null

Optional comment or reason for the action.

paramsobject or null

Action-specific parameters forwarded to the provider. See provider documentation for supported keys.

curl
curl -i -X POST \
  https://api.synqly.com/v1/endpoint-management/devices/actions/remediate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Bodyapplication/json
messagesobject or null(MessagesResponse)

Additional messages from the service response that may be helpful to the client.

metaobject or null(MetaResponse)

Various metadata about the results organized by group, then type, then field.

resultstring or null

Device ID that was acted on.

Response
{ "result": "string", "messages": { "problems": [ … ] }, "meta": { "stats": { … }, "api": { … }, "mapping": { … } } }