- API >
- Public API Resources >
- Agents >
- Get Agents by Type for a Group
Get Agents by Type for a Group¶
On this page
Get all agents of a specified type (i.e. Monitoring, Backup, or Automation) for a group.
Base URL: https://<ops-manager-host>/
Syntax¶
Where {TYPE}
can be one of the following values:
MONITORING
BACKUP
AUTOMATION
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
Request Query Parameters¶
Field | Required/Optional | Description |
---|---|---|
pageNum |
Optional. | The page to return. |
itemsPerPage |
Optional. | Maximum number of items to return per page. Default is 100. |
envelope |
Optional. | A boolean that specifies whether or not to wrap the response in an envelope. |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response Elements¶
Name | Type | Description |
---|---|---|
typeName |
string | The type of agent: MONITORING , BACKUP , or AUTOMATION . |
hostname |
string | Primary hostname. A host typically may have aliases, so the primary is the best available name as decided by Ops Manager. |
confCount |
number | Number of configuration calls. |
lastConf |
timestamp | Date and time of last configuration call. |
stateName |
string | The current state of the agent.
|
pingCount |
number | Only applicable to Monitoring agents. The number of pings that
the Monitoring agent has sent to the hostname URL. |
isManaged |
Boolean | Only applicable to Monitoring and Backup agents. Specifies whether or not Ops Manager manages the agent. |
lastPing |
timestamp | Only applicable to Monitoring agents. Time of most recent ping. |
tag |
string | Only applicable to Backup agents. The agent’s tag, if there is one. |
Links¶
Relation | Description |
---|---|
self |
Me |