# API docs endpoints (System (public))

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

Source: https://featherpanel.com/docs/api/reference/system/apidocs/

Defined in [`backend/app/routes/system/apidocs.php`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/system/apidocs.php). Authentication used here: **Public**. Read [Authentication](https://featherpanel.com/docs/api/authentication/) for how to send credentials and [Rate limits and errors](https://featherpanel.com/docs/api/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: Public
- Route name: `apidocs`
- Controller: [`ApiDocs::index`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/System/ApiDocs.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/system/apidocs.php#L24)

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

```bash
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