Health Check

GET 
/health-check

This endpoint performs a health check on the GetApp agent, including checking the status of the network connection, server connectivity, and the liveness of the GetApp-UI component. The network connection status is determined by attempting to connect to the URL specified in the 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

required

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.

Example (from schema)

{
  "components": [
    {
      "err_msg": "string",
      "live": true,
      "name": "string"
    }
  ],
  "network": {
    "errMsg": "string",
    "internetConnection": true,
    "serverAddress": "string",
    "serverConnection": true
  }
}

Loading...