hosting
GET /v1/private-network
The organisation's private access network.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/private-network \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id (query) | string | Nem | 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… |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | string | Igen | — |
region | string | Igen | Machine code for the gateway's region, e.g. eu-nbg1. |
region_label | string | Igen | What the customer sees, e.g. Germany (Nuremberg). |
egress_ip | string | Igen | 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> | Igen | 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 | Igen | Devices currently enrolled and not revoked. |
can_add_device | boolean | Igen | 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[] | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404