agents
List agents by device filter
Returns a list of agents matching the specified device filter. Use the optional flags to include related data such as group details, credentials, planned changes, proxy agents, and applied templates. Supports pagination and sorting through the standard query parameters.
List agents by device filter
Returns a list of agents matching the specified device filter. Supply all filter and pagination options in the request body. Supports the same related-data flags as the GET variant.
Register agent details
Registers a new agent or proxied device with the hub and returns the resulting Agent record. Supply device properties such as host name, host type, group memberships, and credentials. The UniqueId parameter prevents duplicate registrations if the hub store is reset and agent IDs are reissued.
Register agent details
Registers a new agent or proxied device with the hub and returns the resulting Agent record. Supply all device properties in the request body, including host name, host type, group memberships, and credentials.
Update an Agent's details
Updates the specified agent's details and returns the refreshed agent list. Use the Update* boolean flags to control which fields are actually written, allowing partial updates without overwriting fields that were not supplied.
Update an Agent's details
Updates the specified agent's details and returns the refreshed agent list. Supply the agent object and the Update* boolean flags in the request body to control which fields are written.
Find agents by filter and criteria
Returns agents that match both the device filter and the specified text search criteria. Use this endpoint to perform free-text searches across agent fields, with the results scoped to the devices identified by the DeviceFilter.
Find agents by filter and criteria
Returns agents that match both the device filter and text search criteria supplied in the request body. Accepts the same filter and pagination options as the GET variant.
Register specified agents
Pre-registers a batch of agents with the hub before they connect for the first time. Returns the pre-registration response for each supplied agent, allowing you to provision agent records in advance of deployment.
Register specified agents
Pre-registers a batch of agents with the hub before they connect for the first time. Supply the list of agent registration details in the request body.