api-keys

POST `/v1/api-keys`

Create an API key.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د 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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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