Skip to content

REST API

Orestis Tsakiridis edited this page Oct 30, 2025 · 6 revisions

homes

Homes endpoint manages home accounts. As a bare minimum, a home consists of a name (compatible with POSIX username syntax) an index and an ssh public key. name and public_key are given by the user. index is determined by the available home slots in the system and is assigned automatically.

New home

POST /api/homes/
{"name":"alice", "public_key":"sshpublickeytext"}

Response
{"index":0, "ssh_username": "home01_alice"}

Update public key

PATCH /api/homes/1
{"public_key":"newpublickey"}

Response 204 NO CONTENT

TBD

GET /api/homes/0

Response
{"index":0, "ssh_username": "home01_alice"}

tunnel mappings

Tunnel mappings represent traffic forwarding from a domain name to a listening end of the tunnel residing inside the cloudserver. A set of subsequent

/api/proxy-mappings/

[TBD]

/api/proxy/instance/

PUT - reload settings
DELETE - stop instance if possible
GET - get one-liner status

Clone this wiki locally