Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
GETAgentSince 1.0SynchronousAuth Required

GetAgentStatistics

Retrieve aggregate statistics about agents grouped by their current status

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • totalString

    Total number of registered agents

    Example: 200

  • onlineString

    Number of agents currently online

    Example: 150

  • delayedString

    Number of agents with delayed heartbeat

    Example: 10

  • offlineString

    Number of agents currently offline

    Example: 30

  • notInstalledString

    Number of agents that have never been installed

    Example: 10

Endpoint

GET/api/v1/agents/statistics

/api/v1/agents/statistics

Operation ID

GetAgentStatistics

Permalink

Request Example

curl -X GET '{host}/api/v1/agents/statistics' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "total": 200,
  "online": 150,
  "delayed": 10,
  "offline": 30,
  "notInstalled": 10
}

Change History

This API has no change history records yet.

View all change history