API Reference
Basic Usage
Overview of all Cntrl API endpoints.
Cntrl exposes a simple RESTful API. All endpoints are prefixed with /api.
Base URL
By default, the API is available at:
http://<YOUR_PC_IP>:9990
Custom Ports
9990 is the default port. If you changed the port during installation or
in the config.yaml file, make sure to use your custom port here.
Quick Reference
System Info
Static hardware information (CPU, GPU, RAM specs).
Usage Data
Dynamic usage metrics (load, temps, percentages).
Power Control
Shutdown, restart, sleep, and hibernate commands.
Media Control
Control media playback and get now-playing info.
Processes
Top processes by memory usage.
Endpoint Summary
| Method | Endpoint | Description | Status |
|---|---|---|---|
GET | /api/status | Health check | ✅ Stable |
GET | /api/system | Static system info | ✅ Stable |
GET | /api/usage | Dynamic usage data | ✅ Stable |
POST | /api/pw/* | Power commands | ✅ Stable |
GET | /api/media/status | Now playing info | 🧪 Experimental |
POST | /api/media/control | Media controls | 🧪 Experimental |
GET | /api/processes | Top processes | 🧪 Experimental |
GET | /api/stats | Combined stats | ⚠️ Deprecated |
Deprecated Endpoint
/api/stats is deprecated and will be removed in v0.1.
Use /api/system and /api/usage instead.