ERPDesktop Agent Health, Info, and Status Endpoints

These endpoints let you check the health and status of the ERPDesktop agent itself — without authenticating — making them ideal for liveness probes, uptime monitors, and deployment verification scripts.

Health Check

Returns a minimal health status for the agent. This endpoint does not require authentication, so you can use it as a lightweight liveness probe in your monitoring infrastructure.


Method	`GET`
Path	`/api/v1/health`
Auth	Not required

Request

curl http://localhost:8765/api/v1/health

Response

{
  "status": "ok",
  "version": "1.1.0",
  "erp": "erpnext",
  "erp_version": "14.28.0",
  "connected": true
}

Use GET /api/v1/health as a liveness probe in your monitoring system — the endpoint returns HTTP 200 with "connected": true when the agent is healthy and fully connected to the ERP, and HTTP 503 with "connected": false when the agent is running but cannot reach the ERP. Point Uptime Robot, Grafana, or your Kubernetes readiness probe at this URL.

Agent Info

Returns extended information about the running agent including connected site details, uptime, and a summary of managed resources.


Method	`GET`
Path	`/api/v1/info`
Auth	Bearer token required (read-only or read-write scope)

Request

curl -H "Authorization: Bearer <api-key>" \
  http://localhost:8765/api/v1/info

Response

{
  "status": "ok",
  "data": {
    "agent_version": "1.1.0",
    "erp": "erpnext",
    "erp_version": "14.28.0",
    "site_url": "https://erp.example.com",
    "connected": true,
    "uptime_seconds": 86420,
    "plugin_count": 3,
    "device_count": 5
  }
}

Response Fields

string

The version of the running erpdesktop_agent binary.

string

The ERP platform the agent is connected to. One of erpnext or odoo.

string

The version string reported by the connected ERP instance.

string

The base URL of the ERP site the agent is connected to.

boolean

true if the agent currently has a live connection to the ERP; false if the connection is broken or the ERP is unreachable.

integer

Number of seconds the agent process has been running since its last start or restart.

integer

Total number of plugins installed in ERPDesktop (including stopped and crashed plugins).

integer

Total number of hardware devices configured in ERPDesktop (regardless of reachability status).

​Health Check

​Request

​Response

​Agent Info

​Request

​Response

​Response Fields

Health Check

Request

Response

Agent Info

Request

Response

Response Fields