Skip to main content
Agent status endpoint

Test connection to agent

Ossi Galkin avatar
Written by Ossi Galkin
Updated over 9 months ago

Cross-platform agents can host an HTTP(S) status endpoint which can be queried. This endpoint is enabled on the Agents when the HttpStatusinfoPort is set or when HTTP/HTTPS is configured for the Agent.

This endpoint is hosted at /frendsstatusinfo on the HTTP for the HTTP ports and the HttpStatusinfoPort and on HTTPS for HTTPS ports. This endpoint returns HTTP result code 200 (OK) if the Agent is running and not paused and a message of agent health, executing processes, and memory usage. It is used e.g. by API gateways for monitoring if the upstream execution Agents are running. It can of course also be used by external load-balancers configured for the systems.

If the Agent is paused, the endpoint will return 503 (Service unavailable). If you have API gateways set up, this is used to turn off traffic to Agents behind that gateway in a controlled way. The gateway will stop routing traffic to the paused Agent while it is paused.Β 

For more agent metric details the endpoint /metrics returns detailed messages of metrics, which can be scraped by 3rd party tools.

The Cross-platform Agents additionally provide the number of Processes currently executing on the Agent and have optional API-key authorization configurable with the HealthCheckApiKey -setting. The API key needs to be provided in an HTTP header named health-check-api-key.

With OnPremise agents, the Windows Performance Counters can be used to retrieve agent status information.
​

Did this answer your question?