Skip to main content

Introduction to Agent Status Endpoint

Monitoring Agents

Ossi Galkin avatar
Written by Ossi Galkin
Updated over a year ago

Agent Status Endpoint

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

Current Available Status Codes

An Endpoint returns the following codes depending on the Agent's status.

200 (OK) - Agent is running and not paused

503 (Service unavailable) - Agent is paused

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

For more information, please see the official documentation.

This is the last Article in the Frends Academy Architecture course.

Did this answer your question?