api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Wszystkie punkty końcowe api-keys

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

NazwaTypWymaganeCo to jest
apiKeyId (path)UuidTakThe API key's id.

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringTak
prefixstringTakThe key's public lookup id (the middle segment of the token).
scopesstring[]TakThe RBAC permission keys this key may exercise.
sandboxbooleanTakA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectNieWhen the key last authenticated a request; null if never used.
revoked_atobjectNieAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringTak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429