REST API

Admin API

Administrative diagnostics and system status endpoints for maintaining a Celerp ERP installation.

Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.

POST /admin/doctor

Run System Diagnostics

Run selected Celerp system diagnostic checks and return a report. Set the documented repair options to apply supported fixes instead of running diagnostics only.

Parameters

NameInRequiredTypeDescription
fixquery--booleanWhether to apply supported repairs instead of returning a diagnostic report only.
checksquery--string, optionalComma-separated diagnostic check names to run; omit to run all available checks.
rebuildquery--booleanWhether to rebuild derived application data after supported repairs.
from_versionquery--string, optionalPrevious Celerp version string used when generating an upgrade diagnostic report.

Responses

StatusDescriptionBody
200Returns the result of each check and, when repairs were requested, what was fixed.object
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X POST http://localhost:8000/admin/doctor \
  -H "Authorization: Bearer $TOKEN"

GET /admin/relay/status

Get Connect Service Status

Return the current availability and connection state of Celerp Connect for administrative status displays.

Responses

StatusDescriptionBody
200Returns the requested connect service status result.object

Example

curl -X GET http://localhost:8000/admin/relay/status \
  -H "Authorization: Bearer $TOKEN"