Skip to content

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.

GET /network/interfaces

Lists all network interfaces with IP addresses, status, and type.

GET /network/connectivity

Checks internet connectivity and returns latency information.

The built-in reverse proxy (Caddy) handles routing external traffic to internal services with automatic HTTPS.

GET /hal/network/proxy/routes

Returns all configured proxy routes.

Response: Array of route objects with domain, target, ssl, enabled fields.

POST /hal/network/proxy/routes

Body:

FieldTypeRequiredDescription
domainstringYesExternal domain (e.g., notes.example.com)
targetstringYesInternal target (e.g., http://localhost:7200)
sslbooleanNoEnable HTTPS with automatic ACME certificate

PUT /hal/network/proxy/routes/:id

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).

GET /proxy/cloudflare/config — Current Cloudflare configuration

PUT /proxy/cloudflare/config — Update Cloudflare API token

GET /proxy/cloudflare/dns — List DNS records via Cloudflare

GET /proxy/subdomain — Current subdomain status

POST /proxy/subdomain — Request a *.micelclaw.com subdomain (Pro)

EndpointMethodDescription
/hal/network/tailscale/statusGETTailscale connection status
/hal/network/tailscale/installPOSTInstall Tailscale
/hal/network/tailscale/loginPOSTAuthenticate with Tailscale
/hal/network/tailscale/logoutPOSTDisconnect from Tailscale
/hal/network/tailscale/generate-certPOSTGenerate HTTPS cert for Tailscale hostname