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 کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو 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}