View .md

API docs endpoints (System (public))

1 FeatherPanel System (public) endpoint from system/apidocs.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/apidocs.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/openapi.json

Auth: PublicRoute name: apidocsController: ApiDocs::indexroute source

Get OpenAPI specification Retrieve the complete OpenAPI 3.1 specification for the FeatherPanel API, including all documented endpoints, schemas, and metadata.

curl -X GET "$PANEL_URL/api/openapi.json" \
  -H "Accept: application/json"

Responses: 200 OpenAPI specification retrieved successfully · 500 Internal server error - Failed to generate OpenAPI specification