System API
Inspect health, status, and instance metadata.
Generated from the Celerp 2.4.0 OpenAPI schema, 16 September 2026.
GET /health
Health
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
Example
curl -X GET http://localhost:8000/health \
-H "Authorization: Bearer $TOKEN"GET /health/ready
Readiness
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
Example
curl -X GET http://localhost:8000/health/ready \
-H "Authorization: Bearer $TOKEN"GET /health/system
System Health
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
Example
curl -X GET http://localhost:8000/health/system \
-H "Authorization: Bearer $TOKEN"POST /system/factory-reset
Factory Reset
Wipe all company data and return the system to a fresh-install state.
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
Example
curl -X POST http://localhost:8000/system/factory-reset \
-H "Authorization: Bearer $TOKEN"POST /system/restart
Restart Server
Gracefully restart the server process (SIGTERM → process manager respawns). Used by the setup wizard after applying a preset so new modules are loaded. Returns immediately; the restart happens ~200ms later in a background task.
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
Example
curl -X POST http://localhost:8000/system/restart \
-H "Authorization: Bearer $TOKEN"