Check agent health

GET 
/api/v2/agent/status/health-check

Performs health check on the agent including network connectivity, server reachability, and GetApp-UI component status. Network availability is checked using the configured NETWORK_AVAILABILITY_URL environment variable.

Request

Responses

200

application/json

Schema

Schema

components

object[]

required

The liveness of other components, by default including the GetApp-UI component.

Array [

err_msg stringnullable

An optional error message if there was an issue with the component.

live booleanrequired

true if the component is live, false otherwise.

name stringrequired

The name of the component.

]

network

object

Basic connectivity status — server reachability and internet availability.

errMsg stringnullable

An optional error message if there was an issue with the connections.

internetConnection booleanrequired

Indicates whether the agent has an active internet connection.

serverAddress stringrequired

The address of the server the agent is trying to connect to.

serverConnection booleanrequired

Indicates whether the agent can successfully connect to the server.

connectionType stringnullable

Network connection type: "Ethernet", "WiFi", "Cellular", or "Unknown".

downloadKbps int32nullable

Download bandwidth in Kbps (from latest confirmed measurement).

measuredAt stringnullable

ISO 8601 timestamp of the last bandwidth measurement.

uploadKbps int32nullable

Upload bandwidth in Kbps (from latest confirmed measurement).

Example (from schema)

{
  "components": [
    {
      "err_msg": "string",
      "live": true,
      "name": "string"
    }
  ],
  "network": {
    "errMsg": "string",
    "internetConnection": true,
    "serverAddress": "string",
    "serverConnection": true,
    "connectionType": "string",
    "downloadKbps": 0,
    "measuredAt": "string",
    "uploadKbps": 0
  }
}

Loading...