Sign in
latestSwagger 2.02026-08-109450223.9 KB

94acb422c07d

Reseller

Update Agent

Updates the editable attributes of a single Agent.

Note that the default account API key is read-only, so you'll need to create a user-based API key with the appropriate permissions to access this endpoint.

patch/v1/accounts/{account_id}/agents/{id}

Path parameters

account_idinteger required
idinteger required

Request body

tamper_protection_configuredboolean

Enable or disable EDR tamper protection for the agent. Applies asynchronously, so the host-reported state is exposed separately as tamper_protection_actual. Requires an API key with permission to manage agent security settings, and the agent must support tamper protection.

Response

Update Agent

Example response

{
  "agent": {
    "id": 1,
    "account_id": 5,
    "arch": "x86_64",
    "created_at": "2022-03-01T20:05:10Z",
    "domain_name": "WORKGROUP",
    "edr_version": "0.3.20",
    "external_ip": "198.51.100.42",
    "hostname": "laptop01",
    "defender_policy_status": "Compliant",
    "defender_status": "Healthy",
    "defender_substatus": "Up to date",
    "firewall_status": "Disabled",
    "tamper_protection_configured": true,
    "tamper_protection_actual": true,
    "ipv4_address": "146.134.139.9",
    "ipv4_addresses": [
      "10.5.80.97",
      "172.27.240.1"
    ],
    "last_callback_at": "2022-03-01T20:05:10Z",
    "last_survey_at": "2022-03-01T20:05:10Z",
    "mac_addresses": [
      "7c:a7:b0:16:2f:78"
    ],
    "organization_id": 7,
    "os": "Windows 8 Pro",
    "os_build_version": "19044",
    "os_major": 6,
    "os_minor": 2,
    "platform": "windows",
    "serial_number": "wtIe1bvDbh",
    "tags": [
      "Server",
      "Production"
    ],
    "updated_at": "2022-03-01T20:05:10Z",
    "version": "0.11.3",
    "version_number": 720899,
    "win_build_number": 19044
  }
}