panel/API.md
Jakub Dorfman ce60fc8f5c Enhance panel-api with compose functionality and update podman integration
Co-authored-by: Copilot <copilot@github.com>
2026-04-26 19:48:35 +02:00

50 lines
750 B
Markdown

# panel-api
A tiny local HTTP API wrapper around panelctl for future frontend integration.
The service now also serves a lightweight web UI at `/`.
Default bind:
- 127.0.0.1:9911
## Endpoints
- GET /health
- GET /
- GET /apps
- GET /apps/<name>
- GET /apps/<name>/compose
- POST /apps/init
- POST /apps/<name>/compose
- POST /apps/<name>/render-route
- POST /apps/<name>/deploy
- POST /apps/<name>/stop
- POST /apps/<name>/remove
## Example payloads
Create app:
```json
{
"name": "whoami",
"domain": "whoami.srazka.com",
"port": 18080,
"auth": true
}
```
Remove and keep volumes:
```json
{
"keepVolumes": true
}
```
## Local test
```bash
curl -s http://127.0.0.1:9911/health | jq .
curl -s http://127.0.0.1:9911/apps | jq .
```