api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Барлық api-keys соңғы нүктелері

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

curl -X GET https://api.zinndigital.com/v1/api-keys/{apiKeyId} \
  -H "Authorization: Bearer zdk_live_…"

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз

Мәліметтер

Returns one non-revoked key's metadata (never the secret). RBAC + RLS scoped.

Параметрлер

АтыTүріМіндеттіМазмұны
apiKeyId (path)UuidИәThe API key's id.

Жауап

АтыTүріМіндеттіМазмұны
idUuidИәUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringИә
prefixstringИәThe key's public lookup id (the middle segment of the token).
scopesstring[]ИәThe RBAC permission keys this key may exercise.
sandboxbooleanИәA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectЖоқWhen the key last authenticated a request; null if never used.
revoked_atobjectЖоқAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringИә

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 404 · 429