Skip to content

Networks

A network is your space: your devices, your hosts, your index and your members. Most people have one.

POST /v1/networks
{ "name": "Home" }
{ "id": "n7q2k3m4p5r6s7t8", "name": "Home", "role": "owner", "plan": "free" }

Browser session only. The network starts with its cloud node and its pad, ready to use.

GET /v1/networks/{id}
{ "id": "n7q2k3m4p5r6s7t8", "name": "Home", "plan": "free",
"limits": { "items": 25000, "padBytes": 1073741824 },
"usage": { "items": 1240, "padBytes": 20480 }, "state": "ok",
"members": [ { "account": "acct_…", "role": "owner" } ],
"nodes": [ … ] }

state is ok, near (from 90% of the item limit) or over. See plans and billing for what happens over the limit.

GET /v1/status
{ "network": "n7q2k3m4p5r6s7t8", "plan": "free", "state": "ok", "items": 1240,
"nodes": [ { "id": "…", "online": true, "lastSeen": "…" } ],
"hosts": [ { "id": "h1a2b3c4d5e6", "state": "online", "queued": 0, "head": { "items": 1200 } } ] }

The one call for the shape of a network: which devices are on, which hosts are up to date (queued is how many changes are still on their way), and how full the network is. Any token may call it.

GET /v1/billing
{ "enabled": true, "plan": "free", "limits": { … }, "usage": { … }, "state": "ok", "subscription": null }

Upgrades and the billing portal are done from the network page in the app, by the owner.

A network can have several members. A member sees the hosts that are not private and their own, and connects devices and agents of their own. Inviting a member is not yet available; today a network has its owner.