প্রমাণীকরণ
একটি বিয়ার টোকেন হিসেবে একটি এপিআই কি পাঠান। এই এন্ডপয়েন্টটি স্পেসিফিকেশনে কোনো নির্দিষ্ট অনুমতির কথা বলে না, তাই অনুমান না করে আপনার কি-কে এর জন্য ন্যূনতম প্রয়োজনীয় অনুমতি দিন এবং রেসপন্স পরীক্ষা করুন।
যেখানে আপনার অর্গানাইজেশন আইডি দেওয়া হবে
এই এন্ডপয়েন্টটি org_id-কে একটি কুয়েরি প্যারামিটার হিসেবে গ্রহণ করে। এটি বাদ দিলে কলটি আপনার পুরো টেনেন্সি সাবট্রিকে কভার করে; এটিকে পাঠালে কলটি একটি সংস্থায় সীমাবদ্ধ হয়।
আপনার ড্যাশবোর্ডের API কি স্ক্রিনে, কি-এর ঠিক পাশেই আপনার অর্গানাইজেশন আইডি রয়েছে। আপনি যে কলই করুন না কেন, সবগুলিতেই এই আইডি একই থাকে।
চেষ্টা করুন
কোণ বন্ধনীতে থাকা যেকোনো কিছু আপনার নিজস্ব মান দিয়ে এবং কী প্লেসহোল্ডারটি আপনার ড্যাশবোর্ডের একটি কী দিয়ে প্রতিস্থাপন করুন।
curl -X GET https://api.zinndigital.com/v1/private-network \
-H "Authorization: Bearer zdk_live_…"লগ ইন করা আছে? আপনার ড্যাশবোর্ডের এপিআই কনসোল আপনার আসল অর্গানাইজেশন আইডি এবং আপনার নিজের কি পূরণ করে দেয়, এবং লাইভ এপিআই-এর বিপরীতে অনুরোধটি চালায় যাতে আপনি প্রকৃত প্রতিক্রিয়া দেখতে পান। এই এন্ডপয়েন্টটি এপিআই কনসোলে খুলুন
বিবরণ
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.
পরামিতি
| নাম | ধরন | আবশ্যক | এটি কী |
|---|---|---|---|
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… |
প্রতিক্রিয়া
| নাম | ধরন | আবশ্যক | এটি কী |
|---|---|---|---|
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