hosting
GET /v1/private-network
The organisation's private access network.
Πισtoποίηση
Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Αυτό το τελικό σημείο δεν ορίζει μια συγκεκριμένη άδεια στην προδιαγραφή, οπότε δώστε στο κλειδί σας τα ελάχιστα δυνατά δικαιώματα και ελέγξτε την απόκριση αντί να κάνετε υποθέσεις.
Πού μπαίνει το αναγνωριστικό του οργανισμού σας
Αυτό το τελικό σημείο δέχεται την παράμετρο org_id ως παράμετρο ερωτήματος. Παραλείψτε την και η κλήση καλύπτει ολόκληρο το υποδέντρο μίσθωσής σας· στείλτε την για να περιορίσετε την κλήση σε έναν οργανισμό.
Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.
Δοκιμάστε το
Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.
curl -X GET https://api.zinndigital.com/v1/private-network \
-H "Authorization: Bearer zdk_live_…"Συνδεθήκατε; Η κονσόλα API στον πίνακα ελέγχου σας συμπληρώνει το πραγματικό αναγνωριστικό του οργανισμού σας και το δικό σας κλειδί, και εκτελεί το αίτημα στο ζωντανό API, ώστε να μπορείτε να δείτε την πραγματική απόκριση. Ανοίξτε αυτό το τελικό σημείο στην κονσόλα API
Λεπτομέρειες
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.
Παράμετροι
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
org_id (query) | string | Όχι | 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… |
Απάντηση
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
id | string | Ναι | — |
region | string | Ναι | Machine code for the gateway's region, e.g. `eu-nbg1`. |
region_label | string | Ναι | What the customer sees, e.g. `Germany (Nuremberg)`. |
egress_ip | string | Ναι | 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> | Ναι | `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 | Ναι | Devices currently enrolled and not revoked. |
can_add_device | boolean | Ναι | 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[] | Ναι | — |
Σφάλματα που μπορεί να επιστρέψει αυτό το τελικό σημείο
401 · 403 · 404