api-keys

POST `/v1/api-keys`

Create an API key.

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس apikeys.manage اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

جہاں آپ کی تنظیم کی آئی ڈی آتی ہے

یہ اینڈ پوائنٹ JSON باڈی میں ایک فیلڈ کے طور پر org_id لیتا ہے۔

آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X POST https://api.zinndigital.com/v1/api-keys \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

Mints a new per-org API key and returns the full `zdk_…` token **once** — only its hash is stored, so a lost token is replaced, never recovered. The requested `scopes` must be permissions the caller already holds in the target org; asking for one you do not hold is a `403` (a key can never out-scope its creator). Send an `Idempotency-Key` so a retry after a lost response returns the same token rather than orphaning a key. Requires `apikeys.manage`.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`Idempotency-Key (header)`	`string`	نہیں	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

درخواست کا باڈی

نام	قسم	لازمی	یہ کیا ہے
`name`	`string`	ہاں	—
`scopes`	`string[]`	نہیں	RBAC permission keys to grant. Each must be a permission the caller holds in the target org (a key can never out-scope its creator); an unheld scope is a `403`, an unknown one a…
`sandbox`	`boolean`	نہیں	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	نہیں	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

جواب

نام	قسم	لازمی	یہ کیا ہے
`id`	`Uuid`	ہاں	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	ہاں	—
`prefix`	`string`	ہاں	The key's public lookup id (the middle segment of the token).
`scopes`	`string[]`	ہاں	The RBAC permission keys this key may exercise.
`sandbox`	`boolean`	ہاں	A sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
`last_used_at`	`object`	نہیں	When the key last authenticated a request; null if never used.
`revoked_at`	`object`	نہیں	Always null on a listed/fetched key — revoked keys are not returned.
`created_at`	`string`	ہاں	—
`token`	`string`	ہاں	The full `zdk_<mode>_<prefix>_<secret>` token. Shown once, here only — store it now; it cannot be retrieved again, only replaced.

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 409 · 422 · 429