hosting
GET /v1/private-network
The organisation's private access network.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/private-network \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The org's dedicated egress address, the region it lives in, and every device enrolled on it. Gated on sites.view. ⛔ This is not a browsing VPN. A device reaches the customer's own estate and nothing else — the issued configuration carries no default route — so no third-party traffic ever leaves a Zinn® address. The product exists so a team can add ONE stable address to their SSH/SFTP allow-lists (/v1/ip-allow) instead of chasing changing home and mobile addresses. 404 when the organisation has not bought the product. Deliberately not an empty network: a shell would make the screen look like something they own that does nothing.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | Narrow to one organisation in the caller's subtree — what the dashboard's org switcher sends, and what X-Zinn-Org stands in for. ⛔ Narrow only: intersected with what the… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
region | string | Yes | Machine code for the gateway's region, e.g. eu-nbg1. |
region_label | string | Yes | What the customer sees, e.g. Germany (Nuremberg). |
egress_ip | string | Yes | The dedicated address every device on this network connects out from — the one to add to SSH/SFTP allow-lists. It belongs to this organisation alone; a shared gateway address… |
status | string<active, suspended, closed> | Yes | suspended means the organisation is not currently in good standing, so devices are withheld from the gateway. ⛔ Nothing is deleted — devices resume on their own when payment… |
seats_used | integer | Yes | Devices currently enrolled and not revoked. |
can_add_device | boolean | Yes | Whether another device may be enrolled right now. False when the allowance is spent, the address has not landed, or the organisation is not in good standing. The screen renders… |
items | PrivateNetworkDevice[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404