hosting
GET /v1/private-network
The organisation's private access network.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Unde merge ID-ul organizației tale
Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/private-network \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
org_id (query) | string | Nu | 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 c… |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | string | Da | — |
region | string | Da | Machine code for the gateway's region, e.g. `eu-nbg1`. |
region_label | string | Da | What the customer sees, e.g. `Germany (Nuremberg)`. |
egress_ip | string | Da | 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 wo… |
status | string<active, suspended, closed> | Da | `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 r… |
seats_used | integer | Da | Devices currently enrolled and not revoked. |
can_add_device | boolean | Da | 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[] | Da | — |
Erori pe care le poate returna acest punct final
401 · 403 · 404