How do I enroll a monitoring agent?

Requires Pro

Quick answer

In the Monitoring agents section, create an enrollment token, download the Notory agent for your operating system, enter the server URL and token, and start the agent as a service. It then continuously reports CPU, memory, disk, network and uptime — the system automatically appears as an agent system in the list.

Prerequisites

Required role Administrator

— enrollment tokens are managed in the monitoring admin section. The token itself then authenticates the agent (no user sign-in involved).

Monitoring is part of the Operations module and available from the Pro tier.

Instructions

GUI (web interface)

1. Create a token. In the Monitoring module, scroll to the Monitoring agents section. Give it a name (e.g. “Fleet A” for a site or a device fleet) and click “Create token”. The enrollment token is shown only once — copy it immediately.

   Screenshot pending monitoring-agent-01 Monitoring agents section with name field, Create token button and per-OS download buttons

   Creating an enrollment token and downloading the agent for each operating system.

2. Download the agent. Under “Download agent”, click the matching variant (Windows, Linux or macOS, each amd64/arm64). If a build isn’t available yet, Notory shows ”… is not available yet”.

3. Run the agent. On the target system, enter the server URL and the enrollment token, and start the agent as a service (Task Scheduler / systemd / launchd). From the first report onward, the system appears as an Agent in the list.

API (curl)

Download the agent binary — GET /api/v1/monitoring/agent/download with os and arch:

Download the agent binary

curl -H "Authorization: Bearer inv_dein_token" \
  "https://demo.notory.io/api/v1/monitoring/agent/download?os=linux&arch=amd64" \
  --output notory-agent

Supported: os ∈ windows | linux | darwin (or macos), arch ∈ amd64 | arm64. If the binary hasn’t been built yet, the API responds with 404.

What the agent sends — it pushes its metrics to POST /api/v1/monitoring/agent/metrics, authenticated via the enrollment token (not a user session). machine_id is required:

Agent metric push (illustrative)

curl -X POST https://demo.notory.io/api/v1/monitoring/agent/metrics \
  -H "Authorization: Bearer <einbindungs-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "machine_id": "b3f1-win-0421",
    "hostname": "SRV-DMZ-01",
    "os": "windows",
    "cpu_pct": 37.5,
    "mem_pct": 61.2,
    "disk_pct": 74.0,
    "uptime_s": 862400,
    "load1": 0.8
  }'

Response (200 OK)

{ "host_id": "hs_9a8b…", "created": true }

Possible errors: 400 (unsupported os/arch), 401 (invalid token), 403 (the Operations module is not in your tier), 404 (binary not available yet).

What happens behind the scenes?

• Automatic system creation: On the first metric push, Notory creates (or updates) an agent system based on the machine_id and sets its status to Up.
• Link to the inventory: If an asset with a matching external identifier exists, the system is linked to it; otherwise Notory creates a lightweight asset — this is how monitoring and inventory stay connected.
• Extended metrics: Via the extra field, the agent can additionally report services, processes or temperatures; they appear in the system history under “Extended metrics”.
• One-time display of the token: For security reasons, the enrollment token is shown only at creation time — it cannot be retrieved again afterward.

Related topics

• Set up monitoring for a system
• Read the status overview
• Alert rules and notifications
• Discovery — inventory agents for software detection