Get extant agents

Filter to roaming clients associated with these users. When cybersight_enabled=true uses Cybersight activity (OpenSearch); otherwise uses current user on device (PG).

filter by agent state

Filter user agents by agent type. Valid values: windows, macos, ios, android, chrome. Valid operators: is, isnot

Filter user agents by agent version. Valid operators: startswith, equals, doesnotequal, contains, doesnotcontain, endswith

Filter user agents by their organization's auto update value

Filter user agents by block page ID

Filter by browser extension status (chrome or edge). Valid values: installed, not_responding, not_installed. Valid operators: is, isnot

When true, use OpenSearch for Cybersight activity in the time window: with agent_local_user_uuids, filter to roaming clients linked to those users; without, filter to roaming clients with activity on Cybersight-eligible agents in scope. When false, use Postgres only (default: false)

Filter by CyberSight service status. Valid values: active, inactive, disabled, not_available. Valid operators: is, isnot

ISO8601 end of activity window. Optional; only used with start_at when cybersight_enabled=true.

MSP ID, set scope to all sub-orgs

Filter user agent by client name fields (i.e. hostname and friendly_name). Valid operators: contains, doesnotcontain

Networks IDs, defaults to all

assign user agents new agent states: Protected, Unprotected, Offline

Organization IDs, defaults to user organization ID

Page number and size

Filter user agents by policy ID

Filter user agents by policy/schedule name

Filter user agents by release channel. Valid values: stable, beta, preview. Valid operators: is, isnot

Filter user agents by scheduled_policy ID

User agent list by keyword(s) (space delimited), this could be: status, hostname, friendly name, current logged in user

Sort options, valid attributes: hostname, friendly_name, agent_version, last_sync, agent_state, vpn_status, private_network (connected, not_connected, disabled)

ISO8601 start of activity window. Optional; only used when cybersight_enabled=true. Omitted => last 91 days unless paired with end_at.

filter by user agent online/offline state

filter by user agent status, valid attributes: active, disabled, uninstalled, uninstall_queued, uninstalling

User agent list by tags

filter by agents that have received traffic in last 15 minutes

User agent type, defaults to non-proxy/no-relays user agents

Filter by VPN mode (agent-level overrides org-level). Valid values: manual, always_on. Valid operators: is, isnot

Filter by VPN connectivity status. Valid values: connected, not_connected, disabled. Valid operators: is, isnot