Skip to main content
The erpdesktop_agent running on your server exposes a REST API that lets you query device status, trigger backups, and manage plugins programmatically from external scripts, monitoring dashboards, or custom integrations — without opening the ERPDesktop desktop application.

​
Base URL

All API endpoints are relative to:
The default agent port is 8765. You can change it in Settings → API → Agent Port. Every request must target the server where erpdesktop_agent is running. Example base URL:

​
Response Format

All responses return JSON with a consistent envelope. Success response:
Error response:
The HTTP status code also reflects the result — 2xx for success, 4xx for client errors, and 5xx for server-side errors.

​
Common Error Codes

​
Rate Limiting

The API is rate-limited to 60 requests per minute per API key. If you exceed this limit the agent returns HTTP 429 Too Many Requests. Back off for at least 60 seconds before retrying.

​
Explore the API

Authentication

Generate an API key and learn how to pass it in the Authorization header on every request.

Devices

List all configured hardware devices and check their current reachability status.

Backups

Trigger an immediate backup and poll for job completion via the backups API.

Plugins

List installed plugins, inspect their state, and invoke plugin commands programmatically.

Agent

Check agent liveness with the unauthenticated health endpoint and retrieve extended agent info.