Network & Proxy
Base path: /api/v1/network, /api/v1/hal/network
The Network API covers network interfaces, reverse proxy management (Caddy), SSL certificates, Cloudflare DNS integration, and VPN configuration.
Network interfaces
Section titled “Network interfaces”GET /network/interfaces
Lists all network interfaces with IP addresses, status, and type.
GET /network/connectivity
Checks internet connectivity and returns latency information.
Reverse proxy
Section titled “Reverse proxy”The built-in reverse proxy (Caddy) handles routing external traffic to internal services with automatic HTTPS.
List routes
Section titled “List routes”GET /hal/network/proxy/routes
Returns all configured proxy routes.
Response: Array of route objects with domain, target, ssl, enabled fields.
Add route
Section titled “Add route”POST /hal/network/proxy/routes
Body:
| Field | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | External domain (e.g., notes.example.com) |
target | string | Yes | Internal target (e.g., http://localhost:7200) |
ssl | boolean | No | Enable HTTPS with automatic ACME certificate |
Update route
Section titled “Update route”PUT /hal/network/proxy/routes/:id
Delete route
Section titled “Delete route”DELETE /hal/network/proxy/routes/:id
GET /hal/network/ssl/status
Returns SSL certificate status for all configured domains, including issuer, expiry, and auto-renewal status.
GET /hal/network/ssl/ca
Downloads the CA certificate for local trust (useful for self-signed setups).
Cloudflare integration
Section titled “Cloudflare integration”DNS proxy
Section titled “DNS proxy”GET /proxy/cloudflare/config — Current Cloudflare configuration
PUT /proxy/cloudflare/config — Update Cloudflare API token
GET /proxy/cloudflare/dns — List DNS records via Cloudflare
Subdomain requests
Section titled “Subdomain requests”GET /proxy/subdomain — Current subdomain status
POST /proxy/subdomain — Request a *.micelclaw.com subdomain (Pro)
Tailscale VPN
Section titled “Tailscale VPN”| Endpoint | Method | Description |
|---|---|---|
/hal/network/tailscale/status | GET | Tailscale connection status |
/hal/network/tailscale/install | POST | Install Tailscale |
/hal/network/tailscale/login | POST | Authenticate with Tailscale |
/hal/network/tailscale/logout | POST | Disconnect from Tailscale |
/hal/network/tailscale/generate-cert | POST | Generate HTTPS cert for Tailscale hostname |