Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/private-network \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
org_id (query) | string | Nee | 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… |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | string | Ja | — |
region | string | Ja | Machine code for the gateway's region, e.g. `eu-nbg1`. |
region_label | string | Ja | What the customer sees, e.g. `Germany (Nuremberg)`. |
egress_ip | string | Ja | 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> | Ja | `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 | Ja | Devices currently enrolled and not revoked. |
can_add_device | boolean | Ja | 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[] | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404