security

PATCH `/v1/ip-allow/{entry_id}`

Change an entry.

احراز هویت

یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمی‌کند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک پارامتر پرس‌وجو می‌پذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجاره‌ای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X PATCH https://api.zinndigital.com/v1/ip-allow/{entry_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "cidr": <string>, "label": <string> }'

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Partial update. Disabling an entry (`enabled: false`) is the reversible way to narrow access during an incident - it keeps the range visible so you can see what you turned off, which a deletion does not.

پارامترها

نام	نوع	الزامی	چیست
`entry_id (path)`	`string`	بله	—
`org_id (query)`	`string`	خیر	—

بدنه درخواست

نام	نوع	الزامی	چیست
`cidr`	`string`	بله	An address or a CIDR range. `0.0.0.0/0` and `::/0` are refused, as is anything broader than /8 (IPv4) or /32 (IPv6). Both families are checked - rejecting only the IPv4 literal…
`label`	`string`	بله	—
`expires_at`	`string`	خیر	—
`enabled`	`boolean`	خیر	—

پاسخ

نام	نوع	الزامی	چیست
`id`	`string`	بله	—
`scope`	`string<staff_infra, staff_site, customer_site>`	بله	—
`cidr`	`string`	بله	Canonical CIDR. A bare address is stored as a host network (`/32`, or `/128` for IPv6) so one column answers both "is this a range" and "does it contain X".
`label`	`string`	بله	Required. An unlabelled range is one nobody dares remove, which is how a list grows until it stops being a control.
`expires_at`	`string`	خیر	null = permanent. An expired entry is NOT deleted - it stays visible and greyed so an operator can see what lapsed and re-add it.
`enabled`	`boolean`	بله	—
`expired`	`boolean`	بله	Computed server-side. Two surfaces deriving "is this still in force?" from a raw timestamp is two implementations of one decision, and they disagree on the boundary second.
`in_force`	`boolean`	بله	enabled AND not expired - the only field that decides anything.
`created_by`	`string`	بله	Audit ref of whoever added it (`user:<id>` / `apikey:<id>`).
`created_at`	`string`	بله	—

PATCH /v1/ip-allow/{entry_id}