/agents

name: "Atera Agents"
description: >
  Atera RMM agents: agent records and fields, online/offline status,
  endpoint search and monitoring, PowerShell and script execution, and agent
  lifecycle.
when_to_use: >-
  When listing, searching, monitoring, or running commands on Atera-managed
  endpoints. Use when: atera agent, rmm agent, atera device, agent status,
  agent online, agent offline, powershell atera, run script atera, managed
  device, or endpoint atera.

Atera Agent Management

Overview

Atera agents are lightweight software installed on managed endpoints that provide remote monitoring and management capabilities. Agents report system information, health metrics, and enable remote execution of scripts and commands.

Anti-triggers

• **Atera's own "devices"** — an Atera *device* is an agentless HTTP,

SNMP, or TCP monitor with no agent behind it; use `atera-devices`. Atera is the odd one out: in `ncentral-devices`, `ninjaone-devices`, and `datto-rmm-devices` "device" means the managed endpoint, which here is an agent.

• **Claude subagents** — "agent" here is an Atera endpoint sensor, never

an AI subagent definition under `agents/*.md`. In `halopsa-agents` it is a human technician, and in `liongard-overview` it is one inspection runner per customer site.

• **Running a script on an endpoint managed by another RMM** — "run

PowerShell on this machine" matches every RMM in this marketplace equally, and none of them reach Atera's agents. Confirm which RMM the endpoint is enrolled in, then use `syncro-assets`, `superops-runbooks`, `immybot-script-execution`, `ncentral-monitoring-tasks`, `connectwise-automate-scripts`, or `datto-rmm-jobs`.

• **The alert an agent raised** — agent records carry health and

inventory, not monitoring output; use `atera-alerts`.

Agent Information Fields

Core Fields

| Field | Type | Description | |-------|------|-------------| | `AgentID` | int | Unique agent identifier | | `AgentName` | string | Agent display name | | `MachineID` | int | Machine reference ID | | `CustomerID` | int | Associated customer ID | | `CustomerName` | string | Customer display name | | `Online` | boolean | Current online status | | `LastSeenDate` | datetime | Last communication timestamp |

System Information

| Field | Type | Description | |-------|------|-------------| | `MachineName` | string | Computer hostname | | `DomainName` | string | AD domain (if joined) | | `OS` | string | Operating system name | | `OSVersion` | string | OS version/build | | `OSType` | string | Windows, Mac, Linux | | `OSSerialNumber` | string | OS serial number | | `Processor` | string | CPU model | | `Memory` | long | Total RAM in bytes |

Network Information

| Field | Type | Description | |-------|------|-------------| | `IPAddresses` | string | Comma-separated IP list | | `MacAddresses` | string | Network adapter MACs | | `LastIPAddress` | string | Most recent IP |

Agent Status

| Field | Type | Description | |-------|------|-------------| | `AgentVersion` | string | Installed agent version | | `CreatedDate` | datetime | When agent was installed | | `Monitored` | boolean | Monitoring enabled | | `MonitoredStatus` | string | Monitoring state | | `Favorite` | boolean | Marked as favorite |

Hardware Details

| Field | Type | Description | |-------|------|-------------| | `Vendor` | string | Hardware manufacturer | | `VendorSerialNumber` | string | Device serial number | | `VendorModel` | string | Device model | | `VendorBrandModel` | string | Full brand/model string |

API Patterns

List All Agents (Paginated)

GET /api/v3/agents?page=1&itemsInPage=50
X-API-KEY: {api_key}

**Response:**

{
  "items": [
    {
      "AgentID": 98765,
      "AgentName": "DESKTOP-ABC123",
      "MachineName": "DESKTOP-ABC123",
      "CustomerID": 12345,
      "CustomerName": "Acme Corporation",
      "Online": true,
      "LastSeenDate": "2024-02-15T14:30:00Z",
      "OS": "Windows 11 Pro",
      "OSType": "Windows",
      "Processor": "Intel Core i7-12700",
      "Memory": 34359738368,
      "IPAddresses": "192.168.1.100,10.0.0.50",
      "AgentVersion": "2.0.1.25",
      "Monitored": true
    }
  ],
  "totalItems": 500,
  "page": 1,
  "itemsInPage": 50,
  "totalPages": 10
}

Get Agent by ID

GET /api/v3/agents/{agentId}
X-API-KEY: {api_key}

**Response:**

{
  "AgentID": 98765,
  "AgentName": "DESKTOP-ABC123",
  "MachineName": "DESKTOP-ABC123",
  "DomainName": "ACME.LOCAL",
  "CustomerID": 12345,
  "CustomerName": "Acme Corporation",
  "Online": true,
  "LastSeenDate": "2024-02-15T14:30:00Z",
  "OS": "Windows 11 Pro",
  "OSVersion": "10.0.22621",
  "OSType": "Windows",
  "OSSerialNumber": "00330-80000-00000-AA123",
  "Processor": "Intel(R) Core(TM) i7-12700 CPU @ 2.10GHz",
  "Memory": 34359738368,
  "IPAddresses": "192.168.1.100",
  "MacAddresses": "00:1A:2B:3C:4D:5E",
  "Vendor": "Dell Inc.",
  "VendorSerialNumber": "ABC1234567",
  "VendorModel": "OptiPlex 7090",
  "AgentVersion": "2.0.1.25",
  "CreatedDate": "2023-06-15T09:00:00Z",
  "Monitored": true,
  "MonitoredStatus": "Healthy"
}

Get Agents by Customer

GET /api/v3/agents/customer/{customerId}
X-API-KEY: {api_key}

Get Agent by Machine Name

GET /api/v3/agents/machine/{machineName}
X-API-KEY: {api_key}

Delete Agent

DELETE /api/v3/agents/{agentId}
X-API-KEY: {api_key}

**Response:**

{
  "ActionID": 12345,
  "Success": true
}

PowerShell Execution

Run PowerShell Script

POST /api/v3/agents/{agentId}/powershell
X-API-KEY: {api_key}
Content-Type: application/json

{
  "Script": "Get-Service | Where-Object {$_.Status -eq 'Running'} | Select-Object Name, DisplayName"
}

**Response:**

{
  "ActionID": 55555,
  "Status": "Queued",
  "Message": "Script queued for execution"
}

PowerShell Best Practices

1. **Keep scripts concise** - Long-runnin