Get an agent
Shows whether an install worked: status turns from never_connected to online within about a minute of the agent starting, and connected_ever stays true from then on. The response is small by default; target adds that install snippet and include=install all of them, with the $ placeholder (the key itself is never returned here).
Authorizations
Query Parameters
Response
ok
never_connected: no heartbeat yet (installed agents report within about a minute). online: a heartbeat in the last 90 seconds. offline: it has connected before but has been silent for over 90 seconds. revoked: its key is rejected (console kill switch).
never_connected, online, offline, revoked Only with ?target= or ?include=install. Install snippets keyed by target: docker (docker run), compose, kubernetes (Secret + Deployment manifest), systemd (Linux service), launchd (macOS LaunchAgent) and binary (foreground, Linux or macOS). Only the requested target with ?target=, all of them with ?include=install. The systemd, launchd and binary snippets pick the right binary on the host (uname). Without prometheus_url they are for a probes-only agent. Here with the ${AGENT_KEY} placeholder: the key is only returned by create and rotate-key.
Only with ?target= or ?include=install. The agent's environment as NAME: value (AGENT_KEY, CLOUD_SERVER_URL, and PROMETHEUS_SERVER_URL for a Prometheus agent), for installs the snippets do not cover, such as an existing Compose file or Helm values. AGENT_KEY is the ${AGENT_KEY} placeholder here.

