Skip to main content
ZStack
Infrastructure/Agents

GetAgentStatistics

Retrieve aggregate statistics about agents grouped by their current status

GET/api/v1/agents/statistics

Operation ID

GetAgentStatistics

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • total
    String

    Total number of registered agents

    Example: 200

  • online
    String

    Number of agents currently online

    Example: 150

  • delayed
    String

    Number of agents with delayed heartbeat

    Example: 10

  • offline
    String

    Number of agents currently offline

    Example: 30

  • notInstalled
    String

    Number of agents that have never been installed

    Example: 10