View .md

Self-test endpoints (System (public))

1 FeatherPanel System (public) endpoint from system/selftest.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

Defined in backend/app/routes/system/selftest.php. Authentication used here: Public. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

Endpoints

GET/api/selftest

Auth: PublicRoute name: system-selftestController: SelfTest::getSelfTestroute source

Selftest Runs a selftest to check if the system is working correctly. Response is cached for 1 hour.

Response data: SelftestResponse

Response data fieldTypeDescription
statusstringOverall system status
checksobjectIndividual check results
timestampintegerThis check timestamp
cachedbooleanIf the response is cached
curl -X GET "$PANEL_URL/api/selftest" \
  -H "Accept: application/json"

Responses: 200 Selftest information retrieved successfully