HUhuntress
Reseller

Release Agent Isolation

Changed on

Schedules release of host isolation for a single Agent, restoring the host's network connectivity. Release is asynchronous: a successful request returns the Agent with a firewall_status of "Pending Release" until the endpoint confirms the host is back online.

This endpoint requires an API key with permission to release agents. 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.

delete/v1/accounts/{account_id}/agents/{id}/isolation

Request

  • Base URL
    https://api.huntress.io
  • URL
    https://api.huntress.io/v1/accounts/{account_id}/agents/{id}/isolation
  • Auth
    basic (a scheme the document does not define)

Path parameters

account_idinteger required
idinteger required

Response

Release Agent Isolation

idinteger

A unique identifier for an agent.

account_idinteger

The unique identifier of the account associated with the agent.

archstring

The architecture on the host machine.

created_atstring date-time

A timestamp for when the agent was created, formatted as per ISO-8601.

domain_namestring

Domain that refers to the host machine.

edr_versionstring

The semantic versioning number of the Huntress EDR software installed on the machine or null if EDR is not installed.

external_ipstring

The external IP of the host machine, if applicable.

hostnamestring

The hostname of the host machine.

defender_policy_statusstring

Policy status of Defender AV for Managed Antivirus.

defender_statusstring

Status of Defender AV Managed Antivirus.

defender_substatusstring

Sub-status of Defender AV Managed Antivirus.

firewall_statusstring

Status of agent firewall. Can be one of Disabled, Enabled, Pending Isolation, Isolated, Pending Release

tamper_protection_configuredboolean

The desired EDR tamper protection state for the agent. null when the agent does not support tamper protection.

tamper_protection_actualboolean

The tamper protection state most recently reported by the host. May lag tamper_protection_configured and is null until the host reports.

ipv4_addressstring

The internal IP of the host machine.

ipv4_addressesstring[]

Every internal IPv4 address the host reports, one per network interface. When compared against ipv4_address attribute, ipv4_address is the primary address from this list.

last_callback_atstring date-time

A timestamp for when the last time Huntress was able to access the host machine.

last_survey_atstring date-time

A timestamp for when the last Microsoft Defender survey was received by Huntress for this host machine.

mac_addressesstring[]

The unique media access control (MAC) addresses associated with the agent.

service_pack_majorinteger

The major version of the Windows service pack installed on the host machine.

service_pack_minorinteger

The minor version of the Windows service pack installed on the host machine.

organization_idinteger

The unique identifier of the organization associated with the agent.

osstring

The operating system of the host machine.

os_build_versionstring

The operating system build number of the host machine corresponding to its platform (<a href='https://learn.microsoft.com/en-us/windows/release-health/windows11-release-information'>windows</a> or <a href='https://developer.apple.com/news/releases/'>darwin</a>).

os_majorinteger

The major OS version of the host machine. Corresponds with the major releases of Windows operating systems. A list is accessible <a href='https://docs.microsoft.com/en-us/windows/win32/sysinfo/operating-system-version'>here</a>.

os_minorinteger

The minor OS version of the host machine. Refer to the os_major field details for further details.

os_patchinteger

The patch version of the macOS update installed on the host machine, such as 1 in version 12.5.1.

platformstring

The platform of the host machine (darwin, windows, or linux).

serial_numberstring

The serial number of the host machine as reported to the operating system.

tagsstring[]

User classifications on the host machine.

updated_atstring date-time

A timestamp for when the agent was last updated, formatted as per ISO-8601.

versionstring

The semantic versioning number of the agent installed on the host machine.

version_numberinteger

Windows version number.

win_build_numberinteger

The Windows Build Number. Should correspond to information on the <a href='https://docs.microsoft.com/en-us/windows/release-health/release-information'>Microsoft site</a>.

Example response

{
  "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
}

Changes

  • 9563c2772280Revision changes
    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status