API — License, access & certificate

Check license status, manage authentication, read overall system status, and download the root certificate over the API.

License

GET /api/v1/license/status Auth required

Returns whether the license is active, along with your plan and port limit.

Example (curl)

curl -H "X-API-Key: YOUR_API_KEY" http://127.0.0.1:8891/api/v1/license/status

POST /api/v1/auth/login No auth

Signs in with the dashboard password and sets a session cookie.

Request body

{ "password": "your-dashboard-password" }

POST /api/v1/auth/logout Auth required

Clears the session cookie.

GET /api/v1/auth/status Auth required

Reports the current sign-in and password state.

POST /api/v1/auth/password Auth required

Changes the dashboard password (requires the current one).

Request body

{ "current": "old-password", "new": "new-password" }

POST /api/v1/auth/apikey/rotate Auth required

Generates a new API key and returns it. The previous key stops working immediately.

Response

{ "api_key": "a1b2c3d4..." }

GET /api/v1/status Auth required

Returns overall status: version, open and maximum ports, identity counts, uptime and more.

Example (curl)

curl -H "X-API-Key: YOUR_API_KEY" http://127.0.0.1:8891/api/v1/status

GET /api/v1/health No auth

A simple health check that always returns OK.

GET /api/v1/ca Auth required

Downloads the root certificate as PEM text.

GET /api/v1/ca.crt Auth required

Downloads the certificate in DER form (for native install on macOS/iOS).

GET /api/v1/ca.mobileconfig Auth required

Downloads an Apple .mobileconfig profile that installs the certificate.