Retrieve Status of an Agent Group
get
/ic/api/integration/v1/monitoring/agentgroups/{id}
Retrieves monitoring data including current availability status for the agent group with the specified ID.
Request
Supported Media Types
- application/json; charset=utf-8
Path Parameters
-
id(required): string
Agent group identifier.
Example:
agentgroups/EXECUTION_AGENT_GROUP
Response
Supported Media Types
- application/json; charset=utf-8
200 Response
Successful operation
Root Schema : AgentGroupMonitoringRs
Type:
Show Source
object
-
agents:
array agents
-
createdBy:
string
-
createdDate:
string(date-time)
-
description:
string
-
displayStatus:
string
-
id:
string
-
lastUpdatedBy:
string
-
lastUpdatedDate:
string(date-time)
-
links:
array links
-
name:
string
-
status:
string
Allowed Values:
[ "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE", "NOT_APPLICABLE" ]
-
type:
string
Allowed Values:
[ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
-
version:
string
Nested Schema : AgentMonitoringRs
Type:
Show Source
object
-
agentGroupCode:
string
-
createdBy:
string
-
createdDate:
string(date-time)
-
description:
string
-
displayStatus:
string
-
id:
string
-
lastLockedBy:
string
-
lastLockedDate:
string(date-time)
-
lastUpdatedBy:
string
-
lastUpdatedDate:
string(date-time)
-
links:
array links
-
name:
string
-
status:
string
Allowed Values:
[ "REGISTERED", "ACTIVE", "UNAVAILABLE" ]
-
type:
string
Allowed Values:
[ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
-
version:
string
400 Response
Malformed parameters
500 Response
Server error