احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/ip-allow \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Your organisation's SSH/SFTP allow-list (#1493). While it is EMPTY your sites are reachable from anywhere; adding the first entry is what turns the restriction on. `restricted` says which of those two states you are in, in so many words. A client that inferred it from an empty array would be guessing at the difference between "open to the whole internet" and "locked down", which are opposite facts. `staff_ranges` is a COUNT, not the addresses. Zinn® support and provisioning are unioned into the effective list so a narrow entry of yours cannot lock us out of the site you have just called us about - but our infrastructure's ranges are not published to tenants.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
org_id (query) | string | خیر | The organization to act on. Omitted (or empty) means your own. A reseller managing a client org must name it - defaulting silently would edit the reseller's own list while the s… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
entries | IpAllowEntry[] | بله | — |
restricted | boolean | بله | false = your sites are reachable from any address. An empty list is NOT a deny-all. |
staff_ranges | integer | بله | How many Zinn® support ranges are unioned in. |