System API
System health, readiness, restart, and factory reset endpoints for a Celerp ERP installation.
Generated from the Celerp 2.8.0 OpenAPI schema, 2 November 2026.
GET /health
Get Service Health
Return a basic Celerp service health response.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested service health result. | object |
Example
curl -X GET http://localhost:8000/health \
-H "Authorization: Bearer $TOKEN"GET /health/ready
Get Service Readiness
Return whether the Celerp service is ready to handle application requests.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested service readiness result. | object |
Example
curl -X GET http://localhost:8000/health/ready \
-H "Authorization: Bearer $TOKEN"GET /health/system
Get System Health
Return a system health summary for the Celerp installation.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested system health result. | object |
Example
curl -X GET http://localhost:8000/health/system \
-H "Authorization: Bearer $TOKEN"GET /system/installation-owner
Check Installation Owner
Return whether the signed-in login is the installation owner, so a client can offer installation-wide controls only to that login.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `installation_owner`, true or false. | object |
Example
curl -X GET http://localhost:8000/system/installation-owner \
-H "Authorization: Bearer $TOKEN"POST /system/restart
Restart Celerp Server
Request a graceful restart of the Celerp server.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `ok: true` and `restarting: true`; the server restarts shortly after. | object |
Example
curl -X POST http://localhost:8000/system/restart \
-H "Authorization: Bearer $TOKEN"GET /system/start-report
Get Start Report
Return why the last start held the stored records back, as each failed update step with its error. `held_back` is null when the records are current. It needs the permission to manage company settings.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `held_back`, the report of the failed steps, or null. | object |
Example
curl -X GET http://localhost:8000/system/start-report \
-H "Authorization: Bearer $TOKEN"GET /system/update
Get Update Status
Show the installed version, the newest available version, whether automatic updates are on, and whether an update is installing.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the current and latest versions, when the last check ran, whether this user can install, automatic update setting, and the result of the last update. | object |
Example
curl -X GET http://localhost:8000/system/update \
-H "Authorization: Bearer $TOKEN"POST /system/update
Install Update
Install the newest available version. Celerp restarts and is back in about a minute.
Responses
| Status | Description | Body |
|---|---|---|
202 | Returns `ok: true` and the version being installed. | object |
Example
curl -X POST http://localhost:8000/system/update \
-H "Authorization: Bearer $TOKEN"POST /system/update/check
Check For Update
Check now for a newer version.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the same update status as the GET request, with the fresh check result. | object |
Example
curl -X POST http://localhost:8000/system/update/check \
-H "Authorization: Bearer $TOKEN"PATCH /system/update/settings
Update Auto-Update Setting
Turn automatic overnight updates on or off.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
auto | boolean | yes | Auto |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the saved setting. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X PATCH http://localhost:8000/system/update/settings \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'