OPopenobserve
Synthetics

Location detail: stats + registered agents + assigned checks

get/api/{org_id}/synthetics/locations/{id}

Request

Path parameters

org_idstring required

Organization name

idstring required

Location id

Response

Success

agent_namesstring[] required

Names of the live agents (most recently seen first) — shown as subtext in the check form's private-location rows.

agents_totalinteger required

Total registered agents (live + stale).

checks_countinteger required

Synthetics in the caller's org that run from this location.

checks_per_minnumber double required

Σ 60/interval_secs over the enabled synthetics above.

enabledboolean required
idstring required
kindstring required
labelstring required

Display label — user/agent-chosen (private) or o2's friendly name (public).

last_seen_atinteger nullable

Most recent agent last_seen_at (epoch µs).

live_agentsinteger required

Number of live agents serving this location.

live_status_unknownboolean

True when status is this region's best guess rather than an observation — see [resolve_live_status].

Additive on purpose. Widening status itself with a fourth value would break every client that switches on it: the locations table renders t("synthetics.privateLocations.status." + status), so an unrecognised value shows the raw key path, and the check form's tier mapping treats "not online and not pending" as offline — the exact false alarm this exists to remove. An unknown field is ignored instead.

Skipped when false, so a deployment without super cluster serves a byte-identical payload to the one it served before this field existed.

poolstring required
providerstring required
regionstring required
statusstring required

"online" (any live agent; public rows always), "offline" (agents registered but all stale), "pending" (private row, nothing registered).

typesstring[] required

Check types runnable at this location (computed: base set for public rows, live agents' self-reported capabilities for private rows).

versionstring nullable

Binary version of the most recently seen agent.

installstring nullable

Install command for private rows; withheld without PUT on the default folder.

Changes

No recorded changes to this operation across all 1 revision of this API.