security

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

Change an entry.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.

حيث يتم إدخال معرف مؤسستك

تأخذ نقطة النهاية هذه 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

التفاصيل

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}